Partilhar via


CosmosDBServiceCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}
  • Operation Id: Service_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: CosmosDBServiceResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBServiceResource>> GetIfExistsAsync (string serviceName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBServiceResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBServiceResource>>
Public Overridable Function GetIfExistsAsync (serviceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of CosmosDBServiceResource))

Parameters

serviceName
String

Cosmos DB service name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

serviceName is null.

Applies to