CosmosDBExtensions.GetCosmosDBLocationAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.10
Source:
CosmosDBExtensions.cs
Source:
CosmosDBExtensions.cs

Get the properties of an existing Cosmos DB location

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}
  • Operation Id: Locations_Get
  • Default Api Version: 2024-05-15-preview
  • Resource: CosmosDBLocationResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBLocationResource>> GetCosmosDBLocationAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation location, System.Threading.CancellationToken cancellationToken = default);
static member GetCosmosDBLocationAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBLocationResource>>
<Extension()>
Public Function GetCosmosDBLocationAsync (subscriptionResource As SubscriptionResource, location As AzureLocation, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBLocationResource))

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

location
AzureLocation

Cosmos DB region, with spaces between words and each word capitalized.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBLocationResource>>

Exceptions

ArgumentNullException

subscriptionResource is null.

Applies to