Azure Native v1.102.0, May 2 23

azure-native.documentdb.getPrivateEndpointConnection

Explore with Pulumi AI

Gets a private endpoint connection. API Version: 2021-03-15.

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(account_name: Optional[str] = None,
                                    private_endpoint_connection_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(account_name: Optional[pulumi.Input[str]] = None,
                                    private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:documentdb:getPrivateEndpointConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: Cosmos DB database account name.
PrivateEndpointConnectionName string: The name of the private endpoint connection.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

AccountName string: Cosmos DB database account name.
PrivateEndpointConnectionName string: The name of the private endpoint connection.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

accountName String: Cosmos DB database account name.
privateEndpointConnectionName String: The name of the private endpoint connection.
resourceGroupName String: The name of the resource group. The name is case insensitive.

accountName string: Cosmos DB database account name.
privateEndpointConnectionName string: The name of the private endpoint connection.
resourceGroupName string: The name of the resource group. The name is case insensitive.

account_name str: Cosmos DB database account name.
private_endpoint_connection_name str: The name of the private endpoint connection.
resource_group_name str: The name of the resource group. The name is case insensitive.

accountName String: Cosmos DB database account name.
privateEndpointConnectionName String: The name of the private endpoint connection.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getPrivateEndpointConnection Result

The following output properties are available:

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
GroupId string: Group id of the private endpoint.
PrivateEndpoint Pulumi.AzureNative.DocumentDB.Outputs.PrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.DocumentDB.Outputs.PrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.
ProvisioningState string: Provisioning state of the private endpoint.

Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
GroupId string: Group id of the private endpoint.
PrivateEndpoint PrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.
ProvisioningState string: Provisioning state of the private endpoint.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupId String: Group id of the private endpoint.
privateEndpoint PrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.
provisioningState String: Provisioning state of the private endpoint.

id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupId string: Group id of the private endpoint.
privateEndpoint PrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.
provisioningState string: Provisioning state of the private endpoint.

id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
group_id str: Group id of the private endpoint.
private_endpoint PrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.
provisioning_state str: Provisioning state of the private endpoint.

id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupId String: Group id of the private endpoint.
privateEndpoint Property Map: Private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map: Connection State of the Private Endpoint Connection.
provisioningState String: Provisioning state of the private endpoint.

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: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string: The private link service connection description.
Status string: The private link service connection status.

ActionsRequired string: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Description string: The private link service connection description.
Status string: The private link service connection status.

actionsRequired String: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String: The private link service connection description.
status String: The private link service connection status.

actionsRequired string: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description string: The private link service connection description.
status string: The private link service connection status.

actions_required str: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description str: The private link service connection description.
status str: The private link service connection status.

actionsRequired String: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
description String: The private link service connection description.
status String: The private link service connection status.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0