Start Tenant Backfill - Start Tenant Backfill

Service:

Management Groups

API Version:

2020-05-01

Starts backfilling subscriptions for the Tenant.

POST https://management.azure.com/providers/Microsoft.Management/startTenantBackfill?api-version=2020-05-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version of the API to be used with the client request. The current version is 2018-01-01-preview.

Responses

Name	Type	Description
200 OK	TenantBackfillStatusResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

StartTenantBackfill

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Management/startTenantBackfill?api-version=2020-05-01

Sample Response

Status code:

200

{
  "tenantId": "20000000-0000-0000-0000-000000000000",
  "status": "Started"
}

Definitions

Name	Description
ErrorDetails	The details of the error.
ErrorResponse	The error object.
Status	The status of the Tenant Backfill
TenantBackfillStatusResult	The tenant backfill status

ErrorDetails

The details of the error.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	string	A human-readable representation of the error's details.
message	string	A human-readable representation of the error.

ErrorResponse

The error object.

Name	Type	Description
error	ErrorDetails	Error The details of the error.

Status

The status of the Tenant Backfill

Name	Type	Description
Cancelled	string
Completed	string
Failed	string
NotStarted	string
NotStartedButGroupsExist	string
Started	string

TenantBackfillStatusResult

The tenant backfill status

Name	Type	Description
status	Status	The status of the Tenant Backfill
tenantId	string	The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000