Entities - List

Referenz

Service:: Management Groups

API Version:: 2020-05-01

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

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01

With optional parameters:

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01&$skiptoken={$skiptoken}&$skip={$skip}&$top={$top}&$select={$select}&$search={$search}&$filter={$filter}&$view={$view}&groupName={groupName}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2018-01-01-preview.
$filter	query		string	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.
$search	query		string	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 hat, oder indirekten Zugriff über eines seiner Nachfolger. 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.
$select	query		string	Dieser Parameter gibt die Felder an, die in die Antwort eingeschlossen werden sollen. Kann eine beliebige Kombination aus Name, DisplayName, Type, ParentDisplayNameChain, ParentChain, z. B. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain' enthalten. Wenn angegeben, kann der $select Parameter die Auswahl in $skipToken außer Kraft setzen.
$skip	query		integer	Anzahl der Entitäten, die beim Abrufen von Ergebnissen übersprungen werden sollen. Durch die Übergabe in wird $skipToken überschrieben.
$skiptoken	query		string	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	query		integer	Anzahl der Elemente, die beim Abrufen von Ergebnissen zurückgegeben werden sollen. Durch die Übergabe in wird $skipToken überschrieben.
$view	query		string	Mit dem View-Parameter können Clients den Typ der Daten filtern, die vom getEntities-Aufruf zurückgegeben werden.
groupName	query		string	Ein Filter, der es dem Get-Entitätsaufruf ermöglicht, sich auf eine bestimmte Gruppe zu konzentrieren (d. h. "$filter=name eq 'groupName'").

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Cache-Control		string	Gibt an, dass die Anforderung keine Caches verwenden soll.

Antworten

Name	Typ	Beschreibung
200 OK	EntityListResult	OK
Other Status Codes	ErrorResponse	Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

GetEntities

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0001-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 1 Tenant 2",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "view",
        "inheritedPermissions": "view",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 1 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group1Tenant2Parent"
        ],
        "numberOfDescendants": 3,
        "numberOfChildren": 2,
        "numberOfChildGroups": 1
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0004-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 4 Tenant 2",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000"
        },
        "permissions": "delete",
        "inheritedPermissions": "delete",
        "parentDisplayNameChain": [
          "Tenant Root Group",
          "Group 4 Tenant 2 Parent"
        ],
        "parentNameChain": [
          "TenantRootGroup",
          "Group4 Tenant2Parent"
        ],
        "numberOfDescendants": 0,
        "numberOfChildren": 0,
        "numberOfChildGroups": 0
      }
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
EntityInfo	Die Entität.
EntityListResult	Beschreibt das Ergebnis der Anforderung zum Anzeigen von Entitäten.
EntityParentGroupInfo	(Optional) Die ID der übergeordneten Verwaltungsgruppe.
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Das Fehlerobjekt.
Permissions	Die benutzerspezifischen Berechtigungen für dieses Element.

EntityInfo

Die Entität.

Name	Typ	Beschreibung
id	string	Die vollqualifizierte ID für die Entität. Beispiel: /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Der Name der Entität. Beispiel: 00000000-0000-0000-0000-0000000000000
properties.displayName	string	Der Anzeigename der Verwaltungsgruppe.
properties.inheritedPermissions	Permissions	Geerbte Berechtigungen Die benutzerspezifischen Berechtigungen für dieses Element.
properties.numberOfChildGroups	integer	Anzahl der untergeordneten Gruppen Die Anzahl der untergeordneten Elemente ist die Anzahl der Gruppen, die genau eine Ebene unterhalb der aktuellen Gruppe sind.
properties.numberOfChildren	integer	Anzahl der Kinder Die Anzahl der untergeordneten Elemente ist die Anzahl von Gruppen und Abonnements, die genau eine Ebene unterhalb der aktuellen Gruppe sind.
properties.numberOfDescendants	integer	Anzahl von Nachfolgern
properties.parent	EntityParentGroupInfo	Parent (Optional) Die ID der übergeordneten Verwaltungsgruppe.
properties.parentDisplayNameChain	string[]	Die übergeordnete Anzeigenamenkette von der Stammgruppe zum unmittelbaren übergeordneten Element
properties.parentNameChain	string[]	Die übergeordnete Namenskette von der Stammgruppe zum unmittelbaren übergeordneten Element
properties.permissions	Permissions	Berechtigungen Die benutzerspezifischen Berechtigungen für dieses Element.
properties.tenantId	string	Die der Entität zugeordnete AAD-Mandanten-ID. Beispiel: 00000000-0000-0000-0000-0000000000000
type	string	Der Typ der Ressource. Beispiel: Microsoft.Management/managementGroups

EntityListResult

Beschreibt das Ergebnis der Anforderung zum Anzeigen von Entitäten.

Name	Typ	Beschreibung
count	integer	Gesamtanzahl der Datensätze, die dem Filter entsprechen
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	EntityInfo[]	Die Liste der Entitäten.

EntityParentGroupInfo

(Optional) Die ID der übergeordneten Verwaltungsgruppe.

Name	Typ	Beschreibung
id	string	Die vollqualifizierte ID für die übergeordnete Verwaltungsgruppe. Beispiel: /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	string	Eine lesbare Darstellung der Fehlerdetails.
message	string	Eine lesbare Darstellung des Fehlers.

ErrorResponse

Das Fehlerobjekt.

Name	Typ	Beschreibung
error	ErrorDetails	Fehler Die Details des Fehlers.

Permissions

Die benutzerspezifischen Berechtigungen für dieses Element.

Name	Typ	Beschreibung
delete	string
edit	string
noaccess	string
view	string

Freigeben über