ManagementGroupsOperations interface

Interface representing a ManagementGroups operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate

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.

delete

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

get

Get the details of the management group.

list

List management groups for the authenticated user.

listDescendants

List all entities that descend from a management group.

update

Update a management group.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ManagementGroup>, ManagementGroup>>

Property Value

(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ManagementGroup>, ManagementGroup>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (groupId: string, options?: ManagementGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(groupId: string, options?: ManagementGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (groupId: string, options?: ManagementGroupsDeleteOptionalParams) => Promise<void>

Property Value

(groupId: string, options?: ManagementGroupsDeleteOptionalParams) => Promise<void>

createOrUpdate

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.

createOrUpdate: (groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ManagementGroup>, ManagementGroup>

Property Value

(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: ManagementGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ManagementGroup>, ManagementGroup>

delete

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

delete: (groupId: string, options?: ManagementGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(groupId: string, options?: ManagementGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the details of the management group.

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

Property Value

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

list

List management groups for the authenticated user.

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

Property Value

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

listDescendants

List all entities that descend from a management group.

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

Property Value

(groupId: string, options?: ManagementGroupsListDescendantsOptionalParams) => PagedAsyncIterableIterator<DescendantInfo, DescendantInfo[], PageSettings>

update

Update a management group.

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

Property Value

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