multi_tenant_organization
Creates, updates, deletes, gets or lists a multi_tenant_organization resource.
Overview​
| Name | multi_tenant_organization |
| Type | Resource |
| Id | entra_id.tenant_relationships.multi_tenant_organization |
Fields​
The following fields are returned by SELECT queries:
- get
Retrieved navigation property
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
createdDateTime | string (date-time) | Date when multitenant organization was created. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$) |
description | string | Description of the multitenant organization. |
displayName | string | Display name of the multitenant organization. |
joinRequest | | Defines the status of a tenant joining a multitenant organization. |
state | | State of the multitenant organization. The possible values are: active, inactive, unknownFutureValue. active indicates the multitenant organization is created. inactive indicates the multitenant organization isn't created. Read-only. |
tenants | array | Defines tenants added to a multitenant organization. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Get properties of the multitenant organization. | ||
update | update | Update the properties of a multitenant organization. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|
SELECT examples​
- get
Get properties of the multitenant organization.
SELECT
id,
createdDateTime,
description,
displayName,
joinRequest,
state,
tenants
FROM entra_id.tenant_relationships.multi_tenant_organization
;
UPDATE examples​
- update
Update the properties of a multitenant organization.
UPDATE entra_id.tenant_relationships.multi_tenant_organization
SET
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
state = '{{ state }}',
joinRequest = '{{ joinRequest }}',
tenants = '{{ tenants }}'
RETURNING
id,
createdDateTime,
description,
displayName,
joinRequest,
state,
tenants;