CosmosDBFleetspaceCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}
  • Operation Id: Fleetspace_Get
  • Default Api Version: 2025-10-15
  • Resource: CosmosDBFleetspaceResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBFleetspaceResource>> GetIfExistsAsync(string fleetspaceName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBFleetspaceResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.CosmosDBFleetspaceResource>>
Public Overridable Function GetIfExistsAsync (fleetspaceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of CosmosDBFleetspaceResource))

Parameters

fleetspaceName
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

fleetspaceName is null.

Applies to