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.
Applies a management action against a specific managed tenant. Performing this operation makes the appropriate configurations and creates the appropriate policies. For example, when applying the required multifactor authentication for admins, management action creates a Microsoft Entra Conditional Access policy that requires multifactor authentication for all users that are assigned an administrative directory role.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
ManagedTenants.ReadWrite.All |
Not available. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
Not supported. |
Not supported. |
HTTP request
POST /tenantRelationships/managedTenants/managementActions/{managementActionId}/apply
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 |
| tenantId |
String |
The Microsoft Entra tenant identifier for the managed tenant. |
| tenantGroupId |
String |
The identifier of the tenant group. |
| managementTemplateId |
String |
The identifier of the management template. |
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/managementActions/{managementActionId}/apply
Content-Type: application/json
{
"tenantId": "String",
"tenantGroupId": "String",
"managementTemplateId": "String"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.TenantRelationships.ManagedTenants.ManagementActions.Item.MicrosoftGraphManagedTenantsApply;
var requestBody = new ApplyPostRequestBody
{
TenantId = "String",
TenantGroupId = "String",
ManagementTemplateId = "String",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.TenantRelationships.ManagedTenants.ManagementActions["{managementAction-id}"].MicrosoftGraphManagedTenantsApply.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphtenantrelationships "github.com/microsoftgraph/msgraph-beta-sdk-go/tenantrelationships"
//other-imports
)
requestBody := graphtenantrelationships.NewApplyPostRequestBody()
tenantId := "String"
requestBody.SetTenantId(&tenantId)
tenantGroupId := "String"
requestBody.SetTenantGroupId(&tenantGroupId)
managementTemplateId := "String"
requestBody.SetManagementTemplateId(&managementTemplateId)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
microsoftGraphManagedTenantsApply, err := graphClient.TenantRelationships().ManagedTenants().ManagementActions().ByManagementActionId("managementAction-id").MicrosoftGraphManagedTenantsApply().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.tenantrelationships.managedtenants.managementactions.item.microsoftgraphmanagedtenantsapply.ApplyPostRequestBody applyPostRequestBody = new com.microsoft.graph.beta.tenantrelationships.managedtenants.managementactions.item.microsoftgraphmanagedtenantsapply.ApplyPostRequestBody();
applyPostRequestBody.setTenantId("String");
applyPostRequestBody.setTenantGroupId("String");
applyPostRequestBody.setManagementTemplateId("String");
var result = graphClient.tenantRelationships().managedTenants().managementActions().byManagementActionId("{managementAction-id}").microsoftGraphManagedTenantsApply().post(applyPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const managementActionDeploymentStatus = {
tenantId: 'String',
tenantGroupId: 'String',
managementTemplateId: 'String'
};
await client.api('/tenantRelationships/managedTenants/managementActions/{managementActionId}/apply')
.version('beta')
.post(managementActionDeploymentStatus);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\TenantRelationships\ManagedTenants\ManagementActions\Item\MicrosoftGraphManagedTenantsApply\ApplyPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ApplyPostRequestBody();
$requestBody->setTenantId('String');
$requestBody->setTenantGroupId('String');
$requestBody->setManagementTemplateId('String');
$result = $graphServiceClient->tenantRelationships()->managedTenants()->managementActions()->byManagementActionId('managementAction-id')->microsoftGraphManagedTenantsApply()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.tenantrelationships.managedtenants.managementactions.item.microsoft_graph_managed_tenants_apply.apply_post_request_body import ApplyPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ApplyPostRequestBody(
tenant_id = "String",
tenant_group_id = "String",
management_template_id = "String",
)
result = await graph_client.tenant_relationships.managed_tenants.management_actions.by_management_action_id('managementAction-id').microsoft_graph_managed_tenants_apply.post(request_body)
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": "e2cadc41-a08f-45e7-8eb1-942d224dfb9a",
"managementActionId": "b22a4713-8428-4952-8cac-d48962ecbdc9",
"status": "completed",
"workloadActionDeploymentStatuses": [
{
"actionId": "46b80b42-06c7-45b4-b6fb-aa0aecace87b",
"status": "completed",
"deployedPolicyId": null,
"lastDeploymentDateTime": "2021-07-11T19:35:10.4463799Z",
"error": null
}
]
}