cross_tenant_access_policy

Creates, updates, deletes, gets or lists a cross_tenant_access_policy resource.

Overview

Name	cross_tenant_access_policy
Type	Resource
Id	entra_id.policies.cross_tenant_access_policy

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.
allowedCloudEndpoints	array	Used to specify which Microsoft clouds an organization would like to collaborate with. By default, this value is empty. Supported values for this field are: microsoftonline.com, microsoftonline.us, and partner.microsoftonline.cn.
default		Defines the default configuration for how your organization interacts with external Microsoft Entra organizations.
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (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 for this policy. Required.
displayName	string	Display name for this policy. Required.
partners	array	Defines partner-specific configurations for external Microsoft Entra organizations.
templates		Represents the base policy in the directory for multitenant organization settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Read the properties and relationships of a crossTenantAccessPolicy object.
update	update			Update the properties of a cross-tenant access policy.
delete	delete		If-Match

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
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a crossTenantAccessPolicy object.

SELECT
id,
allowedCloudEndpoints,
default,
deletedDateTime,
description,
displayName,
partners,
templates
FROM entra_id.policies.cross_tenant_access_policy
;

UPDATE examples

update

Update the properties of a cross-tenant access policy.

UPDATE entra_id.policies.cross_tenant_access_policy
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
allowedCloudEndpoints = '{{ allowedCloudEndpoints }}',
default = '{{ default }}',
partners = '{{ partners }}',
templates = '{{ templates }}'
RETURNING
id,
allowedCloudEndpoints,
default,
deletedDateTime,
description,
displayName,
partners,
templates;

DELETE examples

delete

No description available.

DELETE FROM entra_id.policies.cross_tenant_access_policy
WHERE If-Match = '{{ If-Match }}'
;