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

ManagementGroups interface

包:

@azure/arm-managementgroups

表示 ManagementGroups 的接口。

方法

beginCreateOrUpdate(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)	创建或更新管理组。 如果已创建管理组，并且发出具有不同属性的后续创建请求，则会更新管理组属性。
beginCreateOrUpdateAndWait(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)	创建或更新管理组。 如果已创建管理组，并且发出具有不同属性的后续创建请求，则会更新管理组属性。
beginDelete(string, ManagementGroupsDeleteOptionalParams)	删除管理组。 如果管理组包含子资源，则请求将失败。
beginDeleteAndWait(string, ManagementGroupsDeleteOptionalParams)	删除管理组。 如果管理组包含子资源，则请求将失败。
get(string, ManagementGroupsGetOptionalParams)	获取管理组的详细信息。
list(ManagementGroupsListOptionalParams)	列出已通过身份验证的用户的管理组。
listDescendants(string, ManagementGroupsGetDescendantsOptionalParams)	列出从管理组降序的所有实体。
update(string, PatchManagementGroupRequest, ManagementGroupsUpdateOptionalParams)	更新管理组。

方法详细信息

beginCreateOrUpdate(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ManagementGroup>, ManagementGroup>>

参数

groupId

string

管理组 ID。

createManagementGroupRequest

CreateManagementGroupRequest

管理组创建参数。

options

ManagementGroupsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<PollerLike<PollOperationState<ManagementGroup>, ManagementGroup>>

beginCreateOrUpdateAndWait(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams): Promise<ManagementGroup>

参数

groupId

string

管理组 ID。

createManagementGroupRequest

CreateManagementGroupRequest

管理组创建参数。

options

ManagementGroupsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<ManagementGroup>

beginDelete(string, ManagementGroupsDeleteOptionalParams)

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

function beginDelete(groupId: string, options?: ManagementGroupsDeleteOptionalParams): Promise<PollerLike<PollOperationState<ManagementGroupsDeleteResponse>, ManagementGroupsDeleteResponse>>

参数

groupId

string

管理组 ID。

options

ManagementGroupsDeleteOptionalParams

选项参数。

返回

Promise<PollerLike<PollOperationState<ManagementGroupsDeleteResponse>, ManagementGroupsDeleteResponse>>

beginDeleteAndWait(string, ManagementGroupsDeleteOptionalParams)

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

function beginDeleteAndWait(groupId: string, options?: ManagementGroupsDeleteOptionalParams): Promise<ManagementGroupsDeleteResponse>

参数

groupId

string

管理组 ID。

options

ManagementGroupsDeleteOptionalParams

选项参数。

返回

Promise<ManagementGroupsDeleteResponse>

get(string, ManagementGroupsGetOptionalParams)

获取管理组的详细信息。

function get(groupId: string, options?: ManagementGroupsGetOptionalParams): Promise<ManagementGroup>

参数

groupId

string

管理组 ID。

options

ManagementGroupsGetOptionalParams

选项参数。

返回

Promise<ManagementGroup>

list(ManagementGroupsListOptionalParams)

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

function list(options?: ManagementGroupsListOptionalParams): PagedAsyncIterableIterator<ManagementGroupInfo, ManagementGroupInfo[], PageSettings>

参数

options

ManagementGroupsListOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<ManagementGroupInfo, ManagementGroupInfo[], PageSettings>

listDescendants(string, ManagementGroupsGetDescendantsOptionalParams)

列出从管理组降序的所有实体。

function listDescendants(groupId: string, options?: ManagementGroupsGetDescendantsOptionalParams): PagedAsyncIterableIterator<DescendantInfo, DescendantInfo[], PageSettings>

参数

groupId

string

管理组 ID。

options

ManagementGroupsGetDescendantsOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<DescendantInfo, DescendantInfo[], PageSettings>

update(string, PatchManagementGroupRequest, ManagementGroupsUpdateOptionalParams)

更新管理组。

function update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, options?: ManagementGroupsUpdateOptionalParams): Promise<ManagementGroup>

参数

groupId

string

管理组 ID。

patchGroupRequest

PatchManagementGroupRequest

管理组修补程序参数。

options

ManagementGroupsUpdateOptionalParams

选项参数。

返回

Promise<ManagementGroup>