Get-MgSite

Module:

Microsoft.Graph.Sites

Retrieve properties and relationships for a site resource.A site resource represents a team site in SharePoint.

Note

To view the beta release of this cmdlet, view Get-MgBetaSite

Syntax

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

Get-MgSite
   -SiteId <String>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Get-MgSite
   -InputObject <ISitesIdentity>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Retrieve properties and relationships for a site resource.A site resource represents a team site in SharePoint.

Permissions

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

Examples

Example 1: List sites using query parameters

Import-Module Microsoft.Graph.Sites

Get-MgSite -Property "siteCollection,webUrl" -Filter "siteCollection/root ne null"

This example will list sites using query parameters

Example 2: List all sites

Import-Module Microsoft.Graph.Sites

Get-MgSite

This example will list all sites

Parameters

-All

List all pages.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	String
Aliases:	CV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExpandProperty

Expand related entities

Type:	String[]
Aliases:	Expand
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Filter items by property values

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ISitesIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PageSize

Sets the page size of results.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Property

Select properties to be returned

Type:	String[]
Aliases:	Select
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Search

Search items by search phrases

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SiteId

The unique identifier of site

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Skip the first n items

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Sort

Order items by property values

Type:	String[]
Aliases:	OrderBy
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Top

Show only the first n items

Type:	Int32
Aliases:	Limit
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.ISitesIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSite

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

• [BaseItemId <String>]: The unique identifier of baseItem
• [BaseSitePageId <String>]: The unique identifier of baseSitePage
• [ColumnDefinitionId <String>]: The unique identifier of columnDefinition
• [ColumnLinkId <String>]: The unique identifier of columnLink
• [ContentTypeId <String>]: The unique identifier of contentType
• [ContentTypeId1 <String>]: The unique identifier of contentType
• [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
• [DriveId <String>]: The unique identifier of drive
• [EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
• [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}
• [Interval <String>]: Usage: interval='{interval}'
• [ItemActivityId <String>]: The unique identifier of itemActivity
• [ItemActivityStatId <String>]: The unique identifier of itemActivityStat
• [ListId <String>]: The unique identifier of list
• [ListItemId <String>]: The unique identifier of listItem
• [ListItemVersionId <String>]: The unique identifier of listItemVersion
• [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
• [Path <String>]: Usage: path='{path}'
• [PermissionId <String>]: The unique identifier of permission
• [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
• [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}'
• [StoreId <String>]: The unique identifier of store
• [SubscriptionId <String>]: The unique identifier of subscription
• [TermId <String>]: The unique identifier of term
• [TermId1 <String>]: The unique identifier of term
• [Token <String>]: Usage: token='{token}'
• [UserId <String>]: The unique identifier of user
• [WebPartId <String>]: The unique identifier of webPart

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.sites/get-mgsite
• https://learn.microsoft.com/graph/api/site-get?view=graph-rest-1.0
• https://learn.microsoft.com/graph/api/site-search?view=graph-rest-1.0