Fleet interface
Interface representing a Fleet.
Methods
| begin |
Deletes an existing Azure Cosmos DB Fleet. |
| begin |
Deletes an existing Azure Cosmos DB Fleet. |
| create(string, string, Fleet |
Creates an Azure Cosmos DB fleet under a subscription. |
| get(string, string, Fleet |
Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription |
| list(Fleet |
Lists all the fleets under the subscription. |
| list |
Lists all the fleets under the specified subscription and resource group. |
| update(string, string, Fleet |
Updates the properties of an existing Azure Cosmos DB Fleet. |
Method Details
beginDelete(string, string, FleetDeleteOptionalParams)
Deletes an existing Azure Cosmos DB Fleet.
function beginDelete(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams): Promise<SimplePollerLike<OperationState<FleetDeleteHeaders>, FleetDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- fleetName
-
string
Cosmos DB fleet name. Needs to be unique under a subscription.
- options
- FleetDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetDeleteHeaders>, FleetDeleteHeaders>>
beginDeleteAndWait(string, string, FleetDeleteOptionalParams)
Deletes an existing Azure Cosmos DB Fleet.
function beginDeleteAndWait(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams): Promise<FleetDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- fleetName
-
string
Cosmos DB fleet name. Needs to be unique under a subscription.
- options
- FleetDeleteOptionalParams
The options parameters.
Returns
Promise<FleetDeleteHeaders>
create(string, string, FleetResource, FleetCreateOptionalParams)
Creates an Azure Cosmos DB fleet under a subscription.
function create(resourceGroupName: string, fleetName: string, body: FleetResource, options?: FleetCreateOptionalParams): Promise<FleetResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- fleetName
-
string
Cosmos DB fleet name. Needs to be unique under a subscription.
- body
- FleetResource
The parameters to provide for the current fleet.
- options
- FleetCreateOptionalParams
The options parameters.
Returns
Promise<FleetResource>
get(string, string, FleetGetOptionalParams)
Retrieves the properties of an existing Azure Cosmos DB fleet under a subscription
function get(resourceGroupName: string, fleetName: string, options?: FleetGetOptionalParams): Promise<FleetResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- fleetName
-
string
Cosmos DB fleet name. Needs to be unique under a subscription.
- options
- FleetGetOptionalParams
The options parameters.
Returns
Promise<FleetResource>
list(FleetListOptionalParams)
Lists all the fleets under the subscription.
function list(options?: FleetListOptionalParams): PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>Parameters
- options
- FleetListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, FleetListByResourceGroupOptionalParams)
Lists all the fleets under the specified subscription and resource group.
function listByResourceGroup(resourceGroupName: string, options?: FleetListByResourceGroupOptionalParams): PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
update(string, string, FleetUpdateOptionalParams)
Updates the properties of an existing Azure Cosmos DB Fleet.
function update(resourceGroupName: string, fleetName: string, options?: FleetUpdateOptionalParams): Promise<FleetResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- fleetName
-
string
Cosmos DB fleet name. Needs to be unique under a subscription.
- options
- FleetUpdateOptionalParams
The options parameters.
Returns
Promise<FleetResource>