ManagementGroupsAPI class
- Extends
Constructors
| Management |
Initializes a new instance of the ManagementGroupsAPI class. |
Properties
| $host | |
| api |
|
| entities | |
| hierarchy |
|
| management |
|
| management |
|
| operations |
Inherited Properties
| pipeline | The pipeline used by this client to make requests |
Methods
| check |
Checks if the specified management group name is valid and unique |
| start |
Starts backfilling subscriptions for the Tenant. |
| tenant |
Gets tenant backfill status |
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
ManagementGroupsAPI(TokenCredential, ManagementGroupsAPIOptionalParams)
Initializes a new instance of the ManagementGroupsAPI class.
new ManagementGroupsAPI(credentials: TokenCredential, options?: ManagementGroupsAPIOptionalParams)Parameters
- credentials
- TokenCredential
Subscription credentials which uniquely identify client subscription.
The parameter options
Property Details
$host
$host: stringProperty Value
string
apiVersion
apiVersion: stringProperty Value
string
entities
hierarchySettingsOperations
managementGroups
managementGroupSubscriptions
managementGroupSubscriptions: ManagementGroupSubscriptionsProperty Value
operations
Inherited Property Details
pipeline
The pipeline used by this client to make requests
pipeline: PipelineProperty Value
Inherited From coreClient.ServiceClient.pipeline
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
Management group name availability check parameters.
The options parameters.
Returns
Promise<CheckNameAvailabilityResult>
startTenantBackfill(StartTenantBackfillOptionalParams)
Starts backfilling subscriptions for the Tenant.
function startTenantBackfill(options?: StartTenantBackfillOptionalParams): Promise<TenantBackfillStatusResult>Parameters
The options parameters.
Returns
Promise<TenantBackfillStatusResult>
tenantBackfillStatus(TenantBackfillStatusOptionalParams)
Gets tenant backfill status
function tenantBackfillStatus(options?: TenantBackfillStatusOptionalParams): Promise<TenantBackfillStatusResult>Parameters
The options parameters.
Returns
Promise<TenantBackfillStatusResult>
Inherited Method Details
sendOperationRequest<T>(OperationArguments, OperationSpec)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
Returns
Promise<T>
Inherited From coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Send the provided httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>Parameters
- request
- PipelineRequest
Returns
Promise<PipelineResponse>
Inherited From coreClient.ServiceClient.sendRequest