CosmosDBAccountResource.GetCosmosDBPrivateLinkResourceAsync Method

Definition

Gets the private link resources that need to be created for a Cosmos DB account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBPrivateLinkResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBPrivateLinkResource>> GetCosmosDBPrivateLinkResourceAsync (string groupName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBPrivateLinkResourceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBPrivateLinkResource>>
override this.GetCosmosDBPrivateLinkResourceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBPrivateLinkResource>>
Public Overridable Function GetCosmosDBPrivateLinkResourceAsync (groupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBPrivateLinkResource))

Parameters

groupName
String

The name of the private link resource.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

groupName is null.

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

Applies to