ManagementGroups | @azure/arm-managementgroups

Class representing a ManagementGroups.

Hierarchy

ManagementGroups

Index

Constructors

constructor

Methods

Constructors

constructor

new ManagementGroups(client: ManagementGroupsAPIContext): ManagementGroups

- Defined in operations/managementGroups.ts:20
Create a ManagementGroups.

Parameters
- client: ManagementGroupsAPIContext
  
  Reference to the service client.
Returns ManagementGroups

Methods

beginCreateOrUpdate

beginCreateOrUpdate(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: Models.ManagementGroupsBeginCreateOrUpdateOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/managementGroups.ts:148
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.

Parameters
- groupId: string
  
  Management Group ID.
- createManagementGroupRequest: CreateManagementGroupRequest
  
  Management group creation parameters.
- Optional options: Models.ManagementGroupsBeginCreateOrUpdateOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(groupId: string, options?: Models.ManagementGroupsBeginDeleteMethodOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/managementGroups.ts:165
Delete management group. If a management group contains child resources, the request will fail.

Parameters
- groupId: string
  
  Management Group ID.
- Optional options: Models.ManagementGroupsBeginDeleteMethodOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(groupId: string, createManagementGroupRequest: CreateManagementGroupRequest, options?: Models.ManagementGroupsCreateOrUpdateOptionalParams): Promise<Models.ManagementGroupsCreateOrUpdateResponse>

- Defined in operations/managementGroups.ts:91
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.

Parameters
- groupId: string
  
  Management Group ID.
- createManagementGroupRequest: CreateManagementGroupRequest
  
  Management group creation parameters.
- Optional options: Models.ManagementGroupsCreateOrUpdateOptionalParams
Returns Promise<Models.ManagementGroupsCreateOrUpdateResponse>

Promise<Models.ManagementGroupsCreateOrUpdateResponse>

deleteMethod

deleteMethod(groupId: string, options?: Models.ManagementGroupsDeleteMethodOptionalParams): Promise<Models.ManagementGroupsDeleteMethodResponse>

- Defined in operations/managementGroups.ts:134
Delete management group. If a management group contains child resources, the request will fail.

Parameters
- groupId: string
  
  Management Group ID.
- Optional options: Models.ManagementGroupsDeleteMethodOptionalParams
Returns Promise<Models.ManagementGroupsDeleteMethodResponse>

Promise<Models.ManagementGroupsDeleteMethodResponse>

get

get(groupId: string, options?: Models.ManagementGroupsGetOptionalParams): Promise<Models.ManagementGroupsGetResponse>
get(groupId: string, callback: msRest.ServiceCallback<ManagementGroup>): void
get(groupId: string, options: ManagementGroupsGetOptionalParams, callback: msRest.ServiceCallback<ManagementGroup>): void

- Defined in operations/managementGroups.ts:60
Get the details of the management group.

Parameters
- groupId: string
  
  Management Group ID.
- Optional options: Models.ManagementGroupsGetOptionalParams
Returns Promise<Models.ManagementGroupsGetResponse>

Promise<Models.ManagementGroupsGetResponse>
- Defined in operations/managementGroups.ts:65
Parameters
- groupId: string
  
  Management Group ID.
- callback: msRest.ServiceCallback<ManagementGroup>
  
  The callback
Returns void
- Defined in operations/managementGroups.ts:71
Parameters
- groupId: string
  
  Management Group ID.
- options: ManagementGroupsGetOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ManagementGroup>
  
  The callback
Returns void

list

list(options?: Models.ManagementGroupsListOptionalParams): Promise<Models.ManagementGroupsListResponse>
list(callback: msRest.ServiceCallback<ManagementGroupListResult>): void
list(options: ManagementGroupsListOptionalParams, callback: msRest.ServiceCallback<ManagementGroupListResult>): void

- Defined in operations/managementGroups.ts:35
List management groups for the authenticated user.

Parameters
- Optional options: Models.ManagementGroupsListOptionalParams
Returns Promise<Models.ManagementGroupsListResponse>

Promise<Models.ManagementGroupsListResponse>
- Defined in operations/managementGroups.ts:39
Parameters
- callback: msRest.ServiceCallback<ManagementGroupListResult>
  
  The callback
Returns void
- Defined in operations/managementGroups.ts:44
Parameters
- options: ManagementGroupsListOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ManagementGroupListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: Models.ManagementGroupsListNextOptionalParams): Promise<Models.ManagementGroupsListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<ManagementGroupListResult>): void
listNext(nextPageLink: string, options: ManagementGroupsListNextOptionalParams, callback: msRest.ServiceCallback<ManagementGroupListResult>): void

