Required.
Indicates the type of change in the subscribed resource that raises a change notification.
The supported values are: created, updated, deleted.
Multiple values can be combined using a comma-separated list.
Note: Drive root item and list change notifications support only the updated changeType.
User and group change notifications support updated and deleted changeType.
Use updated to receive notifications when user or group is created, updated, or soft deleted.
Use deleted to receive notifications when user or group is permanently deleted.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ClientState
Optional.
Specifies the value of the clientState property sent by the service in each change notification.
The maximum length is 255 characters.
The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
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
-CreatorId
Optional.
Identifier of the user or service principal that created the subscription.
If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of.
If the app used application permissions, this field contains the ID of the service principal corresponding to the app.
Read-only.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EncryptionCertificate
Optional.
A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications.
Optional but required when includeResourceData is true.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EncryptionCertificateId
Optional.
A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
Required when includeResourceData is true.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExpirationDateTime
Required.
Specifies the date and time when the webhook subscription expires.
The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to.
Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time.
For the maximum supported subscription length of time, see Subscription lifetime.
Parameter properties
Type:
System.DateTime
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
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:
System.Collections.IDictionary
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
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Optional.
Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports.
The possible values are: v10, v11, v12, v13.
For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2.
For these subscribers, not setting this property per the timeline would result in subscription operations failing.
For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional.
In such cases, Microsoft Graph defaults the property to v1_2.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-LifecycleNotificationUrl
Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise.
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications.
This URL must make use of the HTTPS protocol.
For more information, see Reduce missing subscriptions and change notifications.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ListId
The unique identifier of list
Parameter properties
Type:
System.String
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
-NotificationContentType
Optional.
Desired content-type for Microsoft Graph change notifications for supported resource types.
The default content-type is application/json.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NotificationQueryOptions
Optional.
OData query options for specifying the value for the targeting resource.
Clients receive notifications when the resource reaches the state matching the query options provided here.
With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property.
For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
Supported only for Universal Print Service.
For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NotificationUrl
Required.
The URL of the endpoint that receives the change notifications.
This URL must make use of the HTTPS protocol.
Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NotificationUrlAppId
Optional.
The app ID that the subscription service can use to generate the validation token.
The value allows the client to validate the authenticity of the notification received.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Proxy
The URI for the proxy server to use
Parameter properties
Type:
System.Uri
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
Type:
System.Management.Automation.PSCredential
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
Type:
System.Management.Automation.SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Resource
Required.
Specifies the resource that is monitored for changes.
Don't include the base URL (https://graph.microsoft.com/beta/).
See the possible resource path values for each supported resource.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
UpdateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
UpdateExpanded
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:
System.String
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
-SiteId
The unique identifier of site
Parameter properties
Type:
System.String
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
-SubscriptionId
The unique identifier of subscription
Parameter properties
Type:
System.String
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
-WhatIf
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
Type:
System.Management.Automation.SwitchParameter
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.
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.
BODYPARAMETER <IMicrosoftGraphSubscription>: subscription
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ApplicationId <String>]: Optional.
Identifier of the application used to create the subscription.
Read-only.
[ChangeType <String>]: Required.
Indicates the type of change in the subscribed resource that raises a change notification.
The supported values are: created, updated, deleted.
Multiple values can be combined using a comma-separated list.
Note: Drive root item and list change notifications support only the updated changeType.
User and group change notifications support updated and deleted changeType.
Use updated to receive notifications when user or group is created, updated, or soft deleted.
Use deleted to receive notifications when user or group is permanently deleted.
[ClientState <String>]: Optional.
Specifies the value of the clientState property sent by the service in each change notification.
The maximum length is 255 characters.
The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
[CreatorId <String>]: Optional.
Identifier of the user or service principal that created the subscription.
If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of.
If the app used application permissions, this field contains the ID of the service principal corresponding to the app.
Read-only.
[EncryptionCertificate <String>]: Optional.
A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications.
Optional but required when includeResourceData is true.
[EncryptionCertificateId <String>]: Optional.
A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
Required when includeResourceData is true.
[ExpirationDateTime <DateTime?>]: Required.
Specifies the date and time when the webhook subscription expires.
The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to.
Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time.
For the maximum supported subscription length of time, see Subscription lifetime.
[IncludeResourceData <Boolean?>]: Optional.
When set to true, change notifications include resource data (such as content of a chat message).
[LatestSupportedTlsVersion <String>]: Optional.
Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports.
The possible values are: v10, v11, v12, v13.
For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2.
For these subscribers, not setting this property per the timeline would result in subscription operations failing.
For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional.
In such cases, Microsoft Graph defaults the property to v1_2.
[LifecycleNotificationUrl <String>]: Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise.
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications.
This URL must make use of the HTTPS protocol.
For more information, see Reduce missing subscriptions and change notifications.
[NotificationContentType <String>]: Optional.
Desired content-type for Microsoft Graph change notifications for supported resource types.
The default content-type is application/json.
[NotificationQueryOptions <String>]: Optional.
OData query options for specifying the value for the targeting resource.
Clients receive notifications when the resource reaches the state matching the query options provided here.
With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property.
For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
Supported only for Universal Print Service.
For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
[NotificationUrl <String>]: Required.
The URL of the endpoint that receives the change notifications.
This URL must make use of the HTTPS protocol.
Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.
[NotificationUrlAppId <String>]: Optional.
The app ID that the subscription service can use to generate the validation token.
The value allows the client to validate the authenticity of the notification received.
[Resource <String>]: Required.
Specifies the resource that is monitored for changes.
Don't include the base URL (https://graph.microsoft.com/beta/).
See the possible resource path values for each supported resource.
INPUTOBJECT <ISitesIdentity>: Identity Parameter
[BaseItemId <String>]: The unique identifier of baseItem
[BaseSitePageId <String>]: The unique identifier of baseSitePage
[BitlockerRecoveryKeyId <String>]: The unique identifier of bitlockerRecoveryKey
[ColumnDefinitionId <String>]: The unique identifier of columnDefinition
[ColumnLinkId <String>]: The unique identifier of columnLink
[ContentFormats <String[]>]: Usage: contentFormats={contentFormats}
[ContentModelId <String>]: The unique identifier of contentModel
[ContentTypeId <String>]: The unique identifier of contentType
[ContentTypeId1 <String>]: The unique identifier of contentType
[DataLossPreventionPolicyId <String>]: The unique identifier of dataLossPreventionPolicy
[DocumentProcessingJobId <String>]: The unique identifier of documentProcessingJob
[DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
[DriveId <String>]: The unique identifier of drive
[EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
[ExtensionId <String>]: The unique identifier of extension
[GroupId <String>]: The unique identifier of group
[GroupId1 <String>]: The unique identifier of group
[HorizontalSectionColumnId <String>]: The unique identifier of horizontalSectionColumn
[HorizontalSectionId <String>]: The unique identifier of horizontalSection
[IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks}
[InformationProtectionLabelId <String>]: The unique identifier of informationProtectionLabel
[Interval <String>]: Usage: interval='{interval}'
[ItemActivityId <String>]: The unique identifier of itemActivity
[ItemActivityOldId <String>]: The unique identifier of itemActivityOLD
[ItemActivityStatId <String>]: The unique identifier of itemActivityStat
[LabelIds <String[]>]: Usage: labelIds={labelIds}
[ListId <String>]: The unique identifier of list
[ListItemId <String>]: The unique identifier of listItem
[ListItemVersionId <String>]: The unique identifier of listItemVersion
[Locale <String>]: Usage: locale='{locale}'
[ModelName <String>]: Usage: modelName='{modelName}'
[NotebookId <String>]: The unique identifier of notebook
[OnenoteOperationId <String>]: The unique identifier of onenoteOperation
[OnenotePageId <String>]: The unique identifier of onenotePage
[OnenoteResourceId <String>]: The unique identifier of onenoteResource
[OnenoteSectionId <String>]: The unique identifier of onenoteSection
[PageTemplateId <String>]: The unique identifier of pageTemplate
[Path <String>]: Usage: path='{path}'
[PermissionId <String>]: The unique identifier of permission
[RecycleBinItemId <String>]: The unique identifier of recycleBinItem
[RelationId <String>]: The unique identifier of relation
[RichLongRunningOperationId <String>]: The unique identifier of richLongRunningOperation
[SectionGroupId <String>]: The unique identifier of sectionGroup
[SectionGroupId1 <String>]: The unique identifier of sectionGroup
[SensitivityLabelId <String>]: The unique identifier of sensitivityLabel
[SensitivityLabelId1 <String>]: The unique identifier of sensitivityLabel
[SetId <String>]: The unique identifier of set
[SetId1 <String>]: The unique identifier of set
[SiteId <String>]: The unique identifier of site
[SiteId1 <String>]: The unique identifier of site
[StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
[SubscriptionId <String>]: The unique identifier of subscription
[TermId <String>]: The unique identifier of term
[TermId1 <String>]: The unique identifier of term
[ThreatAssessmentRequestId <String>]: The unique identifier of threatAssessmentRequest
[ThreatAssessmentResultId <String>]: The unique identifier of threatAssessmentResult
[Token <String>]: Usage: token='{token}'
[UserId <String>]: The unique identifier of user
[WebPartId <String>]: The unique identifier of webPart