Entities - List

Elenca tutte le entità, ovvero gruppi di gestione, sottoscrizioni e così via, per l'utente autenticato.

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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
api-version
query True

string

Versione dell'API da usare con la richiesta client. La versione corrente è 2018-01-01-preview.

$filter
query

string

Il parametro filtro consente di filtrare sui campi nome o nome visualizzato. È possibile verificare l'uguaglianza nel campo nome (ad esempio nome eq '{entityName}') ed è possibile verificare la presenza di sottostringa nei campi nome o nome visualizzato(ad esempio contains(name, '{substringToSearch}'), contains({substringToSearch}'), contains(displayName, '{substringToSearch'). Si noti che i campi '{entityName}' e '{substringToSearch}' vengono controllati in modo insensibile.

$search
query

string

Il parametro $search viene usato insieme al parametro $filter per restituire tre output diversi a seconda del parametro passato. Con $search=AllowedParents l'API restituirà le informazioni sull'entità di tutti i gruppi che l'entità richiesta sarà in grado di eseguire la replica come determinato dalle autorizzazioni dell'utente. Con $search=AllowedChildren l'API restituirà le informazioni sull'entità di tutte le entità che possono essere aggiunte come elementi figlio dell'entità richiesta. Con $search=ParentAndFirstLevelChildren, l'API restituirà l'elemento padre e il primo livello di figlio a cui l'utente ha accesso diretto o indiretto tramite uno dei discendenti. Con $search=ParentOnly l'API restituirà solo il gruppo se l'utente ha accesso a almeno uno dei discendenti del gruppo. Con $search=ChildrenOnly l'API restituirà solo il primo livello di elementi figlio delle informazioni sull'entità del gruppo specificate in $filter. L'utente deve avere accesso diretto alle entità figlio o uno dei discendenti per visualizzare i risultati.

$select
query

string

Questo parametro specifica i campi da includere nella risposta. Può includere qualsiasi combinazione di Nome,DisplayName,Type,ParentDisplayNameChain,ParentChain, ad esempio '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando è stato specificato il parametro $select può eseguire l'override della selezione in $skipToken.

$skip
query

integer

Numero di entità da ignorare durante il recupero dei risultati. Il passaggio in eseguirà l'override di $skipToken.

$skiptoken
query

string

Il token di continuazione della pagina viene usato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro token che specifica un punto di partenza da usare per le chiamate successive.

$top
query

integer

Numero di elementi da restituire durante il recupero dei risultati. Il passaggio in eseguirà l'override di $skipToken.

$view
query

string

Il parametro di visualizzazione consente ai client di filtrare il tipo di dati restituiti dalla chiamata getEntities.

groupName
query

string

Filtro che consente alle entità di ottenere entità di concentrarsi su un determinato gruppo (ad esempio "$filter=name eq 'groupName'")

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Cache-Control

string

Indica che la richiesta non deve usare cache.

Risposte

Nome Tipo Descrizione
200 OK

EntityListResult

OK

Other Status Codes

ErrorResponse

Errore

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

GetEntities

Esempio di richiesta

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

Risposta di esempio

{
  "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
}

Definizioni

Nome Descrizione
EntityInfo

Entità.

EntityListResult

Descrive il risultato della richiesta per visualizzare le entità.

EntityParentGroupInfo

(Facoltativo) ID del gruppo di gestione padre.

ErrorDetails

Dettagli dell'errore.

ErrorResponse

Oggetto error.

Permissions

Gli utenti hanno autorizzazioni specifiche per questo elemento.

EntityInfo

Entità.

Nome Tipo Descrizione
id

string

ID completo per l'entità. Ad esempio, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000

name

string

Il nome dell'entità. Ad esempio, 000000000-0000-0000-0000-0000000000000000

properties.displayName

string

Nome descrittivo del gruppo di gestione.

properties.inheritedPermissions

Permissions

Autorizzazioni ereditate
Gli utenti hanno autorizzazioni specifiche per questo elemento.

properties.numberOfChildGroups

integer

Numero di gruppi figlio
Il numero di elementi figlio è il numero di gruppi che sono esattamente un livello inferiore al gruppo corrente.

properties.numberOfChildren

integer

Numero di figli
Il numero di elementi figlio è il numero di gruppi e sottoscrizioni esattamente uno sotto il gruppo corrente.

properties.numberOfDescendants

integer

Numero di discendenti

properties.parent

EntityParentGroupInfo

Parent
(Facoltativo) ID del gruppo di gestione padre.

properties.parentDisplayNameChain

string[]

Catena di nomi visualizza padre dal gruppo radice all'elemento padre immediato

properties.parentNameChain

string[]

Catena di nomi padre dal gruppo radice all'elemento padre immediato

properties.permissions

Permissions

Autorizzazioni
Gli utenti hanno autorizzazioni specifiche per questo elemento.

properties.tenantId

string

ID tenant AAD associato all'entità. Ad esempio, 000000000-0000-0000-0000-0000000000000000

type

string

Tipo di risorsa. Ad esempio, Microsoft.Management/managementGroups

EntityListResult

Descrive il risultato della richiesta per visualizzare le entità.

Nome Tipo Descrizione
count

integer

Numero totale di record corrispondenti al filtro

nextLink

string

URL da usare per ottenere il set successivo di risultati.

value

EntityInfo[]

Elenco di entità.

EntityParentGroupInfo

(Facoltativo) ID del gruppo di gestione padre.

Nome Tipo Descrizione
id

string

ID completo per il gruppo di gestione padre. Ad esempio, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000000

ErrorDetails

Dettagli dell'errore.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.

details

string

Rappresentazione leggibile dei dettagli dell'errore.

message

string

Rappresentazione leggibile dell'errore.

ErrorResponse

Oggetto error.

Nome Tipo Descrizione
error

ErrorDetails

Errore
Dettagli dell'errore.

Permissions

Gli utenti hanno autorizzazioni specifiche per questo elemento.

Nome Tipo Descrizione
delete

string

edit

string

noaccess

string

view

string