通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

EntitiesOperations 类

  • 参考

EntitiesOperations 操作。

不应直接实例化此类。 相反，应创建一个客户端实例来实例化它，并将其作为属性附加。

继承
builtins.object
EntitiesOperations

构造函数

EntitiesOperations(client, config, serializer, deserializer)

参数

client
必需

服务请求的客户端。

config
必需

服务客户端的配置。

serializer
必需

对象模型序列化程序。

deserializer
必需

对象模型反序列化程序。

变量

models

此操作组中使用的模型类的别名。

方法

list

列出已通过身份验证的用户的所有实体（管理组、订阅等）。

list

列出已通过身份验证的用户的所有实体（管理组、订阅等）。

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']

参数

skiptoken
str
默认值: None

仅当上一个操作返回部分结果时，才使用页面延续标记。 如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个标记参数，该参数指定要用于后续调用的起点。

skip
int
默认值: None

检索结果时要跳过的实体数。 传入此项将覆盖$skipToken。

top
int
默认值: None

检索结果时要返回的元素数。 传入此项将覆盖$skipToken。

select
str
默认值: None

此参数指定要包含在响应中的字段。 可以包括 Name、DisplayName、Type、ParentDisplayNameChain、ParentChain 的任意组合，例如“$select=Name，DisplayName，Type，ParentDisplayNameChain，ParentNameChain”。 指定后，$select参数可以替代$skipToken中的选择。

search
str 或 Enum2
默认值: None

$search 参数与 $filter 参数结合使用，根据传入的参数返回三个不同的输出。 使用 $search=AllowedParents 时，API 将返回请求的实体能够根据用户权限确定的所有组的实体信息。 使用 $search=AllowedChildren，API 将返回可添加为所请求实体子级的所有实体的实体信息。 使用 $search=ParentAndFirstLevelChildren，API 将返回父级和第一级子级，用户有权直接访问或通过其一个后代间接访问。 使用 $search=ParentOnly 时，如果用户至少有权访问该组的一个后代，则 API 将仅返回该组。 使用 $search=ChildrenOnly 时，API 将仅返回$filter中指定的组实体信息的第一级子级。 用户必须具有对子实体或其子实体之一的直接访问权限，才能显示在结果中。

filter
str
默认值: None

使用 filter 参数可以筛选名称字段或显示名称字段。 可以检查名称字段 (例如名称 eq“{entityName}”) 的相等性，并且可以检查名称字段或显示名称字段的子字符串 (例如，包含 (名称、“{substringToSearch}”) 、contains (displayName、“{substringToSearch”) ) 。 请注意，“{entityName}”和“{substringToSearch}”字段不区分大小写。

view
str 或 Enum3
默认值: None

view 参数允许客户端筛选 getEntities 调用返回的数据类型。

group_name
str
默认值: None

一个筛选器，允许获取实体调用专注于特定组 (即“$filter=name eq 'groupName'”) 。

cache_control
str
默认值: no-cache

指示请求是否应利用任何缓存。 使用“no-cache”值填充标头以绕过现有缓存。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器，如 EntityListResult 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[EntityListResult]

例外

HttpResponseError

属性

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'>