Fleet interface

Paket:

@azure/arm-cosmosdb

Schnittstelle stellt eine Flotte dar.

Methoden

beginDelete(string, string, FleetDeleteOptionalParams)	Löscht eine vorhandene Azure Cosmos DB-Flotte.
beginDeleteAndWait(string, string, FleetDeleteOptionalParams)	Löscht eine vorhandene Azure Cosmos DB-Flotte.
create(string, string, FleetResource, FleetCreateOptionalParams)	Erstellt eine Azure Cosmos DB-Flotte unter einem Abonnement.
get(string, string, FleetGetOptionalParams)	Ruft die Eigenschaften einer vorhandenen Azure Cosmos DB-Flotte unter einem Abonnement ab.
list(FleetListOptionalParams)	Listet alle Flotten im Rahmen des Abonnements auf.
listByResourceGroup(string, FleetListByResourceGroupOptionalParams)	Listet alle Flotten unter dem angegebenen Abonnement und der angegebenen Ressourcengruppe auf.
update(string, string, FleetUpdateOptionalParams)	Aktualisiert die Eigenschaften einer vorhandenen Azure Cosmos DB-Flotte.

Details zur Methode

beginDelete(string, string, FleetDeleteOptionalParams)

Löscht eine vorhandene Azure Cosmos DB-Flotte.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

fleetName

string

Name der Cosmos DB-Flotte. Muss im Rahmen eines Abonnements eindeutig sein.

options

FleetDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, FleetDeleteOptionalParams)

Löscht eine vorhandene Azure Cosmos DB-Flotte.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

fleetName

string

Name der Cosmos DB-Flotte. Muss im Rahmen eines Abonnements eindeutig sein.

options

FleetDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<FleetDeleteHeaders>

create(string, string, FleetResource, FleetCreateOptionalParams)

Erstellt eine Azure Cosmos DB-Flotte unter einem Abonnement.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

fleetName

string

Name der Cosmos DB-Flotte. Muss im Rahmen eines Abonnements eindeutig sein.

body

FleetResource

Die Parameter zur Bereitstellung der aktuellen Flotte.

options

FleetCreateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<FleetResource>

get(string, string, FleetGetOptionalParams)

Ruft die Eigenschaften einer vorhandenen Azure Cosmos DB-Flotte unter einem Abonnement ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

fleetName

string

Name der Cosmos DB-Flotte. Muss im Rahmen eines Abonnements eindeutig sein.

options

FleetGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<FleetResource>

list(FleetListOptionalParams)

Listet alle Flotten im Rahmen des Abonnements auf.

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

Parameter

options

FleetListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

listByResourceGroup(string, FleetListByResourceGroupOptionalParams)

Listet alle Flotten unter dem angegebenen Abonnement und der angegebenen Ressourcengruppe auf.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

FleetListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>

update(string, string, FleetUpdateOptionalParams)

Aktualisiert die Eigenschaften einer vorhandenen Azure Cosmos DB-Flotte.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

fleetName

string

Name der Cosmos DB-Flotte. Muss im Rahmen eines Abonnements eindeutig sein.

options

FleetUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<FleetResource>