ManagementGroups class

Class representing a ManagementGroups.

Constructors

ManagementGroups(ManagementGroupsAPIContext)

Create a ManagementGroups.

Methods

beginCreateOrUpdate(string, CreateManagementGroupRequest, Models.ManagementGroupsBeginCreateOrUpdateOptionalParams)

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.

beginDeleteMethod(string, Models.ManagementGroupsBeginDeleteMethodOptionalParams)

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

createOrUpdate(string, CreateManagementGroupRequest, Models.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.

deleteMethod(string, Models.ManagementGroupsDeleteMethodOptionalParams)

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

get(string, ManagementGroupsGetOptionalParams, ServiceCallback<ManagementGroup>)
get(string, Models.ManagementGroupsGetOptionalParams)

Get the details of the management group.

get(string, ServiceCallback<ManagementGroup>)
list(ManagementGroupsListOptionalParams, ServiceCallback<ManagementGroupListResult>)
list(Models.ManagementGroupsListOptionalParams)

List management groups for the authenticated user.

list(ServiceCallback<ManagementGroupListResult>)
listNext(string, ManagementGroupsListNextOptionalParams, ServiceCallback<ManagementGroupListResult>)
listNext(string, Models.ManagementGroupsListNextOptionalParams)

List management groups for the authenticated user.

listNext(string, ServiceCallback<ManagementGroupListResult>)
update(string, PatchManagementGroupRequest, ManagementGroupsUpdateOptionalParams, ServiceCallback<ManagementGroup>)
update(string, PatchManagementGroupRequest, Models.ManagementGroupsUpdateOptionalParams)

Update a management group.

update(string, PatchManagementGroupRequest, ServiceCallback<ManagementGroup>)

Constructor Details

ManagementGroups(ManagementGroupsAPIContext)

Create a ManagementGroups.

new ManagementGroups(client: ManagementGroupsAPIContext)

Parameters

client
ManagementGroupsAPIContext

Reference to the service client.

Method Details

beginCreateOrUpdate(string, CreateManagementGroupRequest, Models.ManagementGroupsBeginCreateOrUpdateOptionalParams)

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?: Models.ManagementGroupsBeginCreateOrUpdateOptionalParams)

Parameters

groupId

string

Management Group ID.

createManagementGroupRequest
CreateManagementGroupRequest

Management group creation parameters.

options
Models.ManagementGroupsBeginCreateOrUpdateOptionalParams

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod(string, Models.ManagementGroupsBeginDeleteMethodOptionalParams)

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

function beginDeleteMethod(groupId: string, options?: Models.ManagementGroupsBeginDeleteMethodOptionalParams)

Parameters

groupId

string

Management Group ID.

