通过

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

ManagementGroupsOperations 类

  • 参考

ManagementGroupsOperations 操作。

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

继承
builtins.object
ManagementGroupsOperations

构造函数

ManagementGroupsOperations(client, config, serializer, deserializer)

参数

client
必需

用于服务请求的客户端。

config
必需

服务客户端的配置。

serializer
必需

对象模型序列化程序。

deserializer
必需

对象模型反序列化程序。

变量

models

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

方法

begin_create_or_update

创建或更新管理组。 如果已创建管理组，并且发出具有不同属性的后续创建请求，则会更新管理组属性。
begin_delete

删除管理组。 如果管理组包含子资源，请求将失败。
get

获取管理组的详细信息。
get_descendants

列出来自管理组的所有实体。
list

列出已通过身份验证的用户的管理组。
update

更新管理组。

begin_create_or_update

创建或更新管理组。 如果已创建管理组，并且发出具有不同属性的后续创建请求，则会更新管理组属性。

begin_create_or_update(group_id: str, create_management_group_request: '_models.CreateManagementGroupRequest', cache_control: str | None = 'no-cache', **kwargs: Any) -> LROPoller['_models.ManagementGroup' | '_models.AzureAsyncOperationResults']

参数

group_id
str
必需

管理组 ID。

create_management_group_request
CreateManagementGroupRequest
必需

管理组创建参数。

cache_control
str
默认值: no-cache

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

cls
callable

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

continuation_token
str

用于从保存状态重启轮询的继续标记。

polling
bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

返回 ManagementGroup 或 cls 的结果的 LROPoller 实例， (响应)

返回类型

LROPoller[ManagementGroup]

例外

HttpResponseError

begin_delete

删除管理组。 如果管理组包含子资源，请求将失败。

begin_delete(group_id: str, cache_control: str | None = 'no-cache', **kwargs: Any) -> LROPoller['_models.AzureAsyncOperationResults']

参数

group_id
str
必需

管理组 ID。

cache_control
str
默认值: no-cache

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

cls
callable

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

continuation_token
str

用于从保存状态重启轮询的继续标记。

polling
bool 或 PollingMethod

默认情况下，轮询方法将为 ARMPolling。 将此操作传入 False 以不进行轮询，或为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有Retry-After标头，则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例，返回 AzureAsyncOperationResults 或 cls (响应的结果)

返回类型

LROPoller[AzureAsyncOperationResults]

例外

HttpResponseError

get

获取管理组的详细信息。

get(group_id: str, expand: str | '_models.Enum0' | None = None, recurse: bool | None = None, filter: str | None = None, cache_control: str | None = 'no-cache', **kwargs: Any) -> _models.ManagementGroup

参数

group_id
str
必需

管理组 ID。

expand
str 或 Enum0
默认值: None

$expand=children 查询字符串参数允许客户端请求在响应有效负载中包含子级。 $expand=path 包括从根组到当前组的路径。 $expand=ancestors 包括当前组的上级 ID。

recurse
bool
默认值: None

$recurse=true 查询字符串参数允许客户端请求在响应有效负载中包含整个层次结构。 请注意，如果$recurse设置为 true，则必须传递$expand=children。

filter
str
默认值: None

一个筛选器，允许从结果中排除订阅 (，即“$filter=children.childType ne Subscription”) 。

cache_control
str
默认值: no-cache

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

cls
callable

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

返回

ManagementGroup 或 cls 的结果 (响应)

返回类型

ManagementGroup

例外

HttpResponseError

get_descendants

列出来自管理组的所有实体。

get_descendants(group_id: str, skiptoken: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable['_models.DescendantListResult']

参数

group_id
str
必需

管理组 ID。

skiptoken
str
默认值: None

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

top
int
默认值: None

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

cls
callable

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

返回

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

返回类型

ItemPaged[DescendantListResult]

例外

HttpResponseError

list

列出已通过身份验证的用户的管理组。

list(cache_control: str | None = 'no-cache', skiptoken: str | None = None, **kwargs: Any) -> Iterable['_models.ManagementGroupListResult']

参数

cache_control
str
默认值: no-cache

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

skiptoken
str
默认值: None

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

cls
callable

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

返回

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

返回类型

ItemPaged[ManagementGroupListResult]

例外

HttpResponseError

update

更新管理组。

update(group_id: str, patch_group_request: '_models.PatchManagementGroupRequest', cache_control: str | None = 'no-cache', **kwargs: Any) -> _models.ManagementGroup

参数

group_id
str
必需

管理组 ID。

patch_group_request
PatchManagementGroupRequest
必需

管理组修补程序参数。

cache_control
str
默认值: no-cache

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

cls
callable

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

返回

ManagementGroup 或 cls 的结果 (响应)

返回类型

ManagementGroup

例外

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