entitlement_management_resource_environments

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

Overview

Name	entitlement_management_resource_environments
Type	Resource
Id	entra_id.identity_governance.entitlement_management_resource_environments

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.
connectionInfo		Connection information of an environment used to connect to a resource.
createdDateTime	string (date-time)	The date and time that this object was created. The DateTimeOffset 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. (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	The description of this object.
displayName	string	The display name of this object.
isDefaultEnvironment	boolean	Determines whether this is default environment or not. It is set to true for all static origin systems, such as Microsoft Entra groups and Microsoft Entra Applications.
modifiedDateTime	string (date-time)	The date and time that this object was last modified. The DateTimeOffset 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. (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 this environment in the origin system.
originSystem	string	The type of the resource in the origin system, that is, SharePointOnline. Requires $filter (eq).
resources	array	Read-only. Required.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
connectionInfo		Connection information of an environment used to connect to a resource.
createdDateTime	string (date-time)	The date and time that this object was created. The DateTimeOffset 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. (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	The description of this object.
displayName	string	The display name of this object.
isDefaultEnvironment	boolean	Determines whether this is default environment or not. It is set to true for all static origin systems, such as Microsoft Entra groups and Microsoft Entra Applications.
modifiedDateTime	string (date-time)	The date and time that this object was last modified. The DateTimeOffset 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. (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 this environment in the origin system.
originSystem	string	The type of the resource in the origin system, that is, SharePointOnline. Requires $filter (eq).
resources	array	Read-only. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_package_resource_environment_id		A reference to the geolocation environments in which a resource is located.
list	select			Retrieve a list of accessPackageResourceEnvironment objects and their properties.
insert	insert
update	update	access_package_resource_environment_id
delete	delete	access_package_resource_environment_id	If-Match

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

SELECT examples

get

A reference to the geolocation environments in which a resource is located.

SELECT
id,
connectionInfo,
createdDateTime,
description,
displayName,
isDefaultEnvironment,
modifiedDateTime,
originId,
originSystem,
resources
FROM entra_id.identity_governance.entitlement_management_resource_environments
WHERE access_package_resource_environment_id = '{{ access_package_resource_environment_id }}' -- required
;

list

Retrieve a list of accessPackageResourceEnvironment objects and their properties.

SELECT
id,
connectionInfo,
createdDateTime,
description,
displayName,
isDefaultEnvironment,
modifiedDateTime,
originId,
originSystem,
resources
FROM entra_id.identity_governance.entitlement_management_resource_environments
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.entitlement_management_resource_environments (
id,
connectionInfo,
createdDateTime,
description,
displayName,
isDefaultEnvironment,
modifiedDateTime,
originId,
originSystem,
resources
)
SELECT 
'{{ id }}',
'{{ connectionInfo }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
{{ isDefaultEnvironment }},
'{{ modifiedDateTime }}',
'{{ originId }}',
'{{ originSystem }}',
'{{ resources }}'
RETURNING
id,
connectionInfo,
createdDateTime,
description,
displayName,
isDefaultEnvironment,
modifiedDateTime,
originId,
originSystem,
resources
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_resource_environments
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: connectionInfo
    value: "{{ connectionInfo }}"
    description: |
      Connection information of an environment used to connect to a resource.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The date and time that this object was created. The DateTimeOffset 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.
  - name: description
    value: "{{ description }}"
    description: |
      The description of this object.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of this object.
  - name: isDefaultEnvironment
    value: {{ isDefaultEnvironment }}
    description: |
      Determines whether this is default environment or not. It is set to true for all static origin systems, such as Microsoft Entra groups and Microsoft Entra Applications.
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    description: |
      The date and time that this object was last modified. The DateTimeOffset 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.
  - name: originId
    value: "{{ originId }}"
    description: |
      The unique identifier of this environment in the origin system.
  - name: originSystem
    value: "{{ originSystem }}"
    description: |
      The type of the resource in the origin system, that is, SharePointOnline. Requires $filter (eq).
  - name: resources
    description: |
      Read-only. Required.
    value:
      - id: "{{ id }}"
        attributes: "{{ attributes }}"
        createdDateTime: "{{ createdDateTime }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        modifiedDateTime: "{{ modifiedDateTime }}"
        originId: "{{ originId }}"
        originSystem: "{{ originSystem }}"
        environment: "{{ environment }}"
        roles: "{{ roles }}"
        scopes: "{{ scopes }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.entitlement_management_resource_environments
SET 
id = '{{ id }}',
connectionInfo = '{{ connectionInfo }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
isDefaultEnvironment = {{ isDefaultEnvironment }},
modifiedDateTime = '{{ modifiedDateTime }}',
originId = '{{ originId }}',
originSystem = '{{ originSystem }}',
resources = '{{ resources }}'
WHERE 
access_package_resource_environment_id = '{{ access_package_resource_environment_id }}' --required
RETURNING
id,
connectionInfo,
createdDateTime,
description,
displayName,
isDefaultEnvironment,
modifiedDateTime,
originId,
originSystem,
resources;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity_governance.entitlement_management_resource_environments
WHERE access_package_resource_environment_id = '{{ access_package_resource_environment_id }}' --required
AND If-Match = '{{ If-Match }}'
;