files

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

Overview

Name	files
Type	Resource
Id	entra_id.agreements.files

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.
createdDateTime	string (date-time)	The date time representing when the file was created. 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. (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])$)
displayName	string	Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
fileData	object	Data that represents the terms of use PDF document. Read-only. (title: agreementFileData)
fileName	string	Name of the agreement file (for example, TOU.pdf). Read-only.
isDefault	boolean	If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only.
isMajorVersion	boolean	Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
language	string	The language of the agreement file in the format 'languagecode2-country/regioncode2'. 'languagecode2' is a lowercase two-letter code derived from ISO 639-1, while 'country/regioncode2' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.
versions	array	Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	The date time representing when the file was created. 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. (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])$)
displayName	string	Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
fileData	object	Data that represents the terms of use PDF document. Read-only. (title: agreementFileData)
fileName	string	Name of the agreement file (for example, TOU.pdf). Read-only.
isDefault	boolean	If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only.
isMajorVersion	boolean	Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
language	string	The language of the agreement file in the format 'languagecode2-country/regioncode2'. 'languagecode2' is a lowercase two-letter code derived from ISO 639-1, while 'country/regioncode2' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.
versions	array	Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agreement_id, agreement_file_localization_id		PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
list	select	agreement_id		PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
insert	insert	agreement_id
update	update	agreement_id, agreement_file_localization_id
delete	delete	agreement_id, agreement_file_localization_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
agreement_file_localization_id	string	The unique identifier of agreementFileLocalization
agreement_id	string	The unique identifier of agreement
If-Match	string	ETag

SELECT examples

get

PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.

SELECT
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
versions
FROM entra_id.agreements.files
WHERE agreement_id = '{{ agreement_id }}' -- required
AND agreement_file_localization_id = '{{ agreement_file_localization_id }}' -- required
;

list

PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.

SELECT
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
versions
FROM entra_id.agreements.files
WHERE agreement_id = '{{ agreement_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.agreements.files (
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
versions,
agreement_id
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
'{{ displayName }}',
'{{ fileData }}',
'{{ fileName }}',
{{ isDefault }},
{{ isMajorVersion }},
'{{ language }}',
'{{ versions }}',
'{{ agreement_id }}'
RETURNING
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
versions
;

Manifest

# Description fields are for documentation purposes
- name: files
props:
  - name: agreement_id
    value: "{{ agreement_id }}"
    description: Required parameter for the files resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The date time representing when the file was created. 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.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
  - name: fileData
    description: |
      Data that represents the terms of use PDF document. Read-only.
    value:
      data: "{{ data }}"
  - name: fileName
    value: "{{ fileName }}"
    description: |
      Name of the agreement file (for example, TOU.pdf). Read-only.
  - name: isDefault
    value: {{ isDefault }}
    description: |
      If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only.
  - name: isMajorVersion
    value: {{ isMajorVersion }}
    description: |
      Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
  - name: language
    value: "{{ language }}"
    description: |
      The language of the agreement file in the format 'languagecode2-country/regioncode2'. 'languagecode2' is a lowercase two-letter code derived from ISO 639-1, while 'country/regioncode2' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.
  - name: versions
    description: |
      Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
    value:
      - id: "{{ id }}"
        createdDateTime: "{{ createdDateTime }}"
        displayName: "{{ displayName }}"
        fileData:
          data: "{{ data }}"
        fileName: "{{ fileName }}"
        isDefault: {{ isDefault }}
        isMajorVersion: {{ isMajorVersion }}
        language: "{{ language }}"

UPDATE examples

update

No description available.

UPDATE entra_id.agreements.files
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
displayName = '{{ displayName }}',
fileData = '{{ fileData }}',
fileName = '{{ fileName }}',
isDefault = {{ isDefault }},
isMajorVersion = {{ isMajorVersion }},
language = '{{ language }}',
versions = '{{ versions }}'
WHERE 
agreement_id = '{{ agreement_id }}' --required
AND agreement_file_localization_id = '{{ agreement_file_localization_id }}' --required
RETURNING
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
versions;

DELETE examples

delete

No description available.

DELETE FROM entra_id.agreements.files
WHERE agreement_id = '{{ agreement_id }}' --required
AND agreement_file_localization_id = '{{ agreement_file_localization_id }}' --required
AND If-Match = '{{ If-Match }}'
;