New-MgSearchBookmark
Create a new bookmark object.
Note
To view the beta release of this cmdlet, view New-MgBetaSearchBookmark
New-MgSearchBookmark
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AvailabilityEndDateTime <DateTime>]
[-AvailabilityStartDateTime <DateTime>]
[-Categories <String[]>]
[-Description <String>]
[-DisplayName <String>]
[-GroupIds <String[]>]
[-Id <String>]
[-IsSuggested]
[-Keywords <IMicrosoftGraphSearchAnswerKeyword>]
[-LanguageTags <String[]>]
[-LastModifiedBy <IMicrosoftGraphSearchIdentitySet>]
[-LastModifiedDateTime <DateTime>]
[-Platforms <DevicePlatformType[]>]
[-PowerAppIds <String[]>]
[-State <String>]
[-TargetedVariations <IMicrosoftGraphSearchAnswerVariant[]>]
[-WebUrl <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgSearchBookmark
-BodyParameter <IMicrosoftGraphSearchBookmark>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create a new bookmark object.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | SearchConfiguration.Read.All | SearchConfiguration.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | SearchConfiguration.Read.All | SearchConfiguration.ReadWrite.All |
Import-Module Microsoft.Graph.Search
$params = @{
displayName = "Contoso Install Site"
webUrl = "http://www.contoso.com/"
description = "Try or buy Contoso for Home or Business and view product information"
keywords = @{
keywords = @(
"Contoso"
"install"
)
reservedKeywords = @(
"Unique keyword"
)
matchSimilarKeywords = $true
}
availabilityStartDateTime = $null
availabilityEndDateTime = $null
platforms = @(
"windows"
)
targetedVariations = @(
@{
languageTag = "es-es"
displayName = "Sitio de instalación Contoso"
description = "Pruebe o compre Contoso hogar o negocios y vea la información del producto"
}
)
state = "published"
}
New-MgSearchBookmark -BodyParameter $params
This example shows how to use the New-MgSearchBookmark Cmdlet.
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
bookmark To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphSearchBookmark |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Categories commonly used to describe this bookmark. For example, IT and HR.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The search answer description that is shown on the search results page.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The search answer name that is displayed in search results.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The list of security groups that are able to view this bookmark.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
True if this bookmark was suggested to the admin, by a user, or was mined and suggested by Microsoft. Read-only.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
answerKeyword To construct, see NOTES section for KEYWORDS properties and create a hash table.
Type: | IMicrosoftGraphSearchAnswerKeyword |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
identitySet To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.
Type: | IMicrosoftGraphSearchIdentitySet |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | DevicePlatformType[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
answerState
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Variations of a bookmark for different countries 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.
Type: | IMicrosoftGraphSearchAnswerVariant[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The URL link for the search answer. When users select this search answer from the search results, they are directed to the specified URL.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSearchBookmark
System.Collections.IDictionary
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSearchBookmark
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.
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 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.
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 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.