Entities - List
A hitelesített felhasználó összes entitásának (felügyeleti csoportok, előfizetések stb.) listázása.
POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01
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-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2018-01-01-preview. |
$filter
|
query |
string |
A szűrőparaméter lehetővé teszi a név- vagy megjelenítendő névmezőkre való szűrést. A névmezőben ellenőrizheti az egyenlőséget (pl. "{entityName}" név eq), és a név vagy a megjelenítendő név mezőkben (pl. contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")) kereshet részsztringeket. Vegye figyelembe, hogy a(z) "{entityName}" és a "{substringToSearch}" mezőket a rendszer nem érzéketlenül ellenőrzi. |
|
$search
|
query |
string |
A $search paraméter a $filter paraméterrel együtt három különböző kimenet visszaadására szolgál a megadott paramétertől függően. A $search=AllowedParents használatával az API visszaadja az összes olyan csoport entitásadatait, amelyekre a kért entitás a felhasználó engedélyei alapján vissza tud térni. A $search=AllowedChildren használatával az API visszaadja az összes entitás entitásadatait, amelyek hozzáadhatók a kért entitás gyermekeiként. A $search=ParentAndFirstLevelChildren használatával az API visszaadja azokat a szülő- és első szintű gyermekeket, amelyekhez a felhasználó közvetlen vagy közvetett hozzáféréssel rendelkezik az egyik leszármazottjukon keresztül. A $search=ParentOnly használatával az API csak a csoportot adja vissza, ha a felhasználónak hozzáférése van a csoport legalább egy leszármazottához. A $search=ChildrenOnly használatával az API csak az $filter-ben megadott csoportentitás-adatok gyermekszintjének első szintjét adja vissza. A felhasználónak közvetlen hozzáféréssel kell rendelkeznie a gyermekentitásokhoz vagy azok leszármazottaihoz, hogy megjelenjenek az eredményekben. |
|
$select
|
query |
string |
Ez a paraméter határozza meg a válaszban szerepeltetni kívánt mezőket. Belefoglalhatja a Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, pl. "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain" kombinációját. Ha meg van adva, a $select paraméter felülbírálhatja a kiválasztást $skipToken. |
|
$skip
|
query |
integer |
Az eredmények lekérésekor átugorandó entitások száma. A beadás felülbírálja a $skipToken. |
|
$skiptoken
|
query |
string |
Az oldalfolytatási token csak akkor használatos, ha egy korábbi művelet részleges eredményt adott vissza. Ha egy előző válasz tartalmaz nextLink elemet, a nextLink elem értéke tartalmaz egy tokenparamétert, amely meghatározza a későbbi hívásokhoz használandó kiindulási pontot. |
|
$top
|
query |
integer |
Az eredmények lekérésekor visszaadandó elemek száma. A beadás felülbírálja a $skipToken. |
|
$view
|
query |
string |
A nézetparaméter lehetővé teszi az ügyfelek számára a getEntities hívás által visszaadott adattípus szűrését. |
|
group
|
query |
string |
Szűrő, amely lehetővé teszi, hogy az entitások lekérése hívása egy adott csoportra összpontosítson (pl. "$filter=name eq 'groupName'") |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
Cache-Control |
string |
Azt jelzi, hogy a kérésnek nem szabad gyorsítótárakat használnia. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Hiba |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
GetEntities
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01
Mintaválasz
{
"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
}
Definíciók
Name | Description |
---|---|
Entity |
Az entitás. |
Entity |
Az entitások megtekintésére irányuló kérelem eredményét ismerteti. |
Entity |
(Nem kötelező) A szülő felügyeleti csoport azonosítója. |
Error |
A hiba részletei. |
Error |
A hibaobjektum. |
Permissions |
Az elemhez tartozó felhasználókra vonatkozó engedélyek. |
EntityInfo
Az entitás.
Name | Típus | Description |
---|---|---|
id |
string |
Az entitás teljes azonosítója. Például: /providers/Microsoft.Management/managementGroups/0000000-0000-0000-000000000000000 |
name |
string |
Az entitás neve. Például: 000000000-0000-0000-0000-0000000000000 |
properties.displayName |
string |
A felügyeleti csoport rövid neve. |
properties.inheritedPermissions |
Örökölt engedélyek |
|
properties.numberOfChildGroups |
integer |
Gyermekcsoportok száma |
properties.numberOfChildren |
integer |
Gyermekek száma |
properties.numberOfDescendants |
integer |
Leszármazottak száma |
properties.parent |
Szülő |
|
properties.parentDisplayNameChain |
string[] |
A szülő megjelenítendő név lánca a gyökércsoporttól az azonnali szülőig |
properties.parentNameChain |
string[] |
A szülőnévlánc a gyökércsoporttól az azonnali szülőig |
properties.permissions |
Engedélyek |
|
properties.tenantId |
string |
Az entitáshoz társított AAD-bérlő azonosítója. Például: 000000000-0000-0000-0000-0000000000000 |
type |
string |
Az erőforrás típusa. Például: Microsoft.Management/managementGroups |
EntityListResult
Az entitások megtekintésére irányuló kérelem eredményét ismerteti.
Name | Típus | Description |
---|---|---|
count |
integer |
A szűrőnek megfelelő rekordok teljes száma |
nextLink |
string |
A következő találatkészlet lekéréséhez használandó URL-cím. |
value |
Az entitások listája. |
EntityParentGroupInfo
(Nem kötelező) A szülő felügyeleti csoport azonosítója.
Name | Típus | Description |
---|---|---|
id |
string |
A szülő felügyeleti csoport teljes azonosítója. Például: /providers/Microsoft.Management/managementGroups/0000000-0000-0000-000000000000000 |
ErrorDetails
A hiba részletei.
Name | Típus | Description |
---|---|---|
code |
string |
A kiszolgáló által definiált hibakódok egyike. |
details |
string |
A hiba részleteinek emberi olvasásra alkalmas ábrázolása. |
message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
ErrorResponse
A hibaobjektum.
Name | Típus | Description |
---|---|---|
error |
Hiba |
Permissions
Az elemhez tartozó felhasználókra vonatkozó engedélyek.
Name | Típus | Description |
---|---|---|
delete |
string |
|
edit |
string |
|
noaccess |
string |
|
view |
string |