CosmosDBAccountResource.GetCosmosDBPrivateEndpointConnection 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-02-15-preview
• Resource: CosmosDBPrivateEndpointConnectionResource

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

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

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

Parameters

privateEndpointConnectionName

String

The name of the private endpoint connection.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<CosmosDBPrivateEndpointConnectionResource>

Exceptions

ArgumentNullException

privateEndpointConnectionName is null.

ArgumentException

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