managementActionTenantDeploymentStatus: changeDeploymentStatus
Namespace: microsoft.graph.managedTenants
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Changes the tenant level deployment status for the management action. This information is used to provide insights into what management actions are in a specific state. As example there might be a plan to apply the require multi-factor authentication for admins, so it would be ideal to change the status to planned to reflect the appropriate status.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | ManagedTenants.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Not supported. |
HTTP request
POST /tenantRelationships/managedTenants/managementActionTenantDeploymentStatuses/changeDeploymentStatus
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json. Required. |
Request body
In the request body, supply JSON representation of the parameters.
The following table shows the parameters that can be used with this action.
Parameter | Type | Description |
---|---|---|
tenantGroupId | String | The identifier for the tenant group. |
tenantId | String | The Azure Active Directory tenant identifier for the managed tenant. |
managementActionId | String | The identifier for the management action. |
managementTemplateId | String | The identifier for the management template. |
status | String | The new status for the management action tenant deployment. |
Response
If successful, this action returns a 200 OK
response code and a managementActionDeploymentStatus in the response body.
Examples
Request
POST https://graph.microsoft.com/beta/tenantRelationships/managedTenants/managementActionTenantDeploymentStatuses/changeDeploymentStatus
Content-Type: application/json
{
"tenantGroupId": "String",
"tenantId": "String",
"managementActionId": "String",
"managementTemplateId": "String",
"status": "String"
}
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.managedTenants.ManagementActionDeploymentStatus",
"managementTemplateId": "e5834405-43d2-4815-867d-3dd600308d1c",
"managementActionId": "e96a8cdb-0435-4808-9956-cf6b8ae77aa6",
"status": "planned",
"workloadActionDeploymentStatuses": []
}
Feedback
Submit and view feedback for