Entities - List

Reference

Služba:: Management Groups

Verze rozhraní API:: 2020-05-01

Vypíše všechny entity (skupiny pro správu, předplatná atd.) pro ověřeného uživatele.

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2018-01-01-preview.
$filter	query		string	Parametr filter umožňuje filtrovat pole názvů nebo zobrazovaných názvů. Můžete zkontrolovat rovnost v poli name (např. name eq '{entityName}') a můžete zkontrolovat podřetězece v polích name nebo display name (např. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} se kontrolují nerozlišují malá a velká písmena.
$search	query		string	Parametr $search se používá ve spojení s parametrem $filter k vrácení tří různých výstupů v závislosti na předaném parametru. V $search=AllowedParents vrátí rozhraní API informace o entitách všech skupin, ke kterým bude požadovaná entita moct přejít podle oprávnění uživatele. V $search=AllowedChildren vrátí rozhraní API informace o entitách všech entit, které je možné přidat jako podřízené položky požadované entity. S $search=ParentAndFirstLevelChildren vrátí rozhraní API nadřazenou a první úroveň podřízených položek, ke kterým má uživatel přímý nebo nepřímý přístup prostřednictvím některého ze svých potomků. S $search=ParentOnly vrátí rozhraní API pouze skupinu, pokud má uživatel přístup alespoň k jednomu z potomků skupiny. S $search=ChildrenOnly vrátí rozhraní API pouze první úroveň podřízených položek informací o entitě skupiny zadaných v $filter. Aby se uživatel mohl zobrazit ve výsledcích, musí mít přímý přístup k podřízeným entitám nebo k některému z jejich potomků.
$select	query		string	Tento parametr určuje pole, která se mají zahrnout do odpovědi. Může obsahovat libovolnou kombinaci Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, například '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Při zadání může parametr $select přepsat select v $skipToken.
$skip	query		integer	Počet entit, které se mají při načítání výsledků přeskočit Předáním tohoto parametru dojde k přepsání $skipToken.
$skiptoken	query		string	Pokračovací token stránky se používá jenom v případě, že předchozí operace vrátila částečný výsledek. Pokud předchozí odpověď obsahuje nextLink element, hodnota prvku nextLink bude obsahovat parametr tokenu, který určuje počáteční bod pro následné volání.
$top	query		integer	Počet prvků, které se mají vrátit při načítání výsledků Předáním tohoto parametru dojde k přepsání $skipToken.
$view	query		string	Parametr view umožňuje klientům filtrovat typ dat vrácených voláním getEntities.
groupName	query		string	Filtr, který umožňuje volání get entit za účelem zaměření se na konkrétní skupinu (tj. "$filter=name eq 'groupName'")

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Cache-Control		string	Označuje, že požadavek by neměl využívat žádné mezipaměti.

Odpovědi

Name	Typ	Description
200 OK	EntityListResult	OK
Other Status Codes	ErrorResponse	Chyba

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetEntities

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
}

Definice

Name	Description
EntityInfo	Entita.
EntityListResult	Popisuje výsledek požadavku na zobrazení entit.
EntityParentGroupInfo	(Volitelné) ID nadřazené skupiny pro správu.
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Objekt chyby.
Permissions	Oprávnění specifická pro uživatele k této položce.

EntityInfo

Entita.

Name	Typ	Description
id	string	Plně kvalifikované ID entity. Například /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	Název sady entit. Například 000000000-0000-0000-0000-0000000000000
properties.displayName	string	Popisný název skupiny pro správu
properties.inheritedPermissions	Permissions	Zděděná oprávnění Oprávnění specifická pro uživatele k této položce.
properties.numberOfChildGroups	integer	Počet podřízených skupin Počet podřízených položek je počet skupin, které jsou přesně o jednu úroveň pod aktuální skupinou.
properties.numberOfChildren	integer	Počet podřízených položek Počet podřízených položek je počet skupin a předplatných, které jsou přesně o jednu úroveň pod aktuální skupinou.
properties.numberOfDescendants	integer	Počet potomků
properties.parent	EntityParentGroupInfo	Parent (Volitelné) ID nadřazené skupiny pro správu.
properties.parentDisplayNameChain	string[]	Řetěz zobrazovaný název nadřazeného objektu z kořenové skupiny do bezprostředně nadřazeného objektu
properties.parentNameChain	string[]	Řetěz názvů nadřazených z kořenové skupiny na bezprostředně nadřazenou
properties.permissions	Permissions	Oprávnění Oprávnění specifická pro uživatele k této položce.
properties.tenantId	string	ID tenanta AAD přidružené k entitě. Například 000000000-0000-0000-0000-0000000000000
type	string	Typ prostředku. Například Microsoft.Management/managementGroups

EntityListResult

Popisuje výsledek požadavku na zobrazení entit.

Name	Typ	Description
count	integer	Celkový počet záznamů, které odpovídají filtru
nextLink	string	Adresa URL, která se má použít pro získání další sady výsledků.
value	EntityInfo[]	Seznam entit.

EntityParentGroupInfo

(Volitelné) ID nadřazené skupiny pro správu.

Name	Typ	Description
id	string	Plně kvalifikované ID nadřazené skupiny pro správu. Například /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	string	Pro člověka čitelná reprezentace podrobností chyby.
message	string	Lidsky čitelná reprezentace chyby.

ErrorResponse

Objekt chyby.

Name	Typ	Description
error	ErrorDetails	Chyba Podrobnosti o chybě.

Permissions

Oprávnění specifická pro uživatele k této položce.

Name	Typ	Description
delete	string
edit	string
noaccess	string
view	string

Sdílet prostřednictvím