Partager via

EntitiesOperations Classe

  • Référence

Opérations EntitiesOperations.

Vous ne devez pas instancier cette classe directement. Au lieu de cela, vous devez créer une instance cliente qui l’instancie pour vous et l’attache en tant qu’attribut.

Héritage
builtins.object
EntitiesOperations

Constructeur

EntitiesOperations(client, config, serializer, deserializer)

Paramètres

client
Obligatoire

Client pour les demandes de service.

config
Obligatoire

Configuration du client de service.

serializer
Obligatoire

Sérialiseur de modèle objet.

deserializer
Obligatoire

Désérialiseur de modèle objet.

Variables

models

Alias pour les classes de modèle utilisées dans ce groupe d’opérations.

Méthodes

list

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

list

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

list(skiptoken: str | None = None, skip: int | None = None, top: int | None = None, select: str | None = None, search: str | '_models.Enum2' | None = None, filter: str | None = None, view: str | '_models.Enum3' | None = None, group_name: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> Iterable['_models.EntityListResult']

Paramètres

skiptoken
str
valeur par défaut: None

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.

skip
int
valeur par défaut: None

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

top
int
valeur par défaut: None

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

select
str
valeur par défaut: None

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
str ou Enum2
valeur par défaut: None

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.

filter
str
valeur par défaut: None

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.

view
str ou Enum3
valeur par défaut: None

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

group_name
str
valeur par défaut: None

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

cache_control
str
valeur par défaut: no-cache

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

cls
callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Itérateur comme une instance d’EntityListResult ou le résultat de cls(response)

Type de retour

ItemPaged[EntityListResult]

Exceptions

HttpResponseError

Attributs

models 

models = <module 'azure.mgmt.managementgroups.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\managementgroups\\models\\__init__.py'>