IEntitiesOperations.ListWithHttpMessagesAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Affiche toutes les entités (groupes d’administration, abonnements, etc.) pour l’utilisateur authentifié.
public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>>> ListWithHttpMessagesAsync (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.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListWithHttpMessagesAsync : string * Nullable<int> * Nullable<int> * string * string * string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>>>
Public Function ListWithHttpMessagesAsync (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 customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of EntityInfo)))
Paramètres
- skiptoken
- String
Le jeton de continuation de page n’est utilisé que 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.
Nombre d’entités à ignorer lors de la récupération des résultats. La transmission de ce paramètre remplace $skipToken.
Nombre d’éléments à retourner lors de la récupération des résultats. La transmission de ce paramètre remplace $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,ParentNameChain'. Lorsqu’il est spécifié, le paramètre $select peut remplacer la sélection 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 dispose d’un accès direct ou d’un accès indirect via l’un de ses descendants. Avec $search=ParentOnly, l’API retourne uniquement le groupe si l’utilisateur a accès à au moins 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 pour l’é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 de nom ou de nom d’affichage (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 demande doit utiliser des caches. Renseignez l’en-tête avec la valeur « no-cache » pour contourner les caches existants.
- customHeaders
- Dictionary<String,List<String>>
En-têtes qui seront ajoutés à la demande.
- cancellationToken
- CancellationToken
Jeton d'annulation.
Retours
Exceptions
Levée lorsque l’opération a retourné un code de status non valide
Levée en cas d’impossibilité de désérialiser la réponse
Levée lorsqu’un paramètre obligatoire a la valeur Null
S’applique à
Azure SDK for .NET