EntitiesListOptionalParams interface

Paquet:

@azure/arm-managementgroups

Paramètres facultatifs.

Extends

OperationOptions

Propriétés

cacheControl	Indique si la demande doit utiliser des caches. Renseignez l’en-tête avec la valeur « no-cache » pour contourner les caches existants.
filter	Le paramètre filter vous permet de filtrer sur les champs nom ou nom d’affichage. Vous pouvez vérifier l’égalité dans le champ de nom (par exemple, name eq « {entityName} ») et vous pouvez rechercher des 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.
groupName	Filtre qui permet à l’appel d’entités get de se concentrer sur un groupe particulier (par exemple, « $filter=name eq 'groupName' »)
search	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.
select	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.
skip	Nombre d’entités à ignorer lors de la récupération des résultats. La transmission de ce paramètre remplace $skipToken.
skiptoken	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.
top	Nombre d’éléments à retourner lors de la récupération des résultats. La transmission de ce paramètre remplace $skipToken.
view	Le paramètre view permet aux clients de filtrer le type de données retournées par l’appel getEntities.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour annuler les demandes.
onResponse	Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions	Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
serializerOptions	Options permettant de remplacer le comportement de sérialisation/dés sérialisation.
tracingOptions	Options utilisées lorsque le suivi est activé.

Détails de la propriété

cacheControl

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

cacheControl?: string

Valeur de propriété

string

filter

Le paramètre filter vous permet de filtrer sur les champs nom ou nom d’affichage. Vous pouvez vérifier l’égalité dans le champ de nom (par exemple, name eq « {entityName} ») et vous pouvez rechercher des 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.

filter?: string

Valeur de propriété

string

groupName

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

groupName?: string

Valeur de propriété

string

search

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.

search?: string

Valeur de propriété

string

select

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.

select?: string

Valeur de propriété

string

skip

Nombre d’entités à ignorer lors de la récupération des résultats. La transmission de ce paramètre remplace $skipToken.

skip?: number

Valeur de propriété

number

skiptoken

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.

skiptoken?: string

Valeur de propriété

string

top

Nombre d’éléments à retourner lors de la récupération des résultats. La transmission de ce paramètre remplace $skipToken.

top?: number

Valeur de propriété

number

view

Le paramètre view permet aux clients de filtrer le type de données retournées par l’appel getEntities.

view?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour annuler les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de coreClient.OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

Hérité de coreClient.OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

Hérité de coreClient.OperationOptions.requestOptions

serializerOptions

Options permettant de remplacer le comportement de sérialisation/dés sérialisation.

serializerOptions?: SerializerOptions

Valeur de propriété

SerializerOptions

Hérité de coreClient.OperationOptions.serializerOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de coreClient.OperationOptions.tracingOptions