Language

CosmosDBFleetCollection.GetIfExists(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

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