Required.
URL used to launch the activity in the best native experience represented by the appId.
Might launch a web-based app if no native app exists.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ActivitySourceHost
Required.
URL for the domain representing the cross-platform identity mapping for the app.
Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center.
The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain.
For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath.
You must have a unique file and domain (or sub domain) per cross-platform app identity.
For example, a separate file and domain is needed for Word vs.
PowerPoint.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
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:
System.Collections.Hashtable
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AppActivityId
Required.
The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AppDisplayName
Optional.
Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-BodyParameter
userActivity
To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
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
-ContentInfo
Json
Parameter properties
Type:
System.Collections.Hashtable
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ContentUrl
Optional.
Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-CreatedDateTime
Set by the server.
DateTime in UTC when the object was created on the server.
Parameter properties
Type:
System.DateTime
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ExpirationDateTime
Set by the server.
DateTime in UTC when the object expired on the server.
Parameter properties
Type:
System.DateTime
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-FallbackUrl
Optional.
URL used to launch the activity in a web-based app, if available.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
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
-HistoryItems
Optional.
NavigationProperty/Containment; navigation property to the activity's historyItems.
To construct, see NOTES section for HISTORYITEMS properties and create a hash table.
Set by the server.
DateTime in UTC when the object was modified on the server.
Parameter properties
Type:
System.DateTime
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
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
-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
-Status
status
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UserId
The unique identifier of user
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateExpanded
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
Create
Position:
Named
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-UserTimezone
Optional.
The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
Parameter properties
Type:
System.String
Supports wildcards:
False
DontShow:
False
Parameter sets
CreateViaIdentityExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CreateExpanded
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VisualElements
visualInfo
To construct, see NOTES section for VISUALELEMENTS properties and create a hash table.
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 <IMicrosoftGraphUserActivity>: userActivity
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ActivationUrl <String>]: Required.
URL used to launch the activity in the best native experience represented by the appId.
Might launch a web-based app if no native app exists.
[ActivitySourceHost <String>]: Required.
URL for the domain representing the cross-platform identity mapping for the app.
Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center.
The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain.
For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath.
You must have a unique file and domain (or sub domain) per cross-platform app identity.
For example, a separate file and domain is needed for Word vs.
PowerPoint.
[AppActivityId <String>]: Required.
The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
[AppDisplayName <String>]: Optional.
Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
[ContentInfo <IMicrosoftGraphJson>]: Json
[(Any) <Object>]: This indicates any property can be added to this object.
[ContentUrl <String>]: Optional.
Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).
[CreatedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was created on the server.
[ExpirationDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object expired on the server.
[FallbackUrl <String>]: Optional.
URL used to launch the activity in a web-based app, if available.
[HistoryItems <IMicrosoftGraphActivityHistoryItem[]>]: Optional.
NavigationProperty/Containment; navigation property to the activity's historyItems.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ActiveDurationSeconds <Int32?>]: Optional.
The duration of active user engagement.
if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.
[Activity <IMicrosoftGraphUserActivity>]: userActivity
[CreatedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was created on the server.
[ExpirationDateTime <DateTime?>]: Optional.
UTC DateTime when the activityHistoryItem will undergo hard-delete.
Can be set by the client.
[LastActiveDateTime <DateTime?>]: Optional.
UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.
[LastModifiedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was modified on the server.
[StartedDateTime <DateTime?>]: Required.
UTC DateTime when the activityHistoryItem (activity session) was started.
Required for timeline history.
[Status <String>]: status
[UserTimezone <String>]: Optional.
The timezone in which the user's device used to generate the activity was located at activity creation time.
Values supplied as Olson IDs in order to support cross-platform representation.
[LastModifiedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was modified on the server.
[Status <String>]: status
[UserTimezone <String>]: Optional.
The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
[VisualElements <IMicrosoftGraphVisualInfo>]: visualInfo
[(Any) <Object>]: This indicates any property can be added to this object.
[Attribution <IMicrosoftGraphImageInfo>]: imageInfo
[(Any) <Object>]: This indicates any property can be added to this object.
[AddImageQuery <Boolean?>]: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization.
For example – a high contrast image
[AlternateText <String>]: Optional; alt-text accessible content for the image
[AlternativeText <String>]:
[IconUrl <String>]: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]: Optional.
Background color used to render the activity in the UI - brand color for the application source of the activity.
Must be a valid hex color
[Content <IMicrosoftGraphJson>]: Json
[Description <String>]: Optional.
Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)
[DisplayText <String>]: Required.
Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
HISTORYITEMS <IMicrosoftGraphActivityHistoryItem[]>: Optional.
NavigationProperty/Containment; navigation property to the activity's historyItems.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ActiveDurationSeconds <Int32?>]: Optional.
The duration of active user engagement.
if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.
[Activity <IMicrosoftGraphUserActivity>]: userActivity
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ActivationUrl <String>]: Required.
URL used to launch the activity in the best native experience represented by the appId.
Might launch a web-based app if no native app exists.
[ActivitySourceHost <String>]: Required.
URL for the domain representing the cross-platform identity mapping for the app.
Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center.
The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain.
For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath.
You must have a unique file and domain (or sub domain) per cross-platform app identity.
For example, a separate file and domain is needed for Word vs.
PowerPoint.
[AppActivityId <String>]: Required.
The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
[AppDisplayName <String>]: Optional.
Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
[ContentInfo <IMicrosoftGraphJson>]: Json
[(Any) <Object>]: This indicates any property can be added to this object.
[ContentUrl <String>]: Optional.
Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).
[CreatedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was created on the server.
[ExpirationDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object expired on the server.
[FallbackUrl <String>]: Optional.
URL used to launch the activity in a web-based app, if available.
[HistoryItems <IMicrosoftGraphActivityHistoryItem[]>]: Optional.
NavigationProperty/Containment; navigation property to the activity's historyItems.
[LastModifiedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was modified on the server.
[Status <String>]: status
[UserTimezone <String>]: Optional.
The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
[VisualElements <IMicrosoftGraphVisualInfo>]: visualInfo
[(Any) <Object>]: This indicates any property can be added to this object.
[Attribution <IMicrosoftGraphImageInfo>]: imageInfo
[(Any) <Object>]: This indicates any property can be added to this object.
[AddImageQuery <Boolean?>]: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization.
For example – a high contrast image
[AlternateText <String>]: Optional; alt-text accessible content for the image
[AlternativeText <String>]:
[IconUrl <String>]: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]: Optional.
Background color used to render the activity in the UI - brand color for the application source of the activity.
Must be a valid hex color
[Content <IMicrosoftGraphJson>]: Json
[Description <String>]: Optional.
Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)
[DisplayText <String>]: Required.
Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[CreatedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was created on the server.
[ExpirationDateTime <DateTime?>]: Optional.
UTC DateTime when the activityHistoryItem will undergo hard-delete.
Can be set by the client.
[LastActiveDateTime <DateTime?>]: Optional.
UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.
[LastModifiedDateTime <DateTime?>]: Set by the server.
DateTime in UTC when the object was modified on the server.
[StartedDateTime <DateTime?>]: Required.
UTC DateTime when the activityHistoryItem (activity session) was started.
Required for timeline history.
[Status <String>]: status
[UserTimezone <String>]: Optional.
The timezone in which the user's device used to generate the activity was located at activity creation time.
Values supplied as Olson IDs in order to support cross-platform representation.
INPUTOBJECT <ICrossDeviceExperiencesIdentity>: Identity Parameter
[ActivityHistoryItemId <String>]: The unique identifier of activityHistoryItem
[UserActivityId <String>]: The unique identifier of userActivity
[UserId <String>]: The unique identifier of user
VISUALELEMENTS <IMicrosoftGraphVisualInfo>: visualInfo
[(Any) <Object>]: This indicates any property can be added to this object.
[Attribution <IMicrosoftGraphImageInfo>]: imageInfo
[(Any) <Object>]: This indicates any property can be added to this object.
[AddImageQuery <Boolean?>]: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization.
For example – a high contrast image
[AlternateText <String>]: Optional; alt-text accessible content for the image
[AlternativeText <String>]:
[IconUrl <String>]: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]: Optional.
Background color used to render the activity in the UI - brand color for the application source of the activity.
Must be a valid hex color
[Content <IMicrosoftGraphJson>]: Json
[(Any) <Object>]: This indicates any property can be added to this object.
[Description <String>]: Optional.
Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)
[DisplayText <String>]: Required.
Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)