entitlement_management_catalogs_resources

Creates, updates, deletes, gets or lists an entitlement_management_catalogs_resources resource.

Overview

Name	entitlement_management_catalogs_resources
Type	Resource
Id	entra_id.identity_governance.entitlement_management_catalogs_resources

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.
attributes	array	Contains information about the attributes to be collected from the requestor and sent to the resource application.
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. Read-only. (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	A description for the resource.
displayName	string	The display name of the resource, such as the application name, group name or site name.
environment		Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
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. Read-only. (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])$)
originId	string	The unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group.
originSystem	string	The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup.
roles	array	Read-only. Nullable. Supports $expand.
scopes	array	Read-only. Nullable. Supports $expand.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
attributes	array	Contains information about the attributes to be collected from the requestor and sent to the resource application.
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. Read-only. (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	A description for the resource.
displayName	string	The display name of the resource, such as the application name, group name or site name.
environment		Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
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. Read-only. (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])$)
originId	string	The unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group.
originSystem	string	The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup.
roles	array	Read-only. Nullable. Supports $expand.
scopes	array	Read-only. Nullable. Supports $expand.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_package_catalog_id, access_package_resource_id		Access package resources in this catalog.
list	select	access_package_catalog_id		Retrieve a list of accessPackageResource objects in an accessPackageCatalog.
insert	insert	access_package_catalog_id
update	update	access_package_catalog_id, access_package_resource_id
delete	delete	access_package_catalog_id, access_package_resource_id	If-Match
refresh	exec	access_package_catalog_id, access_package_resource_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
access_package_catalog_id	string	The unique identifier of accessPackageCatalog
access_package_resource_id	string	The unique identifier of accessPackageResource
If-Match	string	ETag

SELECT examples

get

Access package resources in this catalog.

SELECT
id,
attributes,
createdDateTime,
description,
displayName,
environment,
modifiedDateTime,
originId,
originSystem,
roles,
scopes
FROM entra_id.identity_governance.entitlement_management_catalogs_resources
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
AND access_package_resource_id = '{{ access_package_resource_id }}' -- required
;

list

Retrieve a list of accessPackageResource objects in an accessPackageCatalog.

SELECT
id,
attributes,
createdDateTime,
description,
displayName,
environment,
modifiedDateTime,
originId,
originSystem,
roles,
scopes
FROM entra_id.identity_governance.entitlement_management_catalogs_resources
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.entitlement_management_catalogs_resources (
id,
attributes,
createdDateTime,
description,
displayName,
modifiedDateTime,
originId,
originSystem,
environment,
roles,
scopes,
access_package_catalog_id
)
SELECT 
'{{ id }}',
'{{ attributes }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
'{{ modifiedDateTime }}',
'{{ originId }}',
'{{ originSystem }}',
'{{ environment }}',
'{{ roles }}',
'{{ scopes }}',
'{{ access_package_catalog_id }}'
RETURNING
id,
attributes,
createdDateTime,
description,
displayName,
environment,
modifiedDateTime,
originId,
originSystem,
roles,
scopes
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_catalogs_resources
props:
  - name: access_package_catalog_id
    value: "{{ access_package_catalog_id }}"
    description: Required parameter for the entitlement_management_catalogs_resources resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: attributes
    description: |
      Contains information about the attributes to be collected from the requestor and sent to the resource application.
    value:
      - destination:
        isEditable: {{ isEditable }}
        isPersistedOnAssignmentRemoval: {{ isPersistedOnAssignmentRemoval }}
        name: "{{ name }}"
        source:
  - 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. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      A description for the resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the resource, such as the application name, group name or site name.
  - 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. Read-only.
  - name: originId
    value: "{{ originId }}"
    description: |
      The unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group.
  - name: originSystem
    value: "{{ originSystem }}"
    description: |
      The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup.
  - name: environment
    value: "{{ environment }}"
    description: |
      Contains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
  - name: roles
    description: |
      Read-only. Nullable. Supports $expand.
    value:
      - id: "{{ id }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        originId: "{{ originId }}"
        originSystem: "{{ originSystem }}"
        resource: "{{ resource }}"
  - name: scopes
    description: |
      Read-only. Nullable. Supports $expand.
    value:
      - id: "{{ id }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        isRootScope: {{ isRootScope }}
        originId: "{{ originId }}"
        originSystem: "{{ originSystem }}"
        resource: "{{ resource }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.entitlement_management_catalogs_resources
SET 
id = '{{ id }}',
attributes = '{{ attributes }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
modifiedDateTime = '{{ modifiedDateTime }}',
originId = '{{ originId }}',
originSystem = '{{ originSystem }}',
environment = '{{ environment }}',
roles = '{{ roles }}',
scopes = '{{ scopes }}'
WHERE 
access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND access_package_resource_id = '{{ access_package_resource_id }}' --required
RETURNING
id,
attributes,
createdDateTime,
description,
displayName,
environment,
modifiedDateTime,
originId,
originSystem,
roles,
scopes;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity_governance.entitlement_management_catalogs_resources
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND access_package_resource_id = '{{ access_package_resource_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

refresh

Success

EXEC entra_id.identity_governance.entitlement_management_catalogs_resources.refresh 
@access_package_catalog_id='{{ access_package_catalog_id }}' --required, 
@access_package_resource_id='{{ access_package_resource_id }}' --required
;