Entities - List

Referentie

Service:: Management Groups

API-versie:: 2020-05-01

Alle entiteiten (beheergroepen, abonnementen, enzovoort) voor de geverifieerde gebruiker weergeven.

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 velden naam of weergavenaam. U kunt controleren op gelijkheid in het naamveld (bijvoorbeeld name eq '{entityName}') en u kunt controleren op subtekenreeksen in de naam- of weergavenaamvelden (bijvoorbeeld contains(name, {substringToSearch}), contains(displayName, {substringToSearch)). Houd er rekening mee dat de velden {entityName} en {substringToSearch} hoofdlettergevoelig zijn gecontroleerd.
$search	query		string	De parameter $search wordt gebruikt in combinatie met de parameter $filter om drie verschillende uitvoerwaarden te retourneren, afhankelijk van de doorgegeven parameter. Met $search=AllowedParents retourneert de API de entiteitsgegevens van alle groepen waarvoor de aangevraagde entiteit opnieuw kan worden gebruikt, zoals bepaald door de machtigingen van de gebruiker. Met $search=AllowedChildren retourneert de API de entiteitsgegevens van alle entiteiten die kunnen worden toegevoegd als onderliggende elementen van de aangevraagde entiteit. Met $search=ParentAndFirstLevelChildren retourneert de API het bovenliggende en eerste niveau van onderliggende elementen waartoe de gebruiker directe toegang heeft of indirecte toegang via een van de onderliggende elementen. Met $search=ParentOnly retourneert de API alleen de groep als de gebruiker toegang heeft tot ten minste één van de onderliggenden van de groep. Met $search=ChildrenOnly retourneert de API alleen het eerste niveau van onderliggende gegevens van de groepsentiteit die zijn opgegeven in $filter. De gebruiker moet directe toegang hebben tot de onderliggende entiteiten of een van de onderliggende entiteiten voordat deze wordt weergegeven in de resultaten.
$select	query		string	Deze parameter geeft de velden op die moeten worden opgenomen in het antwoord. Kan elke combinatie van Name,DisplayName,Type,ParentDisplayNameChain,ParentChain bevatten, bijvoorbeeld '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Wanneer u de $select parameter opgeeft, kan de selectie in $skipToken worden overschreven.
$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 token voor paginavervolging wordt alleen gebruikt als een eerdere bewerking een gedeeltelijk resultaat heeft geretourneerd. Als een eerder antwoord een nextLink-element bevat, bevat de waarde van het element nextLink een tokenparameter die een beginpunt aangeeft dat moet worden gebruikt voor volgende aanroepen.
$top	query		integer	Het 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 getEntities.
groupName	query		string	Een filter waarmee de aanroep get-entiteiten zich kan richten op een bepaalde groep (dat wil zeggen '$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

Azure Active Directory OAuth2-stroom.

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

GetEntities

Voorbeeldaanvraag

HTTP

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

De entiteit.

Name	Type	Description
id	string	De volledig gekwalificeerde id voor de entiteit. Bijvoorbeeld /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-0000000000000
name	string	De naam van de entiteit. Bijvoorbeeld 000000000-0000-0000-0000-000000000000000
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 Aantal onderliggende elementen is het aantal groepen dat zich precies één niveau onder de huidige groep bevindt.
properties.numberOfChildren	integer	Aantal kinderen Aantal onderliggende elementen is het aantal groepen en abonnementen dat zich precies één niveau onder de huidige groep bevindt.
properties.numberOfDescendants	integer	Aantal afstammelingen
properties.parent	EntityParentGroupInfo	Bovenliggend (Optioneel) De id van de bovenliggende beheergroep.
properties.parentDisplayNameChain	string[]	De keten van de bovenliggende weergavenaam 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 000000000-0000-0000-0000-000000000000000
type	string	Het type resource. Bijvoorbeeld Microsoft.Management/managementGroups

EntityListResult

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

(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-0000-0000-0000-0000000000000

ErrorDetails

De details van de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	string	Een door mensen leesbare weergave van de details van de fout.
message	string	Een door mensen leesbare weergave van de fout.

ErrorResponse

Het foutobject.

Name	Type	Description
error	ErrorDetails	Fout De details van de fout.

Permissions

De gebruikers hebben specifieke machtigingen voor dit item.

Name	Type	Description
delete	string
edit	string
noaccess	string
view	string

Delen via