MockableCosmosDBResourceGroupResource.GetCosmosDBFleetAsync Method

Definition

Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}.
  • Operation Id. : FleetResources_Get.
  • Default Api Version. : 2026-03-15.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBFleetResource>> GetCosmosDBFleetAsync(string fleetName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBFleetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBFleetResource>>
override this.GetCosmosDBFleetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.CosmosDBFleetResource>>
Public Overridable Function GetCosmosDBFleetAsync (fleetName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBFleetResource))

Parameters

fleetName
String

Cosmos DB fleet name. Needs to be unique under a subscription.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

fleetName is null.

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

Applies to