These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
azure-native.sql.getPrivateEndpointConnection
Explore with Pulumi AI
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
Gets a private endpoint connection. API Version: 2020-11-01-preview.
Using getPrivateEndpointConnection
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 getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionResult>
function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionResult>def get_private_endpoint_connection(private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    server_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    server_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionResult]func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput> Note: This function is named LookupPrivateEndpointConnection in the Go SDK.
public static class GetPrivateEndpointConnection 
{
    public static Task<GetPrivateEndpointConnectionResult> InvokeAsync(GetPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:sql:getPrivateEndpointConnection
  arguments:
    # arguments dictionaryThe following arguments are supported:
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- ResourceGroup stringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- ServerName string
- The name of the server.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- ResourceGroup stringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- ServerName string
- The name of the server.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection.
- resourceGroup StringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName String
- The name of the server.
- privateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- resourceGroup stringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName string
- The name of the server.
- private_endpoint_ strconnection_ name 
- The name of the private endpoint connection.
- resource_group_ strname 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server_name str
- The name of the server.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection.
- resourceGroup StringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName String
- The name of the server.
getPrivateEndpointConnection Result
The following output properties are available:
- Id string
- Resource ID.
- Name string
- Resource name.
- ProvisioningState string
- State of the private endpoint connection.
- Type string
- Resource type.
- PrivateEndpoint Pulumi.Azure Native. Sql. Outputs. Private Endpoint Property Response 
- Private endpoint which the connection belongs to.
- PrivateLink Pulumi.Service Connection State Azure Native. Sql. Outputs. Private Link Service Connection State Property Response 
- Connection state of the private endpoint connection.
- Id string
- Resource ID.
- Name string
- Resource name.
- ProvisioningState string
- State of the private endpoint connection.
- Type string
- Resource type.
- PrivateEndpoint PrivateEndpoint Property Response 
- Private endpoint which the connection belongs to.
- PrivateLink PrivateService Connection State Link Service Connection State Property Response 
- Connection state of the private endpoint connection.
- id String
- Resource ID.
- name String
- Resource name.
- provisioningState String
- State of the private endpoint connection.
- type String
- Resource type.
- privateEndpoint PrivateEndpoint Property Response 
- Private endpoint which the connection belongs to.
- privateLink PrivateService Connection State Link Service Connection State Property Response 
- Connection state of the private endpoint connection.
- id string
- Resource ID.
- name string
- Resource name.
- provisioningState string
- State of the private endpoint connection.
- type string
- Resource type.
- privateEndpoint PrivateEndpoint Property Response 
- Private endpoint which the connection belongs to.
- privateLink PrivateService Connection State Link Service Connection State Property Response 
- Connection state of the private endpoint connection.
- id str
- Resource ID.
- name str
- Resource name.
- provisioning_state str
- State of the private endpoint connection.
- type str
- Resource type.
- private_endpoint PrivateEndpoint Property Response 
- Private endpoint which the connection belongs to.
- private_link_ Privateservice_ connection_ state Link Service Connection State Property Response 
- Connection state of the private endpoint connection.
- id String
- Resource ID.
- name String
- Resource name.
- provisioningState String
- State of the private endpoint connection.
- type String
- Resource type.
- privateEndpoint Property Map
- Private endpoint which the connection belongs to.
- privateLink Property MapService Connection State 
- Connection state of the private endpoint connection.
Supporting Types
PrivateEndpointPropertyResponse   
- Id string
- Resource id of the private endpoint.
- Id string
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
- id string
- Resource id of the private endpoint.
- id str
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
PrivateLinkServiceConnectionStatePropertyResponse      
- ActionsRequired string
- The actions required for private link service connection.
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- ActionsRequired string
- The actions required for private link service connection.
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- actionsRequired String
- The actions required for private link service connection.
- description String
- The private link service connection description.
- status String
- The private link service connection status.
- actionsRequired string
- The actions required for private link service connection.
- description string
- The private link service connection description.
- status string
- The private link service connection status.
- actions_required str
- The actions required for private link service connection.
- description str
- The private link service connection description.
- status str
- The private link service connection status.
- actionsRequired String
- The actions required for private link service connection.
- description String
- The private link service connection description.
- status String
- The private link service connection status.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi