FleetspaceAccount interface

Package:

@azure/arm-cosmosdb

Interface representing a FleetspaceAccount.

Methods

beginCreate(string, string, string, string, FleetspaceAccountResource, FleetspaceAccountCreateOptionalParams)	Creates an Azure Cosmos DB fleetspace account under a fleetspace.
beginCreateAndWait(string, string, string, string, FleetspaceAccountResource, FleetspaceAccountCreateOptionalParams)	Creates an Azure Cosmos DB fleetspace account under a fleetspace.
beginDelete(string, string, string, string, FleetspaceAccountDeleteOptionalParams)	Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.
beginDeleteAndWait(string, string, string, string, FleetspaceAccountDeleteOptionalParams)	Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.
get(string, string, string, string, FleetspaceAccountGetOptionalParams)	Retrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace
list(string, string, string, FleetspaceAccountListOptionalParams)	Lists all the fleetspaces accounts under a fleetspace.

Method Details

beginCreate(string, string, string, string, FleetspaceAccountResource, FleetspaceAccountCreateOptionalParams)

Creates an Azure Cosmos DB fleetspace account under a fleetspace.

function beginCreate(resourceGroupName: string, fleetName: string, fleetspaceName: string, fleetspaceAccountName: string, body: FleetspaceAccountResource, options?: FleetspaceAccountCreateOptionalParams): Promise<SimplePollerLike<OperationState<FleetspaceAccountResource>, FleetspaceAccountResource>>

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.

fleetspaceAccountName

string

Cosmos DB fleetspace account name.

body

FleetspaceAccountResource

The parameters to provide for the current fleetspace account.

options

FleetspaceAccountCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetspaceAccountResource>, FleetspaceAccountResource>>

beginCreateAndWait(string, string, string, string, FleetspaceAccountResource, FleetspaceAccountCreateOptionalParams)

Creates an Azure Cosmos DB fleetspace account under a fleetspace.

function beginCreateAndWait(resourceGroupName: string, fleetName: string, fleetspaceName: string, fleetspaceAccountName: string, body: FleetspaceAccountResource, options?: FleetspaceAccountCreateOptionalParams): Promise<FleetspaceAccountResource>

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.

fleetspaceAccountName

string

Cosmos DB fleetspace account name.

body

FleetspaceAccountResource

The parameters to provide for the current fleetspace account.

options

FleetspaceAccountCreateOptionalParams

The options parameters.

Returns

Promise<FleetspaceAccountResource>

beginDelete(string, string, string, string, FleetspaceAccountDeleteOptionalParams)

Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.

function beginDelete(resourceGroupName: string, fleetName: string, fleetspaceName: string, fleetspaceAccountName: string, options?: FleetspaceAccountDeleteOptionalParams): Promise<SimplePollerLike<OperationState<FleetspaceAccountDeleteHeaders>, FleetspaceAccountDeleteHeaders>>

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.

fleetspaceAccountName

string

Cosmos DB fleetspace account name.

options

FleetspaceAccountDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetspaceAccountDeleteHeaders>, FleetspaceAccountDeleteHeaders>>

beginDeleteAndWait(string, string, string, string, FleetspaceAccountDeleteOptionalParams)

Removes an existing Azure Cosmos DB fleetspace account from a fleetspace.

function beginDeleteAndWait(resourceGroupName: string, fleetName: string, fleetspaceName: string, fleetspaceAccountName: string, options?: FleetspaceAccountDeleteOptionalParams): Promise<FleetspaceAccountDeleteHeaders>

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.

fleetspaceAccountName

string

Cosmos DB fleetspace account name.

options

FleetspaceAccountDeleteOptionalParams

The options parameters.

Returns

Promise<FleetspaceAccountDeleteHeaders>

get(string, string, string, string, FleetspaceAccountGetOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace

function get(resourceGroupName: string, fleetName: string, fleetspaceName: string, fleetspaceAccountName: string, options?: FleetspaceAccountGetOptionalParams): Promise<FleetspaceAccountResource>

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.

fleetspaceAccountName

string

Cosmos DB fleetspace account name.

options

FleetspaceAccountGetOptionalParams

The options parameters.

Returns

Promise<FleetspaceAccountResource>

list(string, string, string, FleetspaceAccountListOptionalParams)

Lists all the fleetspaces accounts under a fleetspace.

function list(resourceGroupName: string, fleetName: string, fleetspaceName: string, options?: FleetspaceAccountListOptionalParams): PagedAsyncIterableIterator<FleetspaceAccountResource, FleetspaceAccountResource[], 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.

fleetspaceName

string

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

options

FleetspaceAccountListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FleetspaceAccountResource, FleetspaceAccountResource[], PageSettings>