Entities - List

Référence

Service:: Management Groups

Version d'API:: 2020-05-01

Affiche toutes les entités (groupes d’administration, abonnements, etc.) pour l’utilisateur authentifié.

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

Avec des paramètres facultatifs:

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API à utiliser avec la demande du client. La version actuelle est 2018-01-01-preview.
$filter	query		string	Le paramètre filter vous permet de filtrer sur les champs nom ou nom d’affichage. Vous pouvez case activée d’égalité sur le champ de nom (par exemple, name eq « {entityName} ») et vous pouvez case activée pour les sous-chaînes sur les champs name ou display name (par exemple contains(name, « {substringToSearch} »), contains(displayName, « {substringToSearch ») ). Notez que les champs « {entityName} » et « {substringToSearch} » ne respectent pas la casse.
$search	query		string	Le paramètre $search est utilisé conjointement avec le paramètre $filter pour retourner trois sorties différentes en fonction du paramètre transmis. Avec $search=AllowedParents, l’API retourne les informations d’entité de tous les groupes auxquels l’entité demandée sera en mesure de réparer en fonction des autorisations de l’utilisateur. Avec $search=AllowedChildren, l’API retourne les informations d’entité de toutes les entités qui peuvent être ajoutées en tant qu’enfants de l’entité demandée. Avec $search=ParentAndFirstLevelChildren, l’API retourne le parent et le premier niveau d’enfants auxquels l’utilisateur a un accès direct ou indirect via l’un de leurs descendants. Avec $search=ParentOnly, l’API retourne uniquement le groupe si l’utilisateur a accès à au moins l’un des descendants du groupe. Avec $search=ChildrenOnly, l’API retourne uniquement le premier niveau d’enfants des informations d’entité de groupe spécifiées dans $filter. L’utilisateur doit avoir un accès direct aux entités enfants ou à l’un de ses descendants pour qu’il s’affiche dans les résultats.
$select	query		string	Ce paramètre spécifie les champs à inclure dans la réponse. Peut inclure n’importe quelle combinaison de Nom,DisplayName,Type,ParentDisplayNameChain,ParentChain, par exemple '$select=Name,DisplayName,Type,ParentDisplayNameChain'. Lorsqu’il est spécifié, le paramètre $select peut remplacer select dans $skipToken.
$skip	query		integer	Nombre d’entités à ignorer lors de la récupération des résultats. La transmission de ce paramètre a pour effet de remplacer $skipToken.
$skiptoken	query		string	Le jeton de continuation de page est utilisé uniquement si une opération précédente a retourné un résultat partiel. Si une réponse précédente contient un élément nextLink, la valeur de l’élément nextLink inclut un paramètre de jeton qui spécifie un point de départ à utiliser pour les appels suivants.
$top	query		integer	Nombre d’éléments à retourner lors de la récupération des résultats. La transmission de ce paramètre a pour effet de remplacer $skipToken.
$view	query		string	Le paramètre view permet aux clients de filtrer le type de données retournées par l’appel getEntities.
groupName	query		string	Filtre qui permet à l’appel d’entités get de se concentrer sur un groupe particulier (par exemple, « $filter=name eq 'groupName' »)

En-tête de la demande

Nom	Obligatoire	Type	Description
Cache-Control		string	Indique que la requête ne doit pas utiliser de caches.

Réponses

Nom	Type	Description
200 OK	EntityListResult	Ok
Other Status Codes	ErrorResponse	Erreur

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

GetEntities

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
}

Définitions

Nom	Description
EntityInfo	Entité.
EntityListResult	Décrit le résultat de la demande d’affichage des entités.
EntityParentGroupInfo	(Facultatif) ID du groupe d’administration parent.
ErrorDetails	Détails de l’erreur.
ErrorResponse	Objet error.
Permissions	Autorisations spécifiques aux utilisateurs pour cet élément.

EntityInfo

Entité.

Nom	Type	Description
id	string	ID complet de l’entité. Par exemple, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000
name	string	Nom de l'entité. Par exemple, 00000000-0000-0000-0000-00000000000
properties.displayName	string	Nom convivial du groupe d’administration.
properties.inheritedPermissions	Permissions	Autorisations héritées Autorisations spécifiques aux utilisateurs pour cet élément.
properties.numberOfChildGroups	integer	Nombre de groupes enfants Nombre d’enfants est le nombre de groupes qui se trouvent exactement un niveau sous le groupe actuel.
properties.numberOfChildren	integer	Nombre d’enfants Nombre d’enfants est le nombre de groupes et d’abonnements qui se trouvent exactement un niveau sous le groupe actuel.
properties.numberOfDescendants	integer	Nombre de descendants
properties.parent	EntityParentGroupInfo	Parent (Facultatif) ID du groupe d’administration parent.
properties.parentDisplayNameChain	string[]	Chaîne de noms d’affichage parent du groupe racine vers le parent immédiat
properties.parentNameChain	string[]	Chaîne de noms parent du groupe racine vers le parent immédiat
properties.permissions	Permissions	Autorisations Autorisations spécifiques aux utilisateurs pour cet élément.
properties.tenantId	string	ID de locataire AAD associé à l’entité. Par exemple, 00000000-0000-0000-0000-00000000000
type	string	Type de la ressource. Par exemple, Microsoft.Management/managementGroups

EntityListResult

Décrit le résultat de la demande d’affichage des entités.

Nom	Type	Description
count	integer	Nombre total d’enregistrements qui correspondent au filtre
nextLink	string	URL à utiliser pour obtenir l’ensemble de résultats suivant.
value	EntityInfo[]	Liste des entités.

EntityParentGroupInfo

(Facultatif) ID du groupe d’administration parent.

Nom	Type	Description
id	string	ID complet du groupe d’administration parent. Par exemple, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-00000000000

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
details	string	Représentation lisible des détails de l’erreur.
message	string	Représentation lisible de l’erreur.

ErrorResponse

Objet error.

Nom	Type	Description
error	ErrorDetails	Erreur Détails de l’erreur.

Permissions

Autorisations spécifiques aux utilisateurs pour cet élément.

Nom	Type	Description
delete	string
edit	string
noaccess	string
view	string

Partager via