ResourceGroupsOperations Klasse

  • Referenz

Warnung

Instanziieren Sie diese Klasse NICHT direkt.

Stattdessen sollten Sie über auf die folgenden Vorgänge zugreifen:

ResourceManagementClient's

<xref:resource_groups> -Attribut.

Vererbung
builtins.object
ResourceGroupsOperations

Konstruktor

ResourceGroupsOperations(*args, **kwargs)

Methoden

begin_delete

Löscht eine Ressourcengruppe.

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.
begin_export_template

Erfasst die angegebene Ressourcengruppe als Vorlage.
check_existence

Überprüft, ob eine Ressourcengruppe vorhanden ist.
create_or_update

Erstellt oder aktualisiert eine Ressourcengruppe.
get

Ruft eine Ressourcengruppe ab.
list

Ruft alle Ressourcengruppen für ein Abonnement ab.
update

Updates einer Ressourcengruppe.

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.

begin_delete

Löscht eine Ressourcengruppe.

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.

begin_delete(resource_group_name: str, force_deletion_types: str | None = None, **kwargs: Any) -> LROPoller[None]

Parameter

resource_group_name
str
Erforderlich

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

force_deletion_types
str
Erforderlich

Die Ressourcentypen, die Sie erzwingen möchten. Derzeit wird nur Folgendes unterstützt: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets. Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Abrufs aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abrufmethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abrufobjekt für eine persönliche Abrufstrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder None oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

LROPoller[None]

Ausnahmen

HttpResponseError

begin_export_template

Erfasst die angegebene Ressourcengruppe als Vorlage.

begin_export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ResourceGroupExportResult]

Parameter

resource_group_name
str
Erforderlich

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

parameters
ExportTemplateRequest oder IO
Erforderlich

Parameter zum Exportieren der Vorlage. Ist entweder ein ExportTemplateRequest-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Abrufs aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abrufmethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abrufobjekt für eine persönliche Abrufstrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder ResourceGroupExportResult oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

LROPoller[ResourceGroupExportResult]

Ausnahmen

HttpResponseError

check_existence

Überprüft, ob eine Ressourcengruppe vorhanden ist.

check_existence(resource_group_name: str, **kwargs: Any) -> bool

Parameter

resource_group_name
str
Erforderlich

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

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

bool oder das Ergebnis von cls(response)

Rückgabetyp

bool

Ausnahmen

HttpResponseError

create_or_update

Erstellt oder aktualisiert eine Ressourcengruppe.

create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Parameter

resource_group_name
str
Erforderlich

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. Erforderlich.

parameters
ResourceGroup oder IO
Erforderlich

Parameter, die für das Erstellen oder Aktualisieren einer Ressourcengruppe bereitgestellt werden. Ist entweder ein ResourceGroup-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

ResourceGroup oder das Ergebnis von cls(response)

Rückgabetyp

ResourceGroup

Ausnahmen

HttpResponseError

get

Ruft eine Ressourcengruppe ab.

get(resource_group_name: str, **kwargs: Any) -> ResourceGroup

Parameter

resource_group_name
str
Erforderlich

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

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

ResourceGroup oder das Ergebnis von cls(response)

Rückgabetyp

ResourceGroup

Ausnahmen

HttpResponseError

list

Ruft alle Ressourcengruppen für ein Abonnement ab.

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]

Parameter

filter
str
Erforderlich

Der Filter, der auf den Vorgang angewendet werden soll.:code:
:code:>><<<br>Sie können nach Tagnamen und -werten filtern. Um beispielsweise nach einem Tagnamen und -wert zu filtern, verwenden Sie $filter=tagName eq 'tag1' und tagValue eq 'Value1'. Der Standardwert ist Keine.

top
int
Erforderlich

Die Anzahl der zurückzugebenden Ergebnisse. Wenn NULL übergeben wird, gibt alle Ressourcengruppen zurück. Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von ResourceGroup oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[ResourceGroup]

Ausnahmen

HttpResponseError

update

Updates einer Ressourcengruppe.

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.

update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Parameter

resource_group_name
str
Erforderlich

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

parameters
ResourceGroupPatchable oder IO
Erforderlich

Parameter, die zum Aktualisieren einer Ressourcengruppe bereitgestellt werden. Ist entweder ein ResourceGroupPatchable-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

ResourceGroup oder das Ergebnis von cls(response)

Rückgabetyp

ResourceGroup

Ausnahmen

HttpResponseError

Attribute

models 

models = <module 'azure.mgmt.resource.resources.v2020_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_06_01\\models\\__init__.py'>