@azure/arm-managementgroups package

  • Reference

Classes

ManagementGroupsAPI

Interfaces

AzureAsyncOperationResults

The results of Azure-AsyncOperation.
CheckNameAvailabilityOptionalParams

Optional parameters.
CheckNameAvailabilityRequest

Management group name availability check parameters.
CheckNameAvailabilityResult

Describes the result of the request to check management group name availability.
CreateManagementGroupChildInfo

The child information of a management group used during creation.
CreateManagementGroupDetails

The details of a management group used during creation.
CreateManagementGroupRequest

Management group creation parameters.
CreateOrUpdateSettingsRequest

Parameters for creating or updating Management Group settings
CreateParentGroupInfo

(Optional) The ID of the parent management group used during creation.
DescendantInfo

The descendant.
DescendantListResult

Describes the result of the request to view descendants.
DescendantParentGroupInfo

The ID of the parent management group.
Entities

Interface representing a Entities.
EntitiesListNextOptionalParams

Optional parameters.
EntitiesListOptionalParams

Optional parameters.
EntityHierarchyItem

The management group details for the hierarchy view.
EntityInfo

The entity.
EntityListResult

Describes the result of the request to view entities.
EntityParentGroupInfo

(Optional) The ID of the parent management group.
ErrorDetails

The details of the error.
ErrorResponse

The error object.
HierarchySettings

Settings defined at the Management Group scope.
HierarchySettingsCreateOrUpdateOptionalParams

Optional parameters.
HierarchySettingsDeleteOptionalParams

Optional parameters.
HierarchySettingsGetOptionalParams

Optional parameters.
HierarchySettingsInfo

The hierarchy settings resource.
HierarchySettingsList

Lists all hierarchy settings.
HierarchySettingsListOptionalParams

Optional parameters.
HierarchySettingsOperations

Interface representing a HierarchySettingsOperations.
HierarchySettingsUpdateOptionalParams

Optional parameters.
ListSubscriptionUnderManagementGroup

The details of all subscriptions under management group.
ManagementGroup

The management group details.
ManagementGroupChildInfo

The child information of a management group.
ManagementGroupDetails

The details of a management group.
ManagementGroupInfo

The management group resource.
ManagementGroupListResult

Describes the result of the request to list management groups.
ManagementGroupPathElement

A path element of a management group ancestors.
ManagementGroupSubscriptions

Interface representing a ManagementGroupSubscriptions.
ManagementGroupSubscriptionsCreateOptionalParams

Optional parameters.
ManagementGroupSubscriptionsDeleteOptionalParams

Optional parameters.
ManagementGroupSubscriptionsGetSubscriptionOptionalParams

Optional parameters.
ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextOptionalParams

Optional parameters.
ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams

Optional parameters.
ManagementGroups

Interface representing a ManagementGroups.
ManagementGroupsAPIOptionalParams

Optional parameters.
ManagementGroupsCreateOrUpdateHeaders

Defines headers for ManagementGroups_createOrUpdate operation.
ManagementGroupsCreateOrUpdateOptionalParams

Optional parameters.
ManagementGroupsDeleteHeaders

Defines headers for ManagementGroups_delete operation.
ManagementGroupsDeleteOptionalParams

Optional parameters.
ManagementGroupsGetDescendantsNextOptionalParams

Optional parameters.
ManagementGroupsGetDescendantsOptionalParams

Optional parameters.
ManagementGroupsGetOptionalParams

Optional parameters.
ManagementGroupsListNextOptionalParams

Optional parameters.
ManagementGroupsListOptionalParams

Optional parameters.
ManagementGroupsUpdateOptionalParams

Optional parameters.
Operation

Operation supported by the Microsoft.Management resource provider.
OperationDisplayProperties

The object that represents the operation.
OperationListResult

Describes the result of the request to list Microsoft.Management operations.
OperationResults

The results of an asynchronous operation.
Operations

Interface representing a Operations.
OperationsListNextOptionalParams

Optional parameters.
OperationsListOptionalParams

Optional parameters.
ParentGroupInfo

(Optional) The ID of the parent management group.
PatchManagementGroupRequest

Management group patch parameters.
StartTenantBackfillOptionalParams

Optional parameters.
SubscriptionUnderManagementGroup

The details of subscription under management group.
TenantBackfillStatusOptionalParams

Optional parameters.
TenantBackfillStatusResult

The tenant backfill status

Type Aliases

CheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.
EntitiesListNextResponse

Contains response data for the listNext operation.
EntitiesListResponse

Contains response data for the list operation.
Enum0

Defines values for Enum0.
KnownEnum0 can be used interchangeably with Enum0, this enum contains the known values that the service supports.

Known values supported by the service

children
path
ancestors
Enum2

Defines values for Enum2.
KnownEnum2 can be used interchangeably with Enum2, this enum contains the known values that the service supports.

Known values supported by the service

AllowedParents
AllowedChildren
ParentAndFirstLevelChildren
ParentOnly
ChildrenOnly
Enum3

Defines values for Enum3.
KnownEnum3 can be used interchangeably with Enum3, this enum contains the known values that the service supports.

Known values supported by the service

FullHierarchy
GroupsOnly
SubscriptionsOnly
Audit
HierarchySettingsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
HierarchySettingsGetResponse

Contains response data for the get operation.
HierarchySettingsListResponse

Contains response data for the list operation.
HierarchySettingsUpdateResponse

Contains response data for the update operation.
ManagementGroupChildType

Defines values for ManagementGroupChildType.
KnownManagementGroupChildType can be used interchangeably with ManagementGroupChildType, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.Management/managementGroups
/subscriptions
ManagementGroupSubscriptionsCreateResponse

Contains response data for the create operation.
ManagementGroupSubscriptionsGetSubscriptionResponse

Contains response data for the getSubscription operation.
ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupNextResponse

Contains response data for the getSubscriptionsUnderManagementGroupNext operation.
ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupResponse

Contains response data for the getSubscriptionsUnderManagementGroup operation.
ManagementGroupsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ManagementGroupsDeleteResponse

Contains response data for the delete operation.
ManagementGroupsGetDescendantsNextResponse

Contains response data for the getDescendantsNext operation.
ManagementGroupsGetDescendantsResponse

Contains response data for the getDescendants operation.
ManagementGroupsGetResponse

Contains response data for the get operation.
ManagementGroupsListNextResponse

Contains response data for the listNext operation.
ManagementGroupsListResponse

Contains response data for the list operation.
ManagementGroupsUpdateResponse

Contains response data for the update operation.
OperationsListNextResponse

Contains response data for the listNext operation.
OperationsListResponse

Contains response data for the list operation.
Permissions

Defines values for Permissions.
KnownPermissions can be used interchangeably with Permissions, this enum contains the known values that the service supports.

Known values supported by the service

noaccess
view
edit
delete
Reason

Defines values for Reason.
StartTenantBackfillResponse

Contains response data for the startTenantBackfill operation.
Status

Defines values for Status.
TenantBackfillStatusResponse

Contains response data for the tenantBackfillStatus operation.

Enums

KnownEnum0

Known values of Enum0 that the service accepts.
KnownEnum2

Known values of Enum2 that the service accepts.
KnownEnum3

Known values of Enum3 that the service accepts.
KnownManagementGroupChildType

Known values of ManagementGroupChildType that the service accepts.
KnownPermissions

Known values of Permissions that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().