Share via

EntitiesOperations Class

  • Reference

EntitiesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
EntitiesOperations

Constructor

EntitiesOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

list

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

list

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

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

Parameters

Name Description
skiptoken
str

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

Default value: None
skip
int

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

Default value: None
top
int

Number of elements to return when retrieving results. Passing this in will override $skipToken.

Default value: None
select
str

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

Default value: None
search
str or Enum2

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

Default value: None
filter
str

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

Default value: None
view
str or Enum3

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

Default value: None
group_name
str

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'").

Default value: None
cache_control
str

Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches.

Default value: no-cache

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[EntityListResult]

An iterator like instance of either EntityListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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