options
Models.ManagementGroupsBeginDeleteMethodOptionalParams

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate(string, CreateManagementGroupRequest, Models.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 createOrUpdate(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: Models.ManagementGroupsCreateOrUpdateOptionalParams)

Parameters

groupId

string

Management Group ID.

createManagementGroupRequest
CreateManagementGroupRequest

Management group creation parameters.

options
Models.ManagementGroupsCreateOrUpdateOptionalParams

Returns

Promise<Models.ManagementGroupsCreateOrUpdateResponse>

Promise<Models.ManagementGroupsCreateOrUpdateResponse>

deleteMethod(string, Models.ManagementGroupsDeleteMethodOptionalParams)

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

function deleteMethod(groupId: string, options?: Models.ManagementGroupsDeleteMethodOptionalParams)

Parameters

groupId

string

Management Group ID.

options
Models.ManagementGroupsDeleteMethodOptionalParams

Returns

Promise<Models.ManagementGroupsDeleteMethodResponse>

Promise<Models.ManagementGroupsDeleteMethodResponse>

get(string, ManagementGroupsGetOptionalParams, ServiceCallback<ManagementGroup>)

function get(groupId: string, options: ManagementGroupsGetOptionalParams, callback: ServiceCallback<ManagementGroup>)

Parameters

groupId

string

Management Group ID.

options
ManagementGroupsGetOptionalParams

The optional parameters

callback

ServiceCallback<ManagementGroup>

The callback

get(string, Models.ManagementGroupsGetOptionalParams)

Get the details of the management group.

function get(groupId: string, options?: Models.ManagementGroupsGetOptionalParams)

Parameters

groupId

string

Management Group ID.

options
Models.ManagementGroupsGetOptionalParams

Returns

Promise<Models.ManagementGroupsGetResponse>

Promise<Models.ManagementGroupsGetResponse>

get(string, ServiceCallback<ManagementGroup>)

function get(groupId: string, callback: ServiceCallback<ManagementGroup>)

Parameters

groupId

string

Management Group ID.

callback

ServiceCallback<ManagementGroup>

The callback

list(ManagementGroupsListOptionalParams, ServiceCallback<ManagementGroupListResult>)

function list(options: ManagementGroupsListOptionalParams, callback: ServiceCallback<ManagementGroupListResult>)

Parameters

options
ManagementGroupsListOptionalParams

The optional parameters

callback

ServiceCallback<ManagementGroupListResult>

The callback

list(Models.ManagementGroupsListOptionalParams)

List management groups for the authenticated user.

function list(options?: Models.ManagementGroupsListOptionalParams)

Parameters

options
Models.ManagementGroupsListOptionalParams

Returns

Promise<Models.ManagementGroupsListResponse>

Promise<Models.ManagementGroupsListResponse>

list(ServiceCallback<ManagementGroupListResult>)

function list(callback: ServiceCallback<ManagementGroupListResult>)

Parameters

callback

ServiceCallback<ManagementGroupListResult>

The callback

listNext(string, ManagementGroupsListNextOptionalParams, ServiceCallback<ManagementGroupListResult>)

function listNext(nextPageLink: string, options: ManagementGroupsListNextOptionalParams, callback: ServiceCallback<ManagementGroupListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
ManagementGroupsListNextOptionalParams

The optional parameters

callback

ServiceCallback<ManagementGroupListResult>

The callback

listNext(string, Models.ManagementGroupsListNextOptionalParams)

List management groups for the authenticated user.

function listNext(nextPageLink: string, options?: Models.ManagementGroupsListNextOptionalParams)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
Models.ManagementGroupsListNextOptionalParams

Returns

Promise<Models.ManagementGroupsListNextResponse>

Promise<Models.ManagementGroupsListNextResponse>

listNext(string, ServiceCallback<ManagementGroupListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<ManagementGroupListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ManagementGroupListResult>

The callback

update(string, PatchManagementGroupRequest, ManagementGroupsUpdateOptionalParams, ServiceCallback<ManagementGroup>)

function update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, options: ManagementGroupsUpdateOptionalParams, callback: ServiceCallback<ManagementGroup>)

Parameters

groupId

string

Management Group ID.

patchGroupRequest
PatchManagementGroupRequest

Management group patch parameters.

options
ManagementGroupsUpdateOptionalParams

The optional parameters

callback

ServiceCallback<ManagementGroup>

The callback

update(string, PatchManagementGroupRequest, Models.ManagementGroupsUpdateOptionalParams)

Update a management group.

function update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, options?: Models.ManagementGroupsUpdateOptionalParams)

Parameters

groupId

string

Management Group ID.

patchGroupRequest
PatchManagementGroupRequest

Management group patch parameters.

options
Models.ManagementGroupsUpdateOptionalParams

Returns

Promise<Models.ManagementGroupsUpdateResponse>

Promise<Models.ManagementGroupsUpdateResponse>

update(string, PatchManagementGroupRequest, ServiceCallback<ManagementGroup>)

function update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, callback: ServiceCallback<ManagementGroup>)

Parameters

groupId

string

Management Group ID.

patchGroupRequest
PatchManagementGroupRequest

Management group patch parameters.

callback

ServiceCallback<ManagementGroup>

The callback