- Defined in operations/managementGroups.ts:181
List management groups for the authenticated user.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: Models.ManagementGroupsListNextOptionalParams
Returns Promise<Models.ManagementGroupsListNextResponse>

Promise<Models.ManagementGroupsListNextResponse>
- Defined in operations/managementGroups.ts:186
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ManagementGroupListResult>
  
  The callback
Returns void
- Defined in operations/managementGroups.ts:192
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: ManagementGroupsListNextOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ManagementGroupListResult>
  
  The callback
Returns void

update

update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, options?: Models.ManagementGroupsUpdateOptionalParams): Promise<Models.ManagementGroupsUpdateResponse>
update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, callback: msRest.ServiceCallback<ManagementGroup>): void
update(groupId: string, patchGroupRequest: PatchManagementGroupRequest, options: ManagementGroupsUpdateOptionalParams, callback: msRest.ServiceCallback<ManagementGroup>): void

- Defined in operations/managementGroups.ts:103
Update a management group.

Parameters
- groupId: string
  
  Management Group ID.
- patchGroupRequest: PatchManagementGroupRequest
  
  Management group patch parameters.
- Optional options: Models.ManagementGroupsUpdateOptionalParams
Returns Promise<Models.ManagementGroupsUpdateResponse>

Promise<Models.ManagementGroupsUpdateResponse>
- Defined in operations/managementGroups.ts:109
Parameters
- groupId: string
  
  Management Group ID.
- patchGroupRequest: PatchManagementGroupRequest
  
  Management group patch parameters.
- callback: msRest.ServiceCallback<ManagementGroup>
  
  The callback
Returns void
- Defined in operations/managementGroups.ts:116
Parameters
- groupId: string
  
  Management Group ID.
- patchGroupRequest: PatchManagementGroupRequest
  
  Management group patch parameters.
- options: ManagementGroupsUpdateOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<ManagementGroup>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ManagementGroupsAPIContext

Returns ManagementGroups

Methods

beginCreateOrUpdate

Parameters

groupId: string

createManagementGroupRequest: CreateManagementGroupRequest

Optional options: Models.ManagementGroupsBeginCreateOrUpdateOptionalParams

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

groupId: string

Optional options: Models.ManagementGroupsBeginDeleteMethodOptionalParams

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

groupId: string

createManagementGroupRequest: CreateManagementGroupRequest

Optional options: Models.ManagementGroupsCreateOrUpdateOptionalParams

Returns Promise<Models.ManagementGroupsCreateOrUpdateResponse>

deleteMethod

Parameters

groupId: string

Optional options: Models.ManagementGroupsDeleteMethodOptionalParams

Returns Promise<Models.ManagementGroupsDeleteMethodResponse>

get

Parameters

groupId: string

Optional options: Models.ManagementGroupsGetOptionalParams

Returns Promise<Models.ManagementGroupsGetResponse>

Parameters

groupId: string

callback: msRest.ServiceCallback<ManagementGroup>

Returns void

Parameters

groupId: string

options: ManagementGroupsGetOptionalParams

callback: msRest.ServiceCallback<ManagementGroup>

Returns void

list

Parameters

Optional options: Models.ManagementGroupsListOptionalParams

Returns Promise<Models.ManagementGroupsListResponse>

Parameters

callback: msRest.ServiceCallback<ManagementGroupListResult>

Returns void

Parameters

options: ManagementGroupsListOptionalParams

callback: msRest.ServiceCallback<ManagementGroupListResult>

Returns void

listNext

Parameters

nextPageLink: string

Optional options: Models.ManagementGroupsListNextOptionalParams

Returns Promise<Models.ManagementGroupsListNextResponse>

Parameters

nextPageLink: string

callback: msRest.ServiceCallback<ManagementGroupListResult>

Returns void

Parameters

nextPageLink: string

options: ManagementGroupsListNextOptionalParams

callback: msRest.ServiceCallback<ManagementGroupListResult>

Returns void

update

Parameters

groupId: string

patchGroupRequest: PatchManagementGroupRequest

Optional options: Models.ManagementGroupsUpdateOptionalParams

Returns Promise<Models.ManagementGroupsUpdateResponse>

Parameters

groupId: string

patchGroupRequest: PatchManagementGroupRequest