feature_rollout_policies

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

Overview

Name	feature_rollout_policies
Type	Resource
Id	entra_id.policies.feature_rollout_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	Nullable. Specifies a list of directoryObject resources that feature is enabled for.
description	string	A description for this feature rollout policy.
displayName	string	The display name for this feature rollout policy.
feature	string	(passthroughAuthentication, seamlessSso, passwordHashSync, emailAsAlternateId, unknownFutureValue, certificateBasedAuthentication, multiFactorAuthentication) (title: stagedFeatureName)
isAppliedToOrganization	boolean	Indicates whether this feature rollout policy should be applied to the entire organization.
isEnabled	boolean	Indicates whether the feature rollout is enabled.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
appliesTo	array	Nullable. Specifies a list of directoryObject resources that feature is enabled for.
description	string	A description for this feature rollout policy.
displayName	string	The display name for this feature rollout policy.
feature	string	(passthroughAuthentication, seamlessSso, passwordHashSync, emailAsAlternateId, unknownFutureValue, certificateBasedAuthentication, multiFactorAuthentication) (title: stagedFeatureName)
isAppliedToOrganization	boolean	Indicates whether this feature rollout policy should be applied to the entire organization.
isEnabled	boolean	Indicates whether the feature rollout is enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	feature_rollout_policy_id		Retrieve the properties and relationships of a featureRolloutPolicy object.
list	select			Retrieve a list of featureRolloutPolicy objects.
insert	insert			Create a new featureRolloutPolicy object.
update	update	feature_rollout_policy_id		Update the properties of featureRolloutPolicy object.
delete	delete	feature_rollout_policy_id	If-Match	Delete a featureRolloutPolicy 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
feature_rollout_policy_id	string	The unique identifier of featureRolloutPolicy
If-Match	string	ETag

SELECT examples

get

Retrieve the properties and relationships of a featureRolloutPolicy object.

SELECT
id,
appliesTo,
description,
displayName,
feature,
isAppliedToOrganization,
isEnabled
FROM entra_id.policies.feature_rollout_policies
WHERE feature_rollout_policy_id = '{{ feature_rollout_policy_id }}' -- required
;

list

Retrieve a list of featureRolloutPolicy objects.

SELECT
id,
appliesTo,
description,
displayName,
feature,
isAppliedToOrganization,
isEnabled
FROM entra_id.policies.feature_rollout_policies
;

INSERT examples

insert

Create a new featureRolloutPolicy object.

INSERT INTO entra_id.policies.feature_rollout_policies (
id,
description,
displayName,
feature,
isAppliedToOrganization,
isEnabled,
appliesTo
)
SELECT 
'{{ id }}',
'{{ description }}',
'{{ displayName }}',
'{{ feature }}',
{{ isAppliedToOrganization }},
{{ isEnabled }},
'{{ appliesTo }}'
RETURNING
id,
appliesTo,
description,
displayName,
feature,
isAppliedToOrganization,
isEnabled
;

Manifest

# Description fields are for documentation purposes
- name: feature_rollout_policies
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      A description for this feature rollout policy.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name for this  feature rollout policy.
  - name: feature
    value: "{{ feature }}"
    valid_values: ['passthroughAuthentication', 'seamlessSso', 'passwordHashSync', 'emailAsAlternateId', 'unknownFutureValue', 'certificateBasedAuthentication', 'multiFactorAuthentication']
  - name: isAppliedToOrganization
    value: {{ isAppliedToOrganization }}
    description: |
      Indicates whether this feature rollout policy should be applied to the entire organization.
  - name: isEnabled
    value: {{ isEnabled }}
    description: |
      Indicates whether the feature rollout is enabled.
  - name: appliesTo
    description: |
      Nullable. Specifies a list of directoryObject resources that feature is enabled for.
    value:
      - id: "{{ id }}"
        deletedDateTime: "{{ deletedDateTime }}"

UPDATE examples

update

Update the properties of featureRolloutPolicy object.

UPDATE entra_id.policies.feature_rollout_policies
SET 
id = '{{ id }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
feature = '{{ feature }}',
isAppliedToOrganization = {{ isAppliedToOrganization }},
isEnabled = {{ isEnabled }},
appliesTo = '{{ appliesTo }}'
WHERE 
feature_rollout_policy_id = '{{ feature_rollout_policy_id }}' --required
RETURNING
id,
appliesTo,
description,
displayName,
feature,
isAppliedToOrganization,
isEnabled;

DELETE examples

delete

Delete a featureRolloutPolicy object.

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