Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. getVirtualEndpoint
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.dbforpostgresql.getVirtualEndpoint

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets information about a virtual endpoint.

Uses Azure REST API version 2024-08-01.

Other available API versions: 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dbforpostgresql [ApiVersion]. See the version guide for details.

Using getVirtualEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualEndpoint(args: GetVirtualEndpointArgs, opts?: InvokeOptions): Promise<GetVirtualEndpointResult>
function getVirtualEndpointOutput(args: GetVirtualEndpointOutputArgs, opts?: InvokeOptions): Output<GetVirtualEndpointResult>
Copy
def get_virtual_endpoint(resource_group_name: Optional[str] = None,
                         server_name: Optional[str] = None,
                         virtual_endpoint_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVirtualEndpointResult
def get_virtual_endpoint_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                         server_name: Optional[pulumi.Input[str]] = None,
                         virtual_endpoint_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetVirtualEndpointResult]
Copy
func LookupVirtualEndpoint(ctx *Context, args *LookupVirtualEndpointArgs, opts ...InvokeOption) (*LookupVirtualEndpointResult, error)
func LookupVirtualEndpointOutput(ctx *Context, args *LookupVirtualEndpointOutputArgs, opts ...InvokeOption) LookupVirtualEndpointResultOutput
Copy

> Note: This function is named LookupVirtualEndpoint in the Go SDK.

public static class GetVirtualEndpoint 
{
    public static Task<GetVirtualEndpointResult> InvokeAsync(GetVirtualEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualEndpointResult> Invoke(GetVirtualEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualEndpointResult> getVirtualEndpoint(GetVirtualEndpointArgs args, InvokeOptions options)
public static Output<GetVirtualEndpointResult> getVirtualEndpoint(GetVirtualEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:dbforpostgresql:getVirtualEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
VirtualEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual endpoint.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
VirtualEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
virtualEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
virtualEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual endpoint.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
virtual_endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
virtualEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual endpoint.

getVirtualEndpoint Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
SystemData Pulumi.AzureNative.DBforPostgreSQL.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualEndpoints List<string>
List of virtual endpoints for a server
EndpointType string
The endpoint type for the virtual endpoint.
Members List<string>
List of members for a virtual endpoint
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
VirtualEndpoints []string
List of virtual endpoints for a server
EndpointType string
The endpoint type for the virtual endpoint.
Members []string
List of members for a virtual endpoint
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualEndpoints List<String>
List of virtual endpoints for a server
endpointType String
The endpoint type for the virtual endpoint.
members List<String>
List of members for a virtual endpoint
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualEndpoints string[]
List of virtual endpoints for a server
endpointType string
The endpoint type for the virtual endpoint.
members string[]
List of members for a virtual endpoint
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtual_endpoints Sequence[str]
List of virtual endpoints for a server
endpoint_type str
The endpoint type for the virtual endpoint.
members Sequence[str]
List of members for a virtual endpoint
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualEndpoints List<String>
List of virtual endpoints for a server
endpointType String
The endpoint type for the virtual endpoint.
members List<String>
List of members for a virtual endpoint

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native