Delen via

Entities - List

Service:
Management Groups
API-versie:
2020-05-01

Vermeld alle entiteiten (beheergroepen, abonnementen, enzovoort) voor de geverifieerde gebruiker.

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01
Met optionele 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-parameters

Name In Vereist Type Description
api-version
 query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag. De huidige versie is 2018-01-01-preview.
$filter
 query

string

Met de filterparameter kunt u filteren op de naam- of weergavenaamvelden. U kunt controleren op gelijkheid in het naamveld (bijvoorbeeld naam eq {entityName}) en u kunt controleren op subtekenreeksen op de naam- of weergavenaamvelden (bijvoorbeeld contains(name, {substringToSearch}), contains(displayName, {substringToSearch)). Houd er rekening mee dat de velden {entityName} en {substringToSearch} niet hoofdlettergevoelig worden gecontroleerd.
$search
 query

string

De parameter $search wordt gebruikt in combinatie met de parameter $filter om drie verschillende uitvoer te retourneren, afhankelijk van de doorgegeven parameter. Met $search=AllowedParents retourneert de API de entiteitsgegevens van alle groepen waartoe de aangevraagde entiteit kan reparenten zoals bepaald door de machtigingen van de gebruiker. Met $search=Allowed Children retourneert de API de entiteitsgegevens van alle entiteiten die kunnen worden toegevoegd als onderliggende items van de aangevraagde entiteit. Met $search=ParentAndFirstLevel Children retourneert de API het bovenliggende en eerste niveau van onderliggende elementen dat de gebruiker directe toegang tot of indirecte toegang heeft via een van hun nakomelingen. Met $search=ParentOnly retourneert de API alleen de groep als de gebruiker toegang heeft tot ten minste één van de afstammelingen van de groep. Met $search=ChildrenOnly retourneert de API alleen het eerste niveau van onderliggende elementen van de groepsentiteitsgegevens die zijn opgegeven in $filter. De gebruiker moet directe toegang hebben tot de onderliggende entiteiten of een van de onderliggende entiteiten om deze weer te geven in de resultaten.
$select
 query

string

Met deze parameter geeft u de velden op die moeten worden opgenomen in het antwoord. Kan elke combinatie van Naam, DisplayName, Type, ParentDisplayNameChain, ParentChain, bijvoorbeeld '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain', bevatten. Wanneer u de parameter $select opgeeft, kunt u de selectie in $skipToken overschrijven.
$skip
 query

integer

Het aantal entiteiten dat moet worden overgeslagen bij het ophalen van resultaten. Als u dit doorgeeft, wordt $skipToken overschreven.
$skiptoken
 query

string

Het vervolgtoken van de pagina wordt alleen gebruikt als een vorige bewerking een gedeeltelijk resultaat heeft geretourneerd. Als een eerder antwoord een nextLink-element bevat, bevat de waarde van het nextLink-element een tokenparameter die een beginpunt aangeeft dat moet worden gebruikt voor volgende aanroepen.
$top
 query

integer

Aantal elementen dat moet worden geretourneerd bij het ophalen van resultaten. Als u dit doorgeeft, wordt $skipToken overschreven.
$view
 query

string

Met de weergaveparameter kunnen clients het type gegevens filteren dat wordt geretourneerd door de aanroep Entiteiten ophalen.
groupName
 query

string

Een filter waarmee de get-entiteiten zich kunnen richten op een bepaalde groep (bijvoorbeeld "$filter=name eq 'groupName')

Aanvraagkoptekst

Name Vereist Type Description
Cache-Control

string

Geeft aan dat de aanvraag geen caches mag gebruiken.

Antwoorden

Name Type Description
200 OK

EntityListResult

OK
Other Status Codes

ErrorResponse

Fout

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

GetEntities

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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
}

Definities

Name Description
EntityInfo

De entiteit.
EntityListResult

Beschrijft het resultaat van de aanvraag om entiteiten weer te geven.
EntityParentGroupInfo

(Optioneel) De id van de bovenliggende beheergroep.
ErrorDetails

De details van de fout.
ErrorResponse

Het foutobject.
Permissions

De gebruikers hebben specifieke machtigingen voor dit item.

EntityInfo

Object

De entiteit.

Name Type Description
id

string

De volledig gekwalificeerde id voor de entiteit. Bijvoorbeeld /providers/Microsoft.Management/managementGroups/0000000-00000-0000-0000-000000000
name

string

De naam van de entiteit. Bijvoorbeeld: 00000000-0000-0000-0000-0000000000000
properties.displayName

string

De beschrijvende naam van de beheergroep.
properties.inheritedPermissions

Permissions

Overgenomen machtigingen
De gebruikers hebben specifieke machtigingen voor dit item.
properties.numberOfChildGroups

integer

Aantal onderliggende groepen
Het aantal onderliggende items is het aantal groepen dat precies één niveau onder de huidige groep ligt.
properties.numberOfChildren

integer

Aantal kinderen
Het aantal onderliggende items is het aantal groepen en abonnementen dat precies één niveau onder de huidige groep ligt.
properties.numberOfDescendants

integer

Aantal afstammelingen
properties.parent

EntityParentGroupInfo

Ouder
(Optioneel) De id van de bovenliggende beheergroep.
properties.parentDisplayNameChain

string[]

De bovenliggende weergavenaamketen van de hoofdgroep naar de directe bovenliggende groep
properties.parentNameChain

string[]

De bovenliggende naamketen van de hoofdgroep naar de directe bovenliggende groep
properties.permissions

Permissions

Machtigingen
De gebruikers hebben specifieke machtigingen voor dit item.
properties.tenantId

string

De AAD-tenant-id die is gekoppeld aan de entiteit. Bijvoorbeeld: 00000000-0000-0000-0000-0000000000000
type

string

Het type resource. Bijvoorbeeld Microsoft.Management/managementGroups

EntityListResult

Object

Beschrijft het resultaat van de aanvraag om entiteiten weer te geven.

Name Type Description
count

integer

Totaal aantal records dat overeenkomt met het filter
nextLink

string

De URL die moet worden gebruikt voor het ophalen van de volgende set resultaten.
value

EntityInfo[]

De lijst met entiteiten.

EntityParentGroupInfo

Object

(Optioneel) De id van de bovenliggende beheergroep.

Name Type Description
id

string

De volledig gekwalificeerde id voor de bovenliggende beheergroep. Bijvoorbeeld /providers/Microsoft.Management/managementGroups/0000000-00000-0000-0000-000000000

ErrorDetails

Object

De details van de fout.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.
details

string

Een leesbare weergave van de details van de fout.
message

string

Een leesbare weergave van de fout.

ErrorResponse

Object

Het foutobject.

Name Type Description
error

ErrorDetails

Fout
De details van de fout.

Permissions

Inventarisatie

De gebruikers hebben specifieke machtigingen voor dit item.

Waarde Description
noaccess
view
edit
delete