ManagementGroupsAPI class

Constructors

ManagementGroupsAPI(TokenCredential, ManagementGroupsAPIOptionalParams)

The Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.

Properties

entities

The operation groups for entities

hierarchySettings

The operation groups for hierarchySettings

managementGroups

The operation groups for managementGroups

managementGroupSubscriptions

The operation groups for managementGroupSubscriptions

operations

The operation groups for operations

pipeline

The pipeline used by this client to make requests

Methods

checkNameAvailability(CheckNameAvailabilityRequest, CheckNameAvailabilityOptionalParams)

Checks if the specified management group name is valid and unique

startTenantBackfill(StartTenantBackfillOptionalParams)

Starts backfilling subscriptions for the Tenant.

tenantBackfillStatus(TenantBackfillStatusOptionalParams)

Gets tenant backfill status

Constructor Details

ManagementGroupsAPI(TokenCredential, ManagementGroupsAPIOptionalParams)

The Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.

new ManagementGroupsAPI(credential: TokenCredential, options?: ManagementGroupsAPIOptionalParams)

Parameters

credential
TokenCredential

Property Details

entities

The operation groups for entities

entities: EntitiesOperations

Property Value

hierarchySettings

The operation groups for hierarchySettings

hierarchySettings: HierarchySettingsOperations

Property Value

managementGroups

The operation groups for managementGroups

managementGroups: ManagementGroupsOperations

Property Value

managementGroupSubscriptions

The operation groups for managementGroupSubscriptions

managementGroupSubscriptions: ManagementGroupSubscriptionsOperations

Property Value

operations

The operation groups for operations

operations: OperationsOperations

Property Value

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Method Details

checkNameAvailability(CheckNameAvailabilityRequest, CheckNameAvailabilityOptionalParams)

Checks if the specified management group name is valid and unique

function checkNameAvailability(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: CheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

checkNameAvailabilityRequest
CheckNameAvailabilityRequest

Returns

startTenantBackfill(StartTenantBackfillOptionalParams)

Starts backfilling subscriptions for the Tenant.

function startTenantBackfill(options?: StartTenantBackfillOptionalParams): Promise<TenantBackfillStatusResult>

Parameters

Returns

tenantBackfillStatus(TenantBackfillStatusOptionalParams)

Gets tenant backfill status

function tenantBackfillStatus(options?: TenantBackfillStatusOptionalParams): Promise<TenantBackfillStatusResult>

Parameters

Returns