Get-MgBetaSearchBookmark

Module:

Microsoft.Graph.Beta.Search Module

Read the properties and relationships of a bookmark object.

Note

To view the v1.0 release of this cmdlet, view Get-MgSearchBookmark

Syntax

List (Default)

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

Get

Get-MgBetaSearchBookmark
    -BookmarkId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaSearchBookmark
    -InputObject <ISearchIdentity>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

Description

Read the properties and relationships of a bookmark object.

Permissions

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

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Search

Get-MgBetaSearchBookmark

This example shows how to use the Get-MgBetaSearchBookmark Cmdlet.

Parameters

-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

-BookmarkId

The unique identifier of bookmark

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

-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:	ISearchIdentity
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.Beta.PowerShell.Models.ISearchIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphSearchBookmark

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 <ISearchIdentity>: Identity Parameter

• [AcronymId <String>]: The unique identifier of acronym
• [AuthorizationSystemId <String>]: The unique identifier of authorizationSystem
• [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
• [InboundFlowId <String>]: The unique identifier of inboundFlow
• [IndustryDataConnectorId <String>]: The unique identifier of industryDataConnector
• [IndustryDataRunActivityId <String>]: The unique identifier of industryDataRunActivity
• [IndustryDataRunId <String>]: The unique identifier of industryDataRun
• [LongRunningOperationId <String>]: The unique identifier of longRunningOperation
• [OutboundProvisioningFlowSetId <String>]: The unique identifier of outboundProvisioningFlowSet
• [ProvisioningFlowId <String>]: The unique identifier of provisioningFlow
• [QnaId <String>]: The unique identifier of qna
• [ReferenceDefinitionId <String>]: The unique identifier of referenceDefinition
• [RoleGroupId <String>]: The unique identifier of roleGroup
• [SourceSystemDefinitionId <String>]: The unique identifier of sourceSystemDefinition
• [YearTimePeriodDefinitionId <String>]: The unique identifier of yearTimePeriodDefinition

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.search/get-mgbetasearchbookmark
• https://learn.microsoft.com/graph/api/search-bookmark-get?view=graph-rest-beta
• https://learn.microsoft.com/graph/api/search-searchentity-list-bookmarks?view=graph-rest-beta