Update tenantTag
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.
Update the properties of a tenantTag object.
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.WriteRead.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Not supported. |
HTTP request
PATCH /tenantRelationships/managedTenants/tenantTags/{tenantTagId}
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json. Required. |
Request body
In the request body, supply the values for relevant tenantTag fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
Following properties can be updated:
Property | Type | Description |
---|---|---|
displayName | String | The display name for the tenant tag. |
description | String | The description for the tenant tag. |
tenants | microsoft.graph.managedTenants.tenantInfo collection | The collection of managed tenants associated with the tenant tag. |
Response
If successful, this method returns a 200 OK
response code and an updated tenantTag object in the response body.
Examples
Request
PATCH https://graph.microsoft.com/beta/tenantRelationships/managedTenants/tenantTags/{tenantTagId}
Content-Type: application/json
{
"displayName": "Onboarding",
"description": "Tenants that we are currently onboarding"
}
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#tenantTags/$entity",
"id": "913391c0-5466-42b4-900d-0a7501399cb0",
"displayName": "Onboarding",
"description": "Tenants that we are currently onboarding",
"tenantIds": [
{
"tenantId": "38227791-a88b-4fcc-81c5-58cf77668320"
}
],
"isDeleted": null,
"createdDateTime": "2021-06-16T20:36:31.086644Z",
"createdByUserId": "9bf6a5ad-aecb-4194-a16b-38e02702a602",
"lastActionDateTime": "2021-07-11T18:54:44.5262828Z",
"lastActionByUserId": "cad28f13-0158-43c5-9c59-952f2caa62c0"
}
Feedback
Submit and view feedback for