ManagementGroups interface

Package:

@azure/arm-managementgroups

Interface representing a ManagementGroups.

Methods

beginCreateOrUpdate(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)	Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.
beginCreateOrUpdateAndWait(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)	Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.
beginDelete(string, ManagementGroupsDeleteOptionalParams)	Delete management group. If a management group contains child resources, the request will fail.
beginDeleteAndWait(string, ManagementGroupsDeleteOptionalParams)	Delete management group. If a management group contains child resources, the request will fail.
get(string, ManagementGroupsGetOptionalParams)	Get the details of the management group.
list(ManagementGroupsListOptionalParams)	List management groups for the authenticated user.
listDescendants(string, ManagementGroupsGetDescendantsOptionalParams)	List all entities that descend from a management group.
update(string, PatchManagementGroupRequest, ManagementGroupsUpdateOptionalParams)	Update a management group.

Method Details

beginCreateOrUpdate(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

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

Parameters

groupId

string

Management Group ID.

createManagementGroupRequest

CreateManagementGroupRequest

Management group creation parameters.

options

ManagementGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, CreateManagementGroupRequest, ManagementGroupsCreateOrUpdateOptionalParams)

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

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

Parameters

groupId

string

Management Group ID.

createManagementGroupRequest

CreateManagementGroupRequest

Management group creation parameters.

options

ManagementGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagementGroup>

beginDelete(string, ManagementGroupsDeleteOptionalParams)

Delete management group. If a management group contains child resources, the request will fail.

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

Parameters

groupId

string

Management Group ID.

options

ManagementGroupsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, ManagementGroupsDeleteOptionalParams)

Delete management group. If a management group contains child resources, the request will fail.

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

Parameters

groupId

string

Management Group ID.

options

ManagementGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<ManagementGroupsDeleteResponse>

get(string, ManagementGroupsGetOptionalParams)

Get the details of the management group.

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

Parameters

groupId

string

Management Group ID.

options

ManagementGroupsGetOptionalParams

The options parameters.

Returns

Promise<ManagementGroup>

list(ManagementGroupsListOptionalParams)

List management groups for the authenticated user.

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

Parameters

options

ManagementGroupsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagementGroupInfo, ManagementGroupInfo[], PageSettings>

listDescendants(string, ManagementGroupsGetDescendantsOptionalParams)

List all entities that descend from a management group.

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

Parameters

groupId

string

Management Group ID.

options

ManagementGroupsGetDescendantsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DescendantInfo, DescendantInfo[], PageSettings>

update(string, PatchManagementGroupRequest, ManagementGroupsUpdateOptionalParams)

Update a management group.

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

Parameters

groupId

string

Management Group ID.

patchGroupRequest

PatchManagementGroupRequest

Management group patch parameters.

options

ManagementGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<ManagementGroup>