Fleetspace interface
Interface representing a Fleetspace.
Methods
Method Details
beginCreate(string, string, string, FleetspaceResource, FleetspaceCreateOptionalParams)
Creates an Azure Cosmos DB fleetspace under a fleet.
function beginCreate(resourceGroupName: string, fleetName: string, fleetspaceName: string, body: FleetspaceResource, options?: FleetspaceCreateOptionalParams): Promise<SimplePollerLike<OperationState<FleetspaceResource>, FleetspaceResource>>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- body
- FleetspaceResource
The parameters to provide for the current fleetspace.
- options
- FleetspaceCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetspaceResource>, FleetspaceResource>>
beginCreateAndWait(string, string, string, FleetspaceResource, FleetspaceCreateOptionalParams)
Creates an Azure Cosmos DB fleetspace under a fleet.
function beginCreateAndWait(resourceGroupName: string, fleetName: string, fleetspaceName: string, body: FleetspaceResource, options?: FleetspaceCreateOptionalParams): Promise<FleetspaceResource>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- body
- FleetspaceResource
The parameters to provide for the current fleetspace.
- options
- FleetspaceCreateOptionalParams
The options parameters.
Returns
Promise<FleetspaceResource>
beginDelete(string, string, string, FleetspaceDeleteOptionalParams)
Deletes an existing Azure Cosmos DB Fleetspace.
function beginDelete(resourceGroupName: string, fleetName: string, fleetspaceName: string, options?: FleetspaceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<FleetspaceDeleteHeaders>, FleetspaceDeleteHeaders>>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- options
- FleetspaceDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetspaceDeleteHeaders>, FleetspaceDeleteHeaders>>
beginDeleteAndWait(string, string, string, FleetspaceDeleteOptionalParams)
Deletes an existing Azure Cosmos DB Fleetspace.
function beginDeleteAndWait(resourceGroupName: string, fleetName: string, fleetspaceName: string, options?: FleetspaceDeleteOptionalParams): Promise<FleetspaceDeleteHeaders>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- options
- FleetspaceDeleteOptionalParams
The options parameters.
Returns
Promise<FleetspaceDeleteHeaders>
beginUpdate(string, string, string, FleetspaceUpdateOptionalParams)
Update the properties of an existing Azure Cosmos DB fleetspace under a fleet.
function beginUpdate(resourceGroupName: string, fleetName: string, fleetspaceName: string, options?: FleetspaceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FleetspaceResource>, FleetspaceResource>>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- options
- FleetspaceUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetspaceResource>, FleetspaceResource>>
beginUpdateAndWait(string, string, string, FleetspaceUpdateOptionalParams)
Update the properties of an existing Azure Cosmos DB fleetspace under a fleet.
function beginUpdateAndWait(resourceGroupName: string, fleetName: string, fleetspaceName: string, options?: FleetspaceUpdateOptionalParams): Promise<FleetspaceResource>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- options
- FleetspaceUpdateOptionalParams
The options parameters.
Returns
Promise<FleetspaceResource>
get(string, string, string, FleetspaceGetOptionalParams)
Retrieves the properties of an existing Azure Cosmos DB fleetspace under a fleet
function get(resourceGroupName: string, fleetName: string, fleetspaceName: string, options?: FleetspaceGetOptionalParams): Promise<FleetspaceResource>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.
- fleetspaceName
-
string
Cosmos DB fleetspace name. Needs to be unique under a fleet.
- options
- FleetspaceGetOptionalParams
The options parameters.
Returns
Promise<FleetspaceResource>
list(string, string, FleetspaceListOptionalParams)
Lists all the fleetspaces under a fleet.
function list(resourceGroupName: string, fleetName: string, options?: FleetspaceListOptionalParams): PagedAsyncIterableIterator<FleetspaceResource, FleetspaceResource[], PageSettings>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
- FleetspaceListOptionalParams
The options parameters.