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.policies.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	home_realm_discovery_policy_id		Retrieve the properties and relationships of a homeRealmDiscoveryPolicy object.
list	select			Get a list of homeRealmDiscoveryPolicy objects.
insert	insert			Create a new homeRealmDiscoveryPolicy object.
update	update	home_realm_discovery_policy_id		Update the properties of a homeRealmDiscoveryPolicy object.
delete	delete	home_realm_discovery_policy_id	If-Match	Delete a homeRealmDiscoveryPolicy object.

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
home_realm_discovery_policy_id	string	The unique identifier of homeRealmDiscoveryPolicy
If-Match	string	ETag

SELECT examples

get

Retrieve the properties and relationships of a homeRealmDiscoveryPolicy object.

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

list

Get a list of homeRealmDiscoveryPolicy objects.

SELECT
id,
appliesTo,
definition,
deletedDateTime,
description,
displayName,
isOrganizationDefault
FROM entra_id.policies.home_realm_discovery_policies
;

INSERT examples

insert

Create a new homeRealmDiscoveryPolicy object.

INSERT INTO entra_id.policies.home_realm_discovery_policies (
id,
deletedDateTime,
description,
displayName,
definition,
isOrganizationDefault,
appliesTo
)
SELECT 
'{{ id }}',
'{{ deletedDateTime }}',
'{{ description }}',
'{{ displayName }}',
'{{ definition }}',
{{ isOrganizationDefault }},
'{{ appliesTo }}'
RETURNING
id,
appliesTo,
definition,
deletedDateTime,
description,
displayName,
isOrganizationDefault
;

Manifest

# Description fields are for documentation purposes
- name: home_realm_discovery_policies
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
    description: |
      Date and time when this object was deleted. Always null when the object hasn't been deleted.
  - name: description
    value: "{{ description }}"
    description: |
      Description for this policy. Required.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name for this policy. Required.
  - name: definition
    value:
      - "{{ definition }}"
    description: |
      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.
  - name: isOrganizationDefault
    value: {{ isOrganizationDefault }}
    description: |
      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.
  - name: appliesTo
    value:
      - id: "{{ id }}"
        deletedDateTime: "{{ deletedDateTime }}"

UPDATE examples

update

Update the properties of a homeRealmDiscoveryPolicy object.

UPDATE entra_id.policies.home_realm_discovery_policies
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
definition = '{{ definition }}',
isOrganizationDefault = {{ isOrganizationDefault }},
appliesTo = '{{ appliesTo }}'
WHERE 
home_realm_discovery_policy_id = '{{ home_realm_discovery_policy_id }}' --required
RETURNING
id,
appliesTo,
definition,
deletedDateTime,
description,
displayName,
isOrganizationDefault;

DELETE examples

delete

Delete a homeRealmDiscoveryPolicy object.

DELETE FROM entra_id.policies.home_realm_discovery_policies
WHERE home_realm_discovery_policy_id = '{{ home_realm_discovery_policy_id }}' --required
AND If-Match = '{{ If-Match }}'
;