Fleet interface

Pacote:

@azure/arm-cosmosdb

Interface representando uma frota.

Métodos

beginDelete(string, string, FleetDeleteOptionalParams)	Exclui uma Frota existente do Azure Cosmos DB.
beginDeleteAndWait(string, string, FleetDeleteOptionalParams)	Exclui uma Frota existente do Azure Cosmos DB.
create(string, string, FleetResource, FleetCreateOptionalParams)	Cria uma frota do Azure Cosmos DB em uma assinatura.
get(string, string, FleetGetOptionalParams)	Recupera as propriedades de uma frota existente do Azure Cosmos DB em uma assinatura
list(FleetListOptionalParams)	Lista todas as frotas sob a assinatura.
listByResourceGroup(string, FleetListByResourceGroupOptionalParams)	Lista todas as frotas na assinatura e no grupo de recursos especificados.
update(string, string, FleetUpdateOptionalParams)	Atualiza as propriedades de uma Frota existente do Azure Cosmos DB.

Detalhes do método

beginDelete(string, string, FleetDeleteOptionalParams)

Exclui uma Frota existente do Azure Cosmos DB.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

fleetName

string

Nome da frota do Cosmos DB. Precisa ser exclusivo em uma assinatura.

options

FleetDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, string, FleetDeleteOptionalParams)

Exclui uma Frota existente do Azure Cosmos DB.

function beginDeleteAndWait(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams): Promise<FleetDeleteHeaders>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

fleetName

string

Nome da frota do Cosmos DB. Precisa ser exclusivo em uma assinatura.

options

FleetDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<FleetDeleteHeaders>

create(string, string, FleetResource, FleetCreateOptionalParams)

Cria uma frota do Azure Cosmos DB em uma assinatura.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

fleetName

string

Nome da frota do Cosmos DB. Precisa ser exclusivo em uma assinatura.

body

FleetResource

Os parâmetros para prover a frota atual.

options

FleetCreateOptionalParams

Os parâmetros de opções.

Retornos

Promise<FleetResource>

get(string, string, FleetGetOptionalParams)

Recupera as propriedades de uma frota existente do Azure Cosmos DB em uma assinatura

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

fleetName

string

Nome da frota do Cosmos DB. Precisa ser exclusivo em uma assinatura.

options

FleetGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<FleetResource>

list(FleetListOptionalParams)

Lista todas as frotas sob a assinatura.

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

Parâmetros

options

FleetListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

listByResourceGroup(string, FleetListByResourceGroupOptionalParams)

Lista todas as frotas na assinatura e no grupo de recursos especificados.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

options

FleetListByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

update(string, string, FleetUpdateOptionalParams)

Atualiza as propriedades de uma Frota existente do Azure Cosmos DB.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

fleetName

string

Nome da frota do Cosmos DB. Precisa ser exclusivo em uma assinatura.

options

FleetUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<FleetResource>