FleetOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a Fleet operations.

Properties

beginDelete
beginDeleteAndWait
create	Creates an Azure Cosmos DB fleet under a subscription.
delete
get	Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription
list	Lists all the fleets under the subscription.
listByResourceGroup	Lists all the fleets under the specified subscription and resource group.
update	Updates the properties of an existing Azure Cosmos DB Fleet.

Property Details

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams) => Promise<void>

create

Creates an Azure Cosmos DB fleet under a subscription.

create: (resourceGroupName: string, fleetName: string, body: FleetResource, options?: FleetCreateOptionalParams) => Promise<FleetResource>

Property Value

(resourceGroupName: string, fleetName: string, body: FleetResource, options?: FleetCreateOptionalParams) => Promise<FleetResource>

delete

delete: (resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

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

get: (resourceGroupName: string, fleetName: string, options?: FleetGetOptionalParams) => Promise<FleetResource>

Property Value

(resourceGroupName: string, fleetName: string, options?: FleetGetOptionalParams) => Promise<FleetResource>

list

Lists all the fleets under the subscription.

list: (options?: FleetListOptionalParams) => PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

Property Value

(options?: FleetListOptionalParams) => PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

listByResourceGroup

Lists all the fleets under the specified subscription and resource group.

listByResourceGroup: (resourceGroupName: string, options?: FleetListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

Property Value

(resourceGroupName: string, options?: FleetListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

update

Updates the properties of an existing Azure Cosmos DB Fleet.

update: (resourceGroupName: string, fleetName: string, options?: FleetUpdateOptionalParams) => Promise<FleetResource>

Property Value

(resourceGroupName: string, fleetName: string, options?: FleetUpdateOptionalParams) => Promise<FleetResource>