CosmosDBAccountResource.GetCosmosDBPrivateEndpointConnectionAsync Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountResource.cs

Gets a private endpoint connection.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
• Operation Id: PrivateEndpointConnections_Get
• Default Api Version: 2024-09-01-preview
• Resource: CosmosDBPrivateEndpointConnectionResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBPrivateEndpointConnectionResource>> GetCosmosDBPrivateEndpointConnectionAsync (string privateEndpointConnectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCosmosDBPrivateEndpointConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBPrivateEndpointConnectionResource>>
override this.GetCosmosDBPrivateEndpointConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBPrivateEndpointConnectionResource>>

Public Overridable Function GetCosmosDBPrivateEndpointConnectionAsync (privateEndpointConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBPrivateEndpointConnectionResource))

Parameters

privateEndpointConnectionName

String

The name of the private endpoint connection.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBPrivateEndpointConnectionResource>>

Exceptions

ArgumentNullException

privateEndpointConnectionName is null.

ArgumentException

privateEndpointConnectionName is an empty string, and was expected to be non-empty.