Get-MgAgreementFile

Module:

Microsoft.Graph.Identity.Governance Module

Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.

Note

To view the beta release of this cmdlet, view Get-MgBetaAgreementFile

Syntax

Get (Default)

Get-MgAgreementFile
    -AgreementId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

List

Get-MgAgreementFile
    -AgreementId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-Filter <String>]
    [-Search <String>]
    [-Skip <Int32>]
    [-Sort <String[]>]
    [-Top <Int32>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PageSize <Int32>]
    [-All]
    [-CountVariable <String>]
    [<CommonParameters>]

GetViaIdentity

Get-MgAgreementFile
    -InputObject <IIdentityGovernanceIdentity>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

Description

Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Agreement.Read.All, Agreement.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	Not supported

Examples

Example 1: Get the agreement file for a specific language

Import-Module Microsoft.Graph.Identity.Governance

Get-MgAgreementFile -AgreementId $agreementId

This example will get the agreement file for a specific language

Parameters

-AgreementId

The unique identifier of agreement

Parameter properties

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

Parameter sets

Get

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

List

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

-All

List all pages.

Parameter properties

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

Parameter sets

List

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

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Parameter properties

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

Parameter sets

List

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

-ExpandProperty

Expand related entities

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Expand

Parameter sets

(All)

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

-Filter

Filter items by property values

Parameter properties

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

Parameter sets

List

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

-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

GetViaIdentity

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

-PageSize

Sets the page size of results.

Parameter properties

Type:	Int32
Default value:	0
Supports wildcards:	False
DontShow:	False

Parameter sets

List

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

-Property

Select properties to be returned

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Select

Parameter sets

(All)

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

-Search

Search items by search phrases

Parameter properties

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

Parameter sets

List

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

-Skip

Skip the first n items

Parameter properties

Type:	Int32
Default value:	0
Supports wildcards:	False
DontShow:	False

Parameter sets

List

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

-Sort

Order items by property values

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	OrderBy

Parameter sets

List

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

-Top

Show only the first n items

Parameter properties

Type:	Int32
Default value:	0
Supports wildcards:	False
DontShow:	False
Aliases:	Limit

Parameter sets

List

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.PowerShell.Models.IIdentityGovernanceIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAgreementFile

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAgreementFileLocalization

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.

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
• [AccessPackageCatalogId <String>]: The unique identifier of accessPackageCatalog
• [AccessPackageId <String>]: The unique identifier of accessPackage
• [AccessPackageId1 <String>]: The unique identifier of accessPackage
• [AccessPackageQuestionId <String>]: The unique identifier of accessPackageQuestion
• [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
• [AccessPackageResourceRoleId1 <String>]: The unique identifier of accessPackageResourceRole
• [AccessPackageResourceRoleScopeId <String>]: The unique identifier of accessPackageResourceRoleScope
• [AccessPackageResourceScopeId <String>]: The unique identifier of accessPackageResourceScope
• [AccessPackageResourceScopeId1 <String>]: The unique identifier of accessPackageResourceScope
• [AccessReviewHistoryDefinitionId <String>]: The unique identifier of accessReviewHistoryDefinition
• [AccessReviewHistoryInstanceId <String>]: The unique identifier of accessReviewHistoryInstance
• [AccessReviewInstanceDecisionItemId <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
• [ApprovalStageId <String>]: The unique identifier of approvalStage
• [ConnectedOrganizationId <String>]: The unique identifier of connectedOrganization
• [CustomCalloutExtensionId <String>]: The unique identifier of customCalloutExtension
• [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}
• [GovernanceInsightId <String>]: The unique identifier of governanceInsight
• [IncompatibleAccessPackageId <String>]: Usage: incompatibleAccessPackageId='{incompatibleAccessPackageId}'
• [On <String>]: Usage: on='{on}'
• [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
• [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
• [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

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.identity.governance/get-mgagreementfile
• https://learn.microsoft.com/graph/api/agreementfile-get?view=graph-rest-1.0