EntitiesOperations Klasse

  • Referenz

EntitiesOperations-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
EntitiesOperations

Konstruktor

EntitiesOperations(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 für Modellklassen, die in dieser Vorgangsgruppe verwendet werden.

Methoden

list

Listet alle Entitäten (Verwaltungsgruppen, Abonnements usw.) für den authentifizierten Benutzer auf.

list

Listet alle Entitäten (Verwaltungsgruppen, Abonnements usw.) für den authentifizierten Benutzer auf.

list(skiptoken: str | None = None, skip: int | None = None, top: int | None = None, select: str | None = None, search: str | '_models.Enum2' | None = None, filter: str | None = None, view: str | '_models.Enum3' | None = None, group_name: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> Iterable['_models.EntityListResult']

Parameter

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.

skip
int
Standardwert: None

Anzahl der Entitäten, die beim Abrufen von Ergebnissen übersprungen werden sollen. Durch die Übergabe in wird $skipToken überschrieben.

top
int
Standardwert: None

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

select
str
Standardwert: None

Dieser Parameter gibt die Felder an, die in die Antwort eingeschlossen werden sollen. Kann eine beliebige Kombination aus Name, DisplayName, Type, ParentDisplayNameChain, ParentChain enthalten, z. B. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Wenn angegeben, kann der $select Parameter die Auswahl in $skipToken außer Kraft setzen.

search
str oder Enum2
Standardwert: None

Der parameter $search wird in Verbindung mit dem parameter $filter verwendet, um je nach übergebenem Parameter drei verschiedene Ausgaben zurückzugeben. Mit $search=AllowedParents gibt die API die Entitätsinformationen aller Gruppen zurück, an die die angeforderte Entität gemäß den Berechtigungen des Benutzers erneut wechseln kann. Mit $search=AllowedChildren gibt die API die Entitätsinformationen aller Entitäten zurück, die als untergeordnete Elemente der angeforderten Entität hinzugefügt werden können. Mit $search=ParentAndFirstLevelChildren gibt die API die übergeordnete und die erste Ebene von untergeordneten Elementen zurück, auf die der Benutzer entweder direkten Zugriff oder indirekten Zugriff über eines seiner Nachfolger hat. Mit $search=ParentOnly gibt die API nur die Gruppe zurück, wenn der Benutzer Zugriff auf mindestens einen der Nachfolger der Gruppe hat. Mit $search=ChildrenOnly gibt die API nur die erste Ebene untergeordneter Elemente der in $filter angegebenen Gruppenentitätsinformationen zurück. Der Benutzer muss direkten Zugriff auf die untergeordneten Entitäten oder eine seiner Nachfolger haben, damit er in den Ergebnissen angezeigt wird.

filter
str
Standardwert: None

Mit dem Filterparameter können Sie nach den Feldern "Name" oder "Anzeigename" filtern. Sie können die Gleichheit des Namensfelds überprüfen (z. B. name eq '{entityName}'), und Sie können auf Teilzeichenfolgen für die Felder name oder Anzeigename (z. B. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')) überprüfen. Beachten Sie, dass bei den Feldern "{entityName}" und "{substringToSearch}" die Groß-/Kleinschreibung nicht beachtet wird.

view
str oder Enum3
Standardwert: None

Mit dem View-Parameter können Clients den Typ der Daten filtern, die vom getEntities-Aufruf zurückgegeben werden.

group_name
str
Standardwert: None

Ein Filter, der es dem Get-Entitätsaufruf ermöglicht, sich auf eine bestimmte Gruppe zu konzentrieren (d. h. "$filter=name eq 'groupName'").

cache_control
str
Standardwert: no-cache

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

cls
callable

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

Gibt zurück

Ein Iterator wie eine Instanz von EntityListResult oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[EntityListResult]

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'>