Share via

CosmosDBThroughputPoolAccountCollection.GetIfExistsAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.9
Source:
CosmosDBThroughputPoolAccountCollection.cs

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}
  • Operation Id: ThroughputPoolAccount_Get
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBThroughputPoolAccountResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>> GetIfExistsAsync (string throughputPoolAccountName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolAccountResource>>
Public Overridable Function GetIfExistsAsync (throughputPoolAccountName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of CosmosDBThroughputPoolAccountResource))

Parameters

throughputPoolAccountName
String

Cosmos DB global database account in a Throughput Pool.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<CosmosDBThroughputPoolAccountResource>>

Exceptions

ArgumentException

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

ArgumentNullException

throughputPoolAccountName is null.

Applies to