ManagementGroupsOperations Klasse

  • Referenz

ManagementGroupsOperations-Vorgänge.

Sie sollten diese Klasse nicht direkt instanziieren. Stattdessen sollten Sie eine Clientinstanz erstellen, die sie für Sie instanziiert und als Attribut anfügt.

Vererbung
builtins.object
ManagementGroupsOperations

Konstruktor

ManagementGroupsOperations(client, config, serializer, deserializer)

Parameter

client
Erforderlich

Client für Dienstanforderungen.

config
Erforderlich

Konfiguration des Dienstclients.

serializer
Erforderlich

Ein Objektmodellserialisierungsprogramm.

deserializer
Erforderlich

Ein Objektmodell-Deserialisierer.

Variablen

models

Alias zum Modellieren von Klassen, die in dieser Vorgangsgruppe verwendet werden.

Methoden

begin_create_or_update

Erstellt oder aktualisiert eine Verwaltungsgruppe. Wenn bereits eine Verwaltungsgruppe erstellt wurde und eine nachfolgende Erstellungsanforderung mit unterschiedlichen Eigenschaften ausgestellt wird, werden die Eigenschaften der Verwaltungsgruppe aktualisiert.
begin_delete

Löscht eine Verwaltungsgruppe. Wenn eine Verwaltungsgruppe untergeordnete Ressourcen enthält, schlägt die Anforderung fehl.
get

Rufen Sie die Details der Verwaltungsgruppe ab.
get_descendants

Listet alle Entitäten auf, die von einer Verwaltungsgruppe absteigen.
list

Listet die Verwaltungsgruppen für den authentifizierten Benutzer auf.
update

Aktualisieren sie eine Verwaltungsgruppe.

begin_create_or_update

Erstellt oder aktualisiert eine Verwaltungsgruppe. Wenn bereits eine Verwaltungsgruppe erstellt wurde und eine nachfolgende Erstellungsanforderung mit unterschiedlichen Eigenschaften ausgestellt wird, werden die Eigenschaften der Verwaltungsgruppe aktualisiert.

begin_create_or_update(group_id: str, create_management_group_request: '_models.CreateManagementGroupRequest', cache_control: str | None = 'no-cache', **kwargs: Any) -> LROPoller['_models.ManagementGroup' | '_models.AzureAsyncOperationResults']

Parameter

group_id
str
Erforderlich

Verwaltungsgruppen-ID.

create_management_group_request
CreateManagementGroupRequest
Erforderlich

Verwaltungsgruppenerstellungsparameter.

cache_control
str
Standardwert: no-cache

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.

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

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

Rückgabetyp

LROPoller[ManagementGroup]

Ausnahmen

HttpResponseError

begin_delete

Löscht eine Verwaltungsgruppe. Wenn eine Verwaltungsgruppe untergeordnete Ressourcen enthält, schlägt die Anforderung fehl.

begin_delete(group_id: str, cache_control: str | None = 'no-cache', **kwargs: Any) -> LROPoller['_models.AzureAsyncOperationResults']

Parameter

group_id
str
Erforderlich

Verwaltungsgruppen-ID.

cache_control
str
Standardwert: no-cache

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.

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

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

Rückgabetyp

LROPoller[AzureAsyncOperationResults]

Ausnahmen

HttpResponseError

get

Rufen Sie die Details der Verwaltungsgruppe ab.

get(group_id: str, expand: str | '_models.Enum0' | None = None, recurse: bool | None = None, filter: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> _models.ManagementGroup

Parameter

group_id
str
Erforderlich

Verwaltungsgruppen-ID.

expand
str oder Enum0
Standardwert: None

Mit dem Abfragezeichenfolgenparameter $expand=children können Clients die Aufnahme untergeordneter Elemente in die Antwortnutzlast anfordern. $expand=path enthält den Pfad von der Stammgruppe zur aktuellen Gruppe. $expand=ancestors enthält die Vorgänger-ID der aktuellen Gruppe.

recurse
bool
Standardwert: None

Mit dem $recurse=true-Abfragezeichenfolgenparameter können Clients die Aufnahme der gesamten Hierarchie in die Antwortnutzlast anfordern. Beachten Sie, dass $expand=children übergeben werden muss, wenn $recurse auf true festgelegt ist.

filter
str
Standardwert: None

Ein Filter, der den Ausschluss von Abonnements aus ergebnissen (d. h. "$filter=children.childType ne Subscription") zulässt.

cache_control
str
Standardwert: no-cache

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.

cls
callable

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

Gibt zurück

ManagementGroup oder das Ergebnis von cls(response)

Rückgabetyp

ManagementGroup

Ausnahmen

HttpResponseError

get_descendants

Listet alle Entitäten auf, die von einer Verwaltungsgruppe absteigen.

get_descendants(group_id: str, skiptoken: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable['_models.DescendantListResult']

Parameter

group_id
str
Erforderlich

Verwaltungsgruppen-ID.

skiptoken
str
Standardwert: None

Das Seitenfortsetzungstoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Tokenparameter, der einen Startpunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.

top
int
Standardwert: None

Anzahl der Elemente, die beim Abrufen von Ergebnissen zurückgegeben werden sollen. Durch Die Übergabe wird $skipToken überschrieben.

cls
callable

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

Gibt zurück

Eine Iterator-ähnliche Instanz von DescendantListResult oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[DescendantListResult]

Ausnahmen

HttpResponseError

list

Listet die Verwaltungsgruppen für den authentifizierten Benutzer auf.

list(cache_control: str | None = 'no-cache', skiptoken: str | None = None, **kwargs: Any) -> Iterable['_models.ManagementGroupListResult']

Parameter

cache_control
str
Standardwert: no-cache

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.

skiptoken
str
Standardwert: None

Das Seitenfortsetzungstoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Tokenparameter, der einen Startpunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.

cls
callable

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

Gibt zurück

Eine Iterator-ähnliche Instanz von ManagementGroupListResult oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[ManagementGroupListResult]

Ausnahmen

HttpResponseError

update

Aktualisieren sie eine Verwaltungsgruppe.

update(group_id: str, patch_group_request: '_models.PatchManagementGroupRequest', cache_control: str | None = 'no-cache', **kwargs: Any) -> _models.ManagementGroup

Parameter

group_id
str
Erforderlich

Verwaltungsgruppen-ID.

patch_group_request
PatchManagementGroupRequest
Erforderlich

Patchparameter für Verwaltungsgruppen.

cache_control
str
Standardwert: no-cache

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.

cls
callable

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

Gibt zurück

ManagementGroup oder das Ergebnis von cls(response)

Rückgabetyp

ManagementGroup

Ausnahmen

HttpResponseError

Attribute

models 

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