Partager via


EntitiesOperationsExtensions.ListAsync Méthode

Définition

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

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>> ListAsync (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken = default, int? skip = default, int? top = default, string select = default, string search = default, string filter = default, string view = default, string groupName = default, string cacheControl = "no-cache", System.Threading.CancellationToken cancellationToken = default);
static member ListAsync : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>>
<Extension()>
Public Function ListAsync (operations As IEntitiesOperations, Optional skiptoken As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional select As String = Nothing, Optional search As String = Nothing, Optional filter As String = Nothing, Optional view As String = Nothing, Optional groupName As String = Nothing, Optional cacheControl As String = "no-cache", Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of EntityInfo))

Paramètres

operations
IEntitiesOperations

Groupe d’opérations pour cette méthode d’extension.

skiptoken
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.

skip
Nullable<Int32>

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.

top
Nullable<Int32>

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.

select
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.

search
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. Les valeurs possibles sont les suivantes : « AllowedParents », « AllowedChildren », « ParentAndFirstLevelChildren », « ParentOnly », « ChildrenOnly »

filter
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.

view
String

Le paramètre view permet aux clients de filtrer le type de données retournées par l’appel getEntities. Les valeurs possibles sont les suivantes : « FullHierarchy », « GroupsOnly », « SubscriptionsOnly », « Audit »

groupName
String

Filtre qui permet à l’appel d’entités get de se concentrer sur un groupe particulier (par exemple, « $filter=name eq 'groupName' »)

cacheControl
String

Indique si la requête doit utiliser des caches. Remplissez l’en-tête avec la valeur « no-cache » pour contourner les caches existants.

cancellationToken
CancellationToken

Jeton d'annulation.

Retours

S’applique à