Udostępnij za pośrednictwem

Update-MgBetaAgreement

Module:
Microsoft.Graph.Beta.Identity.Governance Module

Update entity in agreements

Note

To view the v1.0 release of this cmdlet, view Update-MgAgreement

Syntax

UpdateExpanded (Default) 

Update-MgBetaAgreement
    -AgreementId <String>
    [-ResponseHeadersVariable <String>]
    [-Acceptances <IMicrosoftGraphAgreementAcceptance[]>]
    [-AdditionalProperties <Hashtable>]
    [-DisplayName <String>]
    [-File <IMicrosoftGraphAgreementFile>]
    [-Files <IMicrosoftGraphAgreementFileLocalization[]>]
    [-Id <String>]
    [-IsPerDeviceAcceptanceRequired]
    [-IsViewingBeforeAcceptanceRequired]
    [-TermsExpiration <IMicrosoftGraphTermsExpiration>]
    [-UserReacceptRequiredFrequency <TimeSpan>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgBetaAgreement
    -AgreementId <String>
    -BodyParameter <IMicrosoftGraphAgreement>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgBetaAgreement
    -InputObject <IIdentityGovernanceIdentity>
    [-ResponseHeadersVariable <String>]
    [-Acceptances <IMicrosoftGraphAgreementAcceptance[]>]
    [-AdditionalProperties <Hashtable>]
    [-DisplayName <String>]
    [-File <IMicrosoftGraphAgreementFile>]
    [-Files <IMicrosoftGraphAgreementFileLocalization[]>]
    [-Id <String>]
    [-IsPerDeviceAcceptanceRequired]
    [-IsViewingBeforeAcceptanceRequired]
    [-TermsExpiration <IMicrosoftGraphTermsExpiration>]
    [-UserReacceptRequiredFrequency <TimeSpan>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgBetaAgreement
    -InputObject <IIdentityGovernanceIdentity>
    -BodyParameter <IMicrosoftGraphAgreement>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update entity in agreements

Parameters

-Acceptances

Read-only. Information about acceptances of this agreement. To construct, see NOTES section for ACCEPTANCES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphAgreementAcceptance[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AgreementId

The unique identifier of agreement

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

agreement To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphAgreement
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Display name of the agreement. The display name is used for internal tracking of the agreement but isn't shown to end users who view the agreement. Supports $filter (eq).

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-File

agreementFile To construct, see NOTES section for FILE properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphAgreementFile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Files

PDFs linked to this agreement. Note: This property is in the process of being deprecated. Use the file property instead. To construct, see NOTES section for FILES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphAgreementFileLocalization[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:IIdentityGovernanceIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IsPerDeviceAcceptanceRequired

This setting enables you to require end users to accept this agreement on every device that they're accessing it from. The end user is required to register their device in Microsoft Entra ID, if they haven't already done so. Supports $filter (eq).

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsViewingBeforeAcceptanceRequired

Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TermsExpiration

termsExpiration To construct, see NOTES section for TERMSEXPIRATION properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphTermsExpiration
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserReacceptRequiredFrequency

The duration after which the user must reaccept the terms of use. The value is represented in ISO 8601 format for durations.

Parameter properties

Type:TimeSpan
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityGovernanceIdentity

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphAgreement

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphAgreement

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

ACCEPTANCES <IMicrosoftGraphAgreementAcceptance- []>: Read-only. Information about acceptances of this agreement.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AgreementFileId <String>]: ID of the agreement file accepted by the user.
  • [AgreementId <String>]: ID of the agreement.
  • [DeviceDisplayName <String>]: The display name of the device used for accepting the agreement.
  • [DeviceId <String>]: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
  • [DeviceOSType <String>]: The operating system used for accepting the agreement.
  • [DeviceOSVersion <String>]: The operating system version of the device used for accepting the agreement.
  • [ExpirationDateTime <DateTime?>]: The expiration date time of the acceptance. 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. Supports $filter (eq, ge, le) and eq for null values.
  • [RecordedDateTime <DateTime?>]: 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. Supports $filter (eq) and eq for null values.
  • [State <String>]: agreementAcceptanceState
  • [UserDisplayName <String>]: Display name of the user when the acceptance was recorded.
  • [UserEmail <String>]: Email of the user when the acceptance was recorded.
  • [UserId <String>]: ID of the user who accepted the agreement. Supports $filter (eq).
  • [UserPrincipalName <String>]: UPN of the user when the acceptance was recorded.

BODYPARAMETER <IMicrosoftGraphAgreement>: agreement

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Acceptances <IMicrosoftGraphAgreementAcceptance- []>]: Read-only. Information about acceptances of this agreement.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [AgreementFileId <String>]: ID of the agreement file accepted by the user.
    • [AgreementId <String>]: ID of the agreement.
    • [DeviceDisplayName <String>]: The display name of the device used for accepting the agreement.
    • [DeviceId <String>]: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
    • [DeviceOSType <String>]: The operating system used for accepting the agreement.
    • [DeviceOSVersion <String>]: The operating system version of the device used for accepting the agreement.
    • [ExpirationDateTime <DateTime?>]: The expiration date time of the acceptance. 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. Supports $filter (eq, ge, le) and eq for null values.
    • [RecordedDateTime <DateTime?>]: 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. Supports $filter (eq) and eq for null values.
    • [State <String>]: agreementAcceptanceState
    • [UserDisplayName <String>]: Display name of the user when the acceptance was recorded.
    • [UserEmail <String>]: Email of the user when the acceptance was recorded.
    • [UserId <String>]: ID of the user who accepted the agreement. Supports $filter (eq).
    • [UserPrincipalName <String>]: UPN of the user when the acceptance was recorded.
  • [DisplayName <String>]: Display name of the agreement. The display name is used for internal tracking of the agreement but isn't shown to end users who view the agreement. Supports $filter (eq).
  • [File <IMicrosoftGraphAgreementFile>]: agreementFile
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [CreatedDateTime <DateTime?>]: 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.
    • [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 <IMicrosoftGraphAgreementFileData>]: agreementFileData
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Data <Byte- []>]: Data that represents the terms of use PDF document. Read-only. Note: You can use the .NET Convert.ToBase64String method to convert your file to binary data for uploading using the Create agreements API. A sample syntax using this method in PowerShell is - [convert]::ToBase64String((Get-Content -path 'yourfilepath' -Encoding byte)).
    • [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.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Localizations <IMicrosoftGraphAgreementFileLocalization- []>]: The localized version of the terms of use agreement files attached to the agreement.
      • [CreatedDateTime <DateTime?>]: 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.
      • [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 <IMicrosoftGraphAgreementFileData>]: 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.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [Versions <IMicrosoftGraphAgreementFileVersion- []>]: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
        • [CreatedDateTime <DateTime?>]: 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.
        • [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 <IMicrosoftGraphAgreementFileData>]: 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.
        • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Files <IMicrosoftGraphAgreementFileLocalization- []>]: PDFs linked to this agreement. Note: This property is in the process of being deprecated. Use the file property instead.
  • [IsPerDeviceAcceptanceRequired <Boolean?>]: This setting enables you to require end users to accept this agreement on every device that they're accessing it from. The end user is required to register their device in Microsoft Entra ID, if they haven't already done so. Supports $filter (eq).
  • [IsViewingBeforeAcceptanceRequired <Boolean?>]: Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).
  • [TermsExpiration <IMicrosoftGraphTermsExpiration>]: termsExpiration
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Frequency <TimeSpan?>]: Represents the frequency at which the terms will expire, after its first expiration as set in startDateTime. The value is represented in ISO 8601 format for durations. For example, PT1M represents a time period of one month.
    • [StartDateTime <DateTime?>]: The DateTime when the agreement is set to expire for all users. 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.
  • [UserReacceptRequiredFrequency <TimeSpan?>]: The duration after which the user must reaccept the terms of use. The value is represented in ISO 8601 format for durations.

