Import-Module Microsoft.Graph.Search
$params = @{
description = "Book a fancy vacation in Tuscany or browse museums in Florence."
}
Update-MgSearchBookmark -BookmarkId $bookmarkId -BodyParameter $params
This example shows how to use the Update-MgSearchBookmark Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
Type:
System.Collections.Hashtable
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
-AvailabilityEndDateTime
Date and time when the bookmark stops appearing as a search result.
Set as null for always available.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
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
-AvailabilityStartDateTime
Date and time when the bookmark starts to appear as a search result.
Set as null for always available.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
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
-BodyParameter
bookmark
To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
A list of geographically specific language names in which this bookmark can be viewed.
Each language tag value follows the pattern {language}-{region}.
For example, en-us is English as used in the United States.
For the list of possible values, see Supported language tags.
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
-LastModifiedBy
identitySet
To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.
Date and time when the search answer was created or last edited.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Read-only.
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
-Platforms
List of devices and operating systems that are able to view this bookmark.
Possible values are: android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue.
List of Power Apps associated with this bookmark.
If users add existing Power Apps to a bookmark, they can complete tasks directly on the search results page, such as entering vacation time or reporting expenses.
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
-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
-State
answerState
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
-TargetedVariations
Variations of a bookmark for different countries/regions or devices.
Use when you need to show different content to users based on their device, country/region, or both.
The date and group settings apply to all variations.
To construct, see NOTES section for TARGETEDVARIATIONS properties and create a hash table.
The URL link for the search answer.
When users select this search answer from the search results, they are directed to the specified URL.
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
-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 <IMicrosoftGraphSearchBookmark>: bookmark
[(Any) <Object>]: This indicates any property can be added to this object.
[Description <String>]: The search answer description that is shown on the search results page.
[DisplayName <String>]: The search answer name that is displayed in search results.
[LastModifiedBy <IMicrosoftGraphSearchIdentitySet>]: identitySet
[(Any) <Object>]: This indicates any property can be added to this object.
[Application <IMicrosoftGraphSearchIdentity>]: identity
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]:
[Id <String>]:
[Device <IMicrosoftGraphSearchIdentity>]: identity
[User <IMicrosoftGraphSearchIdentity>]: identity
[LastModifiedDateTime <DateTime?>]: Date and time when the search answer was created or last edited.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Read-only.
[WebUrl <String>]: The URL link for the search answer.
When users select this search answer from the search results, they are directed to the specified URL.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AvailabilityEndDateTime <DateTime?>]: Date and time when the bookmark stops appearing as a search result.
Set as null for always available.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[AvailabilityStartDateTime <DateTime?>]: Date and time when the bookmark starts to appear as a search result.
Set as null for always available.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[Categories <String[]>]: Categories commonly used to describe this bookmark.
For example, IT and HR.
[GroupIds <String[]>]: The list of security groups that are able to view this bookmark.
[IsSuggested <Boolean?>]: True if this bookmark was suggested to the admin, by a user, or was mined and suggested by Microsoft.
Read-only.
[Keywords <IMicrosoftGraphSearchAnswerKeyword>]: answerKeyword
[(Any) <Object>]: This indicates any property can be added to this object.
[Keywords <String[]>]: A collection of keywords used to trigger the search answer.
[MatchSimilarKeywords <Boolean?>]: If true, indicates that the search term contains similar words to the keywords that should trigger the search answer.
[ReservedKeywords <String[]>]: Unique keywords that guarantee the search answer is triggered.
[LanguageTags <String[]>]: A list of geographically specific language names in which this bookmark can be viewed.
Each language tag value follows the pattern {language}-{region}.
For example, en-us is English as used in the United States.
For the list of possible values, see Supported language tags.
[Platforms <DevicePlatformType[]>]: List of devices and operating systems that are able to view this bookmark.
Possible values are: android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue.
[PowerAppIds <String[]>]: List of Power Apps associated with this bookmark.
If users add existing Power Apps to a bookmark, they can complete tasks directly on the search results page, such as entering vacation time or reporting expenses.
[State <String>]: answerState
[TargetedVariations <IMicrosoftGraphSearchAnswerVariant[]>]: Variations of a bookmark for different countries/regions or devices.
Use when you need to show different content to users based on their device, country/region, or both.
The date and group settings apply to all variations.
[Description <String>]: The answer variation description that is shown on the search results page.
[DisplayName <String>]: The answer variation name that is displayed in search results.
[LanguageTag <String>]: The country or region that can view this answer variation.
[Platform <DevicePlatformType?>]: Supported platform types.
[WebUrl <String>]: The URL link for the answer variation.
When users select this answer variation from the search results, they're directed to the specified URL.
INPUTOBJECT <ISearchIdentity>: Identity Parameter
[AcronymId <String>]: The unique identifier of acronym
[BookmarkId <String>]: The unique identifier of bookmark
[ConnectionOperationId <String>]: The unique identifier of connectionOperation
[ExternalActivityId <String>]: The unique identifier of externalActivity
[ExternalConnectionId <String>]: The unique identifier of externalConnection
[ExternalGroupId <String>]: The unique identifier of externalGroup
[ExternalItemId <String>]: The unique identifier of externalItem
[IdentityId <String>]: The unique identifier of identity
[QnaId <String>]: The unique identifier of qna
KEYWORDS <IMicrosoftGraphSearchAnswerKeyword>: answerKeyword
[(Any) <Object>]: This indicates any property can be added to this object.
[Keywords <String[]>]: A collection of keywords used to trigger the search answer.
[MatchSimilarKeywords <Boolean?>]: If true, indicates that the search term contains similar words to the keywords that should trigger the search answer.
[ReservedKeywords <String[]>]: Unique keywords that guarantee the search answer is triggered.
LASTMODIFIEDBY <IMicrosoftGraphSearchIdentitySet>: identitySet
[(Any) <Object>]: This indicates any property can be added to this object.
[Application <IMicrosoftGraphSearchIdentity>]: identity
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]:
[Id <String>]:
[Device <IMicrosoftGraphSearchIdentity>]: identity
[User <IMicrosoftGraphSearchIdentity>]: identity
TARGETEDVARIATIONS <IMicrosoftGraphSearchAnswerVariant[]>: Variations of a bookmark for different countries/regions or devices.
Use when you need to show different content to users based on their device, country/region, or both.
The date and group settings apply to all variations.
[Description <String>]: The answer variation description that is shown on the search results page.
[DisplayName <String>]: The answer variation name that is displayed in search results.
[LanguageTag <String>]: The country or region that can view this answer variation.
[Platform <DevicePlatformType?>]: Supported platform types.
[WebUrl <String>]: The URL link for the answer variation.
When users select this answer variation from the search results, they're directed to the specified URL.