conditional_access_deleted_items_policies

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

Overview

Name	conditional_access_deleted_items_policies
Type	Resource
Id	entra_id.identity.conditional_access_deleted_items_policies

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	Specifies the identifier of a conditionalAccessPolicy object. Read-only.
conditions	object	(title: conditionalAccessConditionSet)
createdDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly. (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])$)
deletedDateTime	string (date-time)	(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
displayName	string	Specifies a display name for the conditionalAccessPolicy object.
grantControls		Specifies the grant controls that must be fulfilled to pass the policy.
modifiedDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly. (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])$)
sessionControls		Specifies the session controls that are enforced after sign-in.
state	string	(enabled, disabled, enabledForReportingButNotEnforced) (title: conditionalAccessPolicyState)
templateId	string	Specifies the unique identifier of a Conditional Access template. Inherited from entity.

list

Retrieved collection

Name	Datatype	Description
id	string	Specifies the identifier of a conditionalAccessPolicy object. Read-only.
conditions	object	(title: conditionalAccessConditionSet)
createdDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly. (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])$)
deletedDateTime	string (date-time)	(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
displayName	string	Specifies a display name for the conditionalAccessPolicy object.
grantControls		Specifies the grant controls that must be fulfilled to pass the policy.
modifiedDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly. (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])$)
sessionControls		Specifies the session controls that are enforced after sign-in.
state	string	(enabled, disabled, enabledForReportingButNotEnforced) (title: conditionalAccessPolicyState)
templateId	string	Specifies the unique identifier of a Conditional Access template. Inherited from entity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	conditional_access_policy_id
list	select
insert	insert
update	update	conditional_access_policy_id
delete	delete	conditional_access_policy_id	If-Match
restore	exec	conditional_access_policy_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
conditional_access_policy_id	string	The unique identifier of conditionalAccessPolicy
If-Match	string	ETag

SELECT examples

get

Retrieved navigation property

SELECT
id,
conditions,
createdDateTime,
deletedDateTime,
description,
displayName,
grantControls,
modifiedDateTime,
sessionControls,
state,
templateId
FROM entra_id.identity.conditional_access_deleted_items_policies
WHERE conditional_access_policy_id = '{{ conditional_access_policy_id }}' -- required
;

list

Retrieved collection

SELECT
id,
conditions,
createdDateTime,
deletedDateTime,
description,
displayName,
grantControls,
modifiedDateTime,
sessionControls,
state,
templateId
FROM entra_id.identity.conditional_access_deleted_items_policies
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity.conditional_access_deleted_items_policies (
deletedDateTime,
conditions,
createdDateTime,
description,
displayName,
grantControls,
id,
modifiedDateTime,
sessionControls,
state,
templateId
)
SELECT 
'{{ deletedDateTime }}',
'{{ conditions }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
'{{ grantControls }}',
'{{ id }}',
'{{ modifiedDateTime }}',
'{{ sessionControls }}',
'{{ state }}',
'{{ templateId }}'
RETURNING
id,
conditions,
createdDateTime,
deletedDateTime,
description,
displayName,
grantControls,
modifiedDateTime,
sessionControls,
state,
templateId
;

Manifest

# Description fields are for documentation purposes
- name: conditional_access_deleted_items_policies
props:
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
  - name: conditions
    value:
      applications:
        applicationFilter:
          mode: "{{ mode }}"
          rule: "{{ rule }}"
        excludeApplications:
          - "{{ excludeApplications }}"
        includeApplications:
          - "{{ includeApplications }}"
        includeAuthenticationContextClassReferences:
          - "{{ includeAuthenticationContextClassReferences }}"
        includeUserActions:
          - "{{ includeUserActions }}"
      authenticationFlows:
        transferMethods: "{{ transferMethods }}"
      clientApplications:
        excludeServicePrincipals:
          - "{{ excludeServicePrincipals }}"
        includeServicePrincipals:
          - "{{ includeServicePrincipals }}"
        servicePrincipalFilter:
          mode: "{{ mode }}"
          rule: "{{ rule }}"
      clientAppTypes:
        - "{{ clientAppTypes }}"
      devices:
        deviceFilter:
          mode: "{{ mode }}"
          rule: "{{ rule }}"
      insiderRiskLevels: "{{ insiderRiskLevels }}"
      locations:
        excludeLocations:
          - "{{ excludeLocations }}"
        includeLocations:
          - "{{ includeLocations }}"
      platforms:
        excludePlatforms:
          - "{{ excludePlatforms }}"
        includePlatforms:
          - "{{ includePlatforms }}"
      servicePrincipalRiskLevels:
        - "{{ servicePrincipalRiskLevels }}"
      signInRiskLevels:
        - "{{ signInRiskLevels }}"
      userRiskLevels:
        - "{{ userRiskLevels }}"
      users:
        excludeGroups:
          - "{{ excludeGroups }}"
        excludeGuestsOrExternalUsers:
          externalTenants:
            membershipKind: "{{ membershipKind }}"
          guestOrExternalUserTypes: "{{ guestOrExternalUserTypes }}"
        excludeRoles:
          - "{{ excludeRoles }}"
        excludeUsers:
          - "{{ excludeUsers }}"
        includeGroups:
          - "{{ includeGroups }}"
        includeGuestsOrExternalUsers:
          externalTenants:
            membershipKind: "{{ membershipKind }}"
          guestOrExternalUserTypes: "{{ guestOrExternalUserTypes }}"
        includeRoles:
          - "{{ includeRoles }}"
        includeUsers:
          - "{{ includeUsers }}"
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly.
  - name: description
    value: "{{ description }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Specifies a display name for the conditionalAccessPolicy object.
  - name: grantControls
    value: "{{ grantControls }}"
    description: |
      Specifies the grant controls that must be fulfilled to pass the policy.
  - name: id
    value: "{{ id }}"
    description: |
      Specifies the identifier of a conditionalAccessPolicy object. Read-only.
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    description: |
      The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Readonly.
  - name: sessionControls
    value: "{{ sessionControls }}"
    description: |
      Specifies the session controls that are enforced after sign-in.
  - name: state
    value: "{{ state }}"
    valid_values: ['enabled', 'disabled', 'enabledForReportingButNotEnforced']
  - name: templateId
    value: "{{ templateId }}"
    description: |
      Specifies the unique identifier of a Conditional Access template. Inherited from entity.

UPDATE examples

update

No description available.

UPDATE entra_id.identity.conditional_access_deleted_items_policies
SET 
deletedDateTime = '{{ deletedDateTime }}',
conditions = '{{ conditions }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
grantControls = '{{ grantControls }}',
id = '{{ id }}',
modifiedDateTime = '{{ modifiedDateTime }}',
sessionControls = '{{ sessionControls }}',
state = '{{ state }}',
templateId = '{{ templateId }}'
WHERE 
conditional_access_policy_id = '{{ conditional_access_policy_id }}' --required
RETURNING
id,
conditions,
createdDateTime,
deletedDateTime,
description,
displayName,
grantControls,
modifiedDateTime,
sessionControls,
state,
templateId;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity.conditional_access_deleted_items_policies
WHERE conditional_access_policy_id = '{{ conditional_access_policy_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

restore

Success

EXEC entra_id.identity.conditional_access_deleted_items_policies.restore 
@conditional_access_policy_id='{{ conditional_access_policy_id }}' --required
;