Edit

Share via

tenantGroup resource type

  • Article

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.

Represents a logical group of managed tenants.

Methods

Method Return type Description
List tenant groups microsoft.graph.managedTenants.tenantGroup collection Get a list of the tenantGroup objects and their properties.
Get tenant group microsoft.graph.managedTenants.tenantGroup Read the properties and relationships of a tenantGroup object.
Search for tenant microsoft.graph.managedTenants.tenantGroup collection Searches for the specific managed tenant across tenant groups.

Properties

Property Type Description
allTenantsIncluded Boolean A flag indicating whether all managed tenant are included in the tenant group. Required. Read-only.
displayName String The display name for the tenant group. Optional. Read-only.
id String The unique identifier for the tenant group. Required. Read-only.
managementActions microsoft.graph.managedTenants.managementActionInfo collection The collection of management action associated with the tenant group. Optional. Read-only.
managementIntents microsoft.graph.managedTenants.managementIntentInfo collection The collection of management intents associated with the tenant group. Optional. Read-only.
tenantIds String collection The collection of managed tenant identifiers include in the tenant group. Optional. Read-only.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.managedTenants.tenantGroup",
  "id": "String (identifier)",
  "displayName": "String",
  "allTenantsIncluded": "Boolean",
  "tenantIds": [
    "String"
  ],
  "managementIntents": [
    {
      "@odata.type": "microsoft.graph.managedTenants.managementIntentInfo"
    }
  ],
  "managementActions": [
    {
      "@odata.type": "microsoft.graph.managedTenants.managementActionInfo"
    }
  ]
}