home_realm_discovery_policies

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

Overview

Name	home_realm_discovery_policies
Type	Resource
Id	entra_id.applications.home_realm_discovery_policies

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.
appliesTo	array
definition	array	A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.
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.
isOrganizationDefault	boolean	If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
appliesTo	array
definition	array	A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.
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.
isOrganizationDefault	boolean	If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	application_id, home_realm_discovery_policy_id
list	select	application_id

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
application_id	string	The unique identifier of application
home_realm_discovery_policy_id	string	The unique identifier of homeRealmDiscoveryPolicy

SELECT examples

get

Retrieved navigation property

SELECT
id,
appliesTo,
definition,
deletedDateTime,
description,
displayName,
isOrganizationDefault
FROM entra_id.applications.home_realm_discovery_policies
WHERE application_id = '{{ application_id }}' -- required
AND home_realm_discovery_policy_id = '{{ home_realm_discovery_policy_id }}' -- required
;

list

Retrieved collection

SELECT
id,
appliesTo,
definition,
deletedDateTime,
description,
displayName,
isOrganizationDefault
FROM entra_id.applications.home_realm_discovery_policies
WHERE application_id = '{{ application_id }}' -- required
;