CosmosDBAccountResource.GetCosmosDBServiceAsync 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.8

Source:: CosmosDBAccountResource.cs

Source:: CosmosDBAccountResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the status of service.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
Operation Id: Service_Get
Default Api Version: 2024-02-15-preview
Resource: CosmosDBServiceResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBServiceResource>> GetCosmosDBServiceAsync (string serviceName, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetCosmosDBServiceAsync (serviceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBServiceResource))

Parameters

serviceName: String

Cosmos DB service name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<CosmosDBServiceResource>>

Exceptions

ArgumentNullException

serviceName is null.

ArgumentException

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

Applies to