ResourceGroupsOperations Klasse

  • Referenz

Warnung

Instanziieren Sie diese Klasse NICHT direkt.

Stattdessen sollten Sie 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.
check_existence

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

Erstellt oder aktualisiert eine Ressourcengruppe.
export_template

Erfasst die angegebene Ressourcengruppe als Vorlage.
get

Ruft eine Ressourcengruppe ab.
list

Ruft alle Ressourcengruppen für ein Abonnement ab.
update

Updates eine Ressourcengruppe.

Ressourcengruppen können über einen einfachen PATCH-Vorgang zu einer Gruppenadresse aktualisiert werden. Das Format der Anforderung ist identisch mit dem Format für das 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, **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.

cls
callable

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

continuation_token
str

Ein Fortsetzungstoken, um einen Poller aus einem gespeicherten Zustand neu zu starten.

polling
bool oder PollingMethod

Standardmäßig lautet die Abfragemethode ARMPolling. Übergeben Sie False, damit dieser Vorgang kein Abruf oder ein eigenes initialisiertes Abfrageobjekt für eine persönliche Abfragestrategie übergibt.

polling_interval
int

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

Gibt zurück

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

Rückgabetyp

LROPoller[None]

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 Ressourcengruppe, die erstellt oder aktualisiert werden soll. Kann alphanumerische, 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 angegeben 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

export_template

Erfasst die angegebene Ressourcengruppe als Vorlage.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe, die als Vorlage exportiert werden soll. Erforderlich.

parameters
ExportTemplateRequest oder IO
Erforderlich

Parameter für den Export 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

Gibt zurück

ResourceGroupExportResult oder das Ergebnis von cls(response)

Rückgabetyp

ResourceGroupExportResult

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ückgegebenen Ergebnisse. Wenn NULL übergeben wird, werden alle Ressourcengruppen zurückgegeben. 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 eine Ressourcengruppe.

Ressourcengruppen können über einen einfachen PATCH-Vorgang zu einer Gruppenadresse aktualisiert werden. Das Format der Anforderung ist identisch mit dem Format für das 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.v2019_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2019_05_01\\models\\__init__.py'>