Entities - List

Odwołanie

Usługa:: Management Groups

Wersja interfejsu API:: 2020-05-01

Wyświetl wszystkie jednostki (grupy zarządzania, subskrypcje itp.) dla uwierzytelnioowanego użytkownika.

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

Z parametrami opcjonalnymi:

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2018-01-01-preview.
$filter	query		string	Parametr filtru umożliwia filtrowanie pól nazwy lub nazwy wyświetlanej. Możesz sprawdzić równość w polu nazwy (np. name eq "{entityName}") i sprawdzić podciąg na polach nazwy lub nazwy wyświetlanej (np. contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")). Należy pamiętać, że pola "{entityName}" i "{substringToSearch}" są sprawdzane bez uwzględniania wielkości liter.
$search	query		string	Parametr $search jest używany w połączeniu z parametrem $filter, aby zwrócić trzy różne dane wyjściowe w zależności od przekazanego parametru. W przypadku $search=AllowedParents interfejs API zwróci informacje o jednostce wszystkich grup, do których żądana jednostka będzie mogła wykonać reparent zgodnie z uprawnieniami użytkownika. Za pomocą $search=AllowedChildren interfejs API zwróci informacje o jednostce wszystkich jednostek, które można dodać jako elementy podrzędne żądanej jednostki. Za pomocą $search=ParentAndFirstLevelChildren interfejs API zwróci element nadrzędny i pierwszy poziom elementów podrzędnych, do których użytkownik ma bezpośredni dostęp lub dostęp pośredni za pośrednictwem jednego z ich elementów podrzędnych. W $search=ParentOnly interfejs API zwróci tylko grupę, jeśli użytkownik ma dostęp do co najmniej jednego z elementów podrzędnych grupy. W przypadku $search=ChildrenOnly interfejs API zwróci tylko pierwszy poziom elementów podrzędnych informacji o jednostce grupy określonych w $filter. Użytkownik musi mieć bezpośredni dostęp do jednostek podrzędnych lub jednego z elementów podrzędnych, aby był wyświetlany w wynikach.
$select	query		string	Ten parametr określa pola do uwzględnienia w odpowiedzi. Może zawierać dowolną kombinację wartości Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, np. "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain". Po określeniu parametru $select można zastąpić zaznaczenie w $skipToken.
$skip	query		integer	Liczba jednostek do pominięcia podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
$skiptoken	query		string	Token kontynuacji strony jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr tokenu, który określa punkt wyjścia do użycia dla kolejnych wywołań.
$top	query		integer	Liczba elementów, które mają być zwracane podczas pobierania wyników. Przekazanie tego elementu spowoduje zastąpienie $skipToken.
$view	query		string	Parametr widoku umożliwia klientom filtrowanie typu danych zwracanych przez wywołanie getEntities.
groupName	query		string	Filtr, który umożliwia wywołanie pobierania jednostek, aby skupić się na określonej grupie (tj. "$filter=name eq 'groupName'")

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Cache-Control		string	Wskazuje, że żądanie nie powinno korzystać z żadnych pamięci podręcznych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EntityListResult	OK
Other Status Codes	ErrorResponse	Błąd

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GetEntities

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
}

Definicje

Nazwa	Opis
EntityInfo	Jednostka.
EntityListResult	Opisuje wynik żądania wyświetlania jednostek.
EntityParentGroupInfo	(Opcjonalnie) Identyfikator nadrzędnej grupy zarządzania.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Obiekt błędu.
Permissions	Użytkownicy mają określone uprawnienia do tego elementu.

EntityInfo

Jednostka.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator jednostki. Na przykład /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Nazwa jednostki. Na przykład 000000000-0000-0000-0000-00000000000000000
properties.displayName	string	Przyjazna nazwa grupy zarządzania.
properties.inheritedPermissions	Permissions	Uprawnienia dziedziczone Użytkownicy mają określone uprawnienia do tego elementu.
properties.numberOfChildGroups	integer	Liczba grup podrzędnych Liczba elementów podrzędnych to liczba grup, które są dokładnie jednym poziomem poniżej bieżącej grupy.
properties.numberOfChildren	integer	Liczba elementów podrzędnych Liczba elementów podrzędnych to liczba grup i subskrypcji, które są dokładnie jednym poziomem poniżej bieżącej grupy.
properties.numberOfDescendants	integer	Liczba elementów podrzędnych
properties.parent	EntityParentGroupInfo	Parent (Opcjonalnie) Identyfikator nadrzędnej grupy zarządzania.
properties.parentDisplayNameChain	string[]	Nadrzędny łańcuch nazw wyświetlanych z grupy głównej do bezpośredniego elementu nadrzędnego
properties.parentNameChain	string[]	Łańcuch nazw nadrzędnych z grupy głównej do bezpośredniego elementu nadrzędnego
properties.permissions	Permissions	Uprawnienia Użytkownicy mają określone uprawnienia do tego elementu.
properties.tenantId	string	Identyfikator dzierżawy usługi AAD skojarzony z jednostką. Na przykład 000000000-0000-0000-0000-00000000000000000
type	string	Typ zasobu. Na przykład Microsoft.Management/managementGroups

EntityListResult

Opisuje wynik żądania wyświetlania jednostek.

Nazwa	Typ	Opis
count	integer	Łączna liczba rekordów pasujących do filtru
nextLink	string	Adres URL używany do pobierania następnego zestawu wyników.
value	EntityInfo[]	Lista jednostek.

EntityParentGroupInfo

(Opcjonalnie) Identyfikator nadrzędnej grupy zarządzania.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator nadrzędnej grupy zarządzania. Na przykład /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	string	Czytelna dla człowieka reprezentacja szczegółów błędu.
message	string	Czytelna dla człowieka reprezentacja błędu.

ErrorResponse

Obiekt błędu.

Nazwa	Typ	Opis
error	ErrorDetails	Błąd Szczegóły błędu.

Permissions

Użytkownicy mają określone uprawnienia do tego elementu.

Nazwa	Typ	Opis
delete	string
edit	string
noaccess	string
view	string

Udostępnij za pośrednictwem