ResourceGroups interface

Paket:

@azure/arm-resources

Schnittstelle, die eine ResourceGroups darstellt.

Methoden

beginDelete(string, ResourceGroupsDeleteOptionalParams)	Wenn Sie eine Ressourcengruppe löschen, werden auch alle zugehörigen Ressourcen gelöscht. Durch das Löschen einer Ressourcengruppe werden alle zugehörigen Vorlagenbereitstellungen und aktuell gespeicherten Vorgänge gelöscht.
beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)	Wenn Sie eine Ressourcengruppe löschen, werden auch alle zugehörigen Ressourcen gelöscht. Durch das Löschen einer Ressourcengruppe werden alle zugehörigen Vorlagenbereitstellungen und aktuell gespeicherten Vorgänge gelöscht.
beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Erfasst die angegebene Ressourcengruppe als Vorlage.
beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)	Erfasst die angegebene Ressourcengruppe als Vorlage.
checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)	Überprüft, ob eine Ressourcengruppe vorhanden ist.
createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert eine Ressourcengruppe.
get(string, ResourceGroupsGetOptionalParams)	Ruft eine Ressourcengruppe ab.
list(ResourceGroupsListOptionalParams)	Ruft alle Ressourcengruppen für ein Abonnement ab.
update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)	Ressourcengruppen können über einen einfachen PATCH-Vorgang zu einer Gruppenadresse aktualisiert werden. Das Format der Anforderung entspricht dem Format zum Erstellen einer Ressourcengruppe. Wenn ein Feld nicht angegeben ist, wird der aktuelle Wert beibehalten.

Details zur Methode

beginDelete(string, ResourceGroupsDeleteOptionalParams)

Wenn Sie eine Ressourcengruppe löschen, werden auch alle zugehörigen Ressourcen gelöscht. Durch das Löschen einer Ressourcengruppe werden alle zugehörigen Vorlagenbereitstellungen und aktuell gespeicherten Vorgänge gelöscht.

function beginDelete(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

resourceGroupName

string

Der Name der zu löschenden Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

ResourceGroupsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, ResourceGroupsDeleteOptionalParams)

Wenn Sie eine Ressourcengruppe löschen, werden auch alle zugehörigen Ressourcen gelöscht. Durch das Löschen einer Ressourcengruppe werden alle zugehörigen Vorlagenbereitstellungen und aktuell gespeicherten Vorgänge gelöscht.

function beginDeleteAndWait(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der zu löschenden Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

ResourceGroupsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginExportTemplate(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Erfasst die angegebene Ressourcengruppe als Vorlage.

function beginExportTemplate(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams): Promise<SimplePollerLike<OperationState<ResourceGroupExportResult>, ResourceGroupExportResult>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

parameters

ExportTemplateRequest

Parameter zum Exportieren der Vorlage.

options

ResourceGroupsExportTemplateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginExportTemplateAndWait(string, ExportTemplateRequest, ResourceGroupsExportTemplateOptionalParams)

Erfasst die angegebene Ressourcengruppe als Vorlage.

function beginExportTemplateAndWait(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams): Promise<ResourceGroupExportResult>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

parameters

ExportTemplateRequest

Parameter zum Exportieren der Vorlage.

options

ResourceGroupsExportTemplateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ResourceGroupExportResult>

checkExistence(string, ResourceGroupsCheckExistenceOptionalParams)

Überprüft, ob eine Ressourcengruppe vorhanden ist.

function checkExistence(resourceGroupName: string, options?: ResourceGroupsCheckExistenceOptionalParams): Promise<ResourceGroupsCheckExistenceResponse>

Parameter

resourceGroupName

string

Der Name der zu prüfenden Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

ResourceGroupsCheckExistenceOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ResourceGroupsCheckExistenceResponse>

createOrUpdate(string, ResourceGroup, ResourceGroupsCreateOrUpdateOptionalParams)

Erstellt oder aktualisiert eine Ressourcengruppe.

function createOrUpdate(resourceGroupName: string, parameters: ResourceGroup, options?: ResourceGroupsCreateOrUpdateOptionalParams): Promise<ResourceGroup>

Parameter

resourceGroupName

string

Der Name der zu erstellenden oder zu aktualisierenden Ressourcengruppe. Kann alphanumerische Zeichen, Unterstriche, Klammern, Bindestriche, Punkt (außer am Ende) und Unicode-Zeichen enthalten, die den zulässigen Zeichen entsprechen.

parameters

ResourceGroup

Parameter, die für das Erstellen oder Aktualisieren einer Ressourcengruppe bereitgestellt werden.

options

ResourceGroupsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ResourceGroup>

get(string, ResourceGroupsGetOptionalParams)

Ruft eine Ressourcengruppe ab.

function get(resourceGroupName: string, options?: ResourceGroupsGetOptionalParams): Promise<ResourceGroup>

Parameter

resourceGroupName

string

Der Name der abzurufenden Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

options

ResourceGroupsGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ResourceGroup>

list(ResourceGroupsListOptionalParams)

Ruft alle Ressourcengruppen für ein Abonnement ab.

function list(options?: ResourceGroupsListOptionalParams): PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

Parameter

options

ResourceGroupsListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<ResourceGroup, ResourceGroup[], PageSettings>

update(string, ResourceGroupPatchable, ResourceGroupsUpdateOptionalParams)

Ressourcengruppen können über einen einfachen PATCH-Vorgang zu einer Gruppenadresse aktualisiert werden. Das Format der Anforderung entspricht dem Format zum Erstellen einer Ressourcengruppe. Wenn ein Feld nicht angegeben ist, wird der aktuelle Wert beibehalten.

function update(resourceGroupName: string, parameters: ResourceGroupPatchable, options?: ResourceGroupsUpdateOptionalParams): Promise<ResourceGroup>

Parameter

resourceGroupName

string

Der Name der zu aktualisierenden Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

parameters

ResourceGroupPatchable

Parameter, die zum Aktualisieren einer Ressourcengruppe bereitgestellt werden.

options

ResourceGroupsUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ResourceGroup>