FILE <IMicrosoftGraphAgreementFile>: agreementFile

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [CreatedDateTime <DateTime?>]: 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.
  • [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 <IMicrosoftGraphAgreementFileData>]: agreementFileData
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Data <Byte- []>]: Data that represents the terms of use PDF document. Read-only. Note: You can use the .NET Convert.ToBase64String method to convert your file to binary data for uploading using the Create agreements API. A sample syntax using this method in PowerShell is - [convert]::ToBase64String((Get-Content -path 'yourfilepath' -Encoding byte)).
  • [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.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Localizations <IMicrosoftGraphAgreementFileLocalization- []>]: The localized version of the terms of use agreement files attached to the agreement.
    • [CreatedDateTime <DateTime?>]: 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.
    • [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 <IMicrosoftGraphAgreementFileData>]: 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.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Versions <IMicrosoftGraphAgreementFileVersion- []>]: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
      • [CreatedDateTime <DateTime?>]: 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.
      • [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 <IMicrosoftGraphAgreementFileData>]: 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.
      • [Id <String>]: The unique identifier for an entity. Read-only.

FILES <IMicrosoftGraphAgreementFileLocalization- []>: PDFs linked to this agreement. Note: This property is in the process of being deprecated. Use the file property instead.

  • [CreatedDateTime <DateTime?>]: 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.
  • [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 <IMicrosoftGraphAgreementFileData>]: agreementFileData
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Data <Byte- []>]: Data that represents the terms of use PDF document. Read-only. Note: You can use the .NET Convert.ToBase64String method to convert your file to binary data for uploading using the Create agreements API. A sample syntax using this method in PowerShell is - [convert]::ToBase64String((Get-Content -path 'yourfilepath' -Encoding byte)).
  • [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.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Versions <IMicrosoftGraphAgreementFileVersion- []>]: Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.
    • [CreatedDateTime <DateTime?>]: 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.
    • [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 <IMicrosoftGraphAgreementFileData>]: 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.
    • [Id <String>]: The unique identifier for an entity. Read-only.

INPUTOBJECT <IIdentityGovernanceIdentity>: Identity Parameter

  • [AccessPackageAssignmentId <String>]: The unique identifier of accessPackageAssignment
  • [AccessPackageAssignmentPolicyId <String>]: The unique identifier of accessPackageAssignmentPolicy
  • [AccessPackageAssignmentRequestId <String>]: The unique identifier of accessPackageAssignmentRequest
  • [AccessPackageAssignmentResourceRoleId <String>]: The unique identifier of accessPackageAssignmentResourceRole
  • [AccessPackageCatalogId <String>]: The unique identifier of accessPackageCatalog
  • [AccessPackageId <String>]: The unique identifier of accessPackage
  • [AccessPackageId1 <String>]: The unique identifier of accessPackage
  • [AccessPackageResourceEnvironmentId <String>]: The unique identifier of accessPackageResourceEnvironment
  • [AccessPackageResourceId <String>]: The unique identifier of accessPackageResource
  • [AccessPackageResourceRequestId <String>]: The unique identifier of accessPackageResourceRequest
  • [AccessPackageResourceRoleId <String>]: The unique identifier of accessPackageResourceRole
  • [AccessPackageResourceRoleScopeId <String>]: The unique identifier of accessPackageResourceRoleScope
  • [AccessPackageResourceScopeId <String>]: The unique identifier of accessPackageResourceScope
  • [AccessPackageSubjectId <String>]: The unique identifier of accessPackageSubject
  • [AccessReviewDecisionId <String>]: The unique identifier of accessReviewDecision
  • [AccessReviewHistoryDefinitionId <String>]: The unique identifier of accessReviewHistoryDefinition
  • [AccessReviewHistoryInstanceId <String>]: The unique identifier of accessReviewHistoryInstance
  • [AccessReviewId <String>]: The unique identifier of accessReview
  • [AccessReviewId1 <String>]: The unique identifier of accessReview
  • [AccessReviewInstanceDecisionItemId <String>]: The unique identifier of accessReviewInstanceDecisionItem
  • [AccessReviewInstanceDecisionItemId1 <String>]: The unique identifier of accessReviewInstanceDecisionItem
  • [AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance
  • [AccessReviewReviewerId <String>]: The unique identifier of accessReviewReviewer
  • [AccessReviewScheduleDefinitionId <String>]: The unique identifier of accessReviewScheduleDefinition
  • [AccessReviewStageId <String>]: The unique identifier of accessReviewStage
  • [AgreementAcceptanceId <String>]: The unique identifier of agreementAcceptance
  • [AgreementFileLocalizationId <String>]: The unique identifier of agreementFileLocalization
  • [AgreementFileVersionId <String>]: The unique identifier of agreementFileVersion
  • [AgreementId <String>]: The unique identifier of agreement
  • [AppConsentRequestId <String>]: The unique identifier of appConsentRequest
  • [ApprovalId <String>]: The unique identifier of approval
  • [ApprovalStepId <String>]: The unique identifier of approvalStep
  • [BusinessFlowTemplateId <String>]: The unique identifier of businessFlowTemplate
  • [ConnectedOrganizationId <String>]: The unique identifier of connectedOrganization
  • [CustomAccessPackageWorkflowExtensionId <String>]: The unique identifier of customAccessPackageWorkflowExtension
  • [CustomCalloutExtensionId <String>]: The unique identifier of customCalloutExtension
  • [CustomExtensionHandlerId <String>]: The unique identifier of customExtensionHandler
  • [CustomExtensionStageSettingId <String>]: The unique identifier of customExtensionStageSetting
  • [CustomTaskExtensionId <String>]: The unique identifier of customTaskExtension
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime}
  • [FindingId <String>]: The unique identifier of finding
  • [GovernanceInsightId <String>]: The unique identifier of governanceInsight
  • [GovernanceResourceId <String>]: The unique identifier of governanceResource
  • [GovernanceRoleAssignmentId <String>]: The unique identifier of governanceRoleAssignment
  • [GovernanceRoleAssignmentRequestId <String>]: The unique identifier of governanceRoleAssignmentRequest
  • [GovernanceRoleDefinitionId <String>]: The unique identifier of governanceRoleDefinition
  • [GovernanceRoleSettingId <String>]: The unique identifier of governanceRoleSetting
  • [IncompatibleAccessPackageId <String>]: Usage: incompatibleAccessPackageId='{incompatibleAccessPackageId}'
  • [LongRunningOperationId <String>]: The unique identifier of longRunningOperation
  • [ObjectId <String>]: Alternate key of accessPackageSubject
  • [On <String>]: Usage: on='{on}'
  • [PermissionsCreepIndexDistributionId <String>]: The unique identifier of permissionsCreepIndexDistribution
  • [PermissionsRequestChangeId <String>]: The unique identifier of permissionsRequestChange
  • [PrivilegedAccessGroupAssignmentScheduleId <String>]: The unique identifier of privilegedAccessGroupAssignmentSchedule
  • [PrivilegedAccessGroupAssignmentScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance
  • [PrivilegedAccessGroupAssignmentScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest
  • [PrivilegedAccessGroupEligibilityScheduleId <String>]: The unique identifier of privilegedAccessGroupEligibilitySchedule
  • [PrivilegedAccessGroupEligibilityScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance
  • [PrivilegedAccessGroupEligibilityScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest
  • [PrivilegedAccessId <String>]: The unique identifier of privilegedAccess
  • [PrivilegedApprovalId <String>]: The unique identifier of privilegedApproval
  • [PrivilegedOperationEventId <String>]: The unique identifier of privilegedOperationEvent
  • [PrivilegedRoleAssignmentId <String>]: The unique identifier of privilegedRoleAssignment
  • [PrivilegedRoleAssignmentId1 <String>]: The unique identifier of privilegedRoleAssignment
  • [PrivilegedRoleAssignmentRequestId <String>]: The unique identifier of privilegedRoleAssignmentRequest
  • [PrivilegedRoleId <String>]: The unique identifier of privilegedRole
  • [ProgramControlId <String>]: The unique identifier of programControl
  • [ProgramControlId1 <String>]: The unique identifier of programControl
  • [ProgramControlTypeId <String>]: The unique identifier of programControlType
  • [ProgramId <String>]: The unique identifier of program
  • [RbacApplicationId <String>]: The unique identifier of rbacApplication
  • [RunId <String>]: The unique identifier of run
  • [StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime}
  • [TaskDefinitionId <String>]: The unique identifier of taskDefinition
  • [TaskId <String>]: The unique identifier of task
  • [TaskProcessingResultId <String>]: The unique identifier of taskProcessingResult
  • [TaskReportId <String>]: The unique identifier of taskReport
  • [UnifiedRbacResourceActionId <String>]: The unique identifier of unifiedRbacResourceAction
  • [UnifiedRbacResourceNamespaceId <String>]: The unique identifier of unifiedRbacResourceNamespace
  • [UnifiedRoleAssignmentId <String>]: The unique identifier of unifiedRoleAssignment
  • [UnifiedRoleAssignmentScheduleId <String>]: The unique identifier of unifiedRoleAssignmentSchedule
  • [UnifiedRoleAssignmentScheduleInstanceId <String>]: The unique identifier of unifiedRoleAssignmentScheduleInstance
  • [UnifiedRoleAssignmentScheduleRequestId <String>]: The unique identifier of unifiedRoleAssignmentScheduleRequest
  • [UnifiedRoleDefinitionId <String>]: The unique identifier of unifiedRoleDefinition
  • [UnifiedRoleDefinitionId1 <String>]: The unique identifier of unifiedRoleDefinition
  • [UnifiedRoleEligibilityScheduleId <String>]: The unique identifier of unifiedRoleEligibilitySchedule
  • [UnifiedRoleEligibilityScheduleInstanceId <String>]: The unique identifier of unifiedRoleEligibilityScheduleInstance
  • [UnifiedRoleEligibilityScheduleRequestId <String>]: The unique identifier of unifiedRoleEligibilityScheduleRequest
  • [UnifiedRoleManagementAlertConfigurationId <String>]: The unique identifier of unifiedRoleManagementAlertConfiguration
  • [UnifiedRoleManagementAlertDefinitionId <String>]: The unique identifier of unifiedRoleManagementAlertDefinition
  • [UnifiedRoleManagementAlertId <String>]: The unique identifier of unifiedRoleManagementAlert
  • [UnifiedRoleManagementAlertIncidentId <String>]: The unique identifier of unifiedRoleManagementAlertIncident
  • [UniqueName <String>]: Alternate key of accessPackageCatalog
  • [UserConsentRequestId <String>]: The unique identifier of userConsentRequest
  • [UserId <String>]: The unique identifier of user
  • [UserProcessingResultId <String>]: The unique identifier of userProcessingResult
  • [WorkflowId <String>]: The unique identifier of workflow
  • [WorkflowTemplateId <String>]: The unique identifier of workflowTemplate
  • [WorkflowVersionNumber <Int32?>]: The unique identifier of workflowVersion

TERMSEXPIRATION <IMicrosoftGraphTermsExpiration>: termsExpiration

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Frequency <TimeSpan?>]: Represents the frequency at which the terms will expire, after its first expiration as set in startDateTime. The value is represented in ISO 8601 format for durations. For example, PT1M represents a time period of one month.
  • [StartDateTime <DateTime?>]: The DateTime when the agreement is set to expire for all users. 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.