Compartilhar via

Get-MgGroupByUniqueName

  • Reference
Module:
Microsoft.Graph.Groups

Get the properties and relationships of a group object. This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that aren't_ returned by default, specify them in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and aren't returned in the $select query.

Note

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

Syntax

Get-MgGroupByUniqueName
   -UniqueName <String>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgGroupByUniqueName
   -InputObject <IGroupsIdentity>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get the properties and relationships of a group object. This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that aren't_ returned by default, specify them in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and aren't returned in the $select query.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) GroupMember.Read.All Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application GroupMember.Read.All Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All

Parameters

-ExpandProperty

Expand related entities

Type:String[]
Aliases:Expand
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:IGroupsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-UniqueName

Alternate key of group

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

Inputs

Microsoft.Graph.PowerShell.Models.IGroupsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroup

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

  • [AttachmentId <String>]: The unique identifier of attachment
  • [BaseSitePageId <String>]: The unique identifier of baseSitePage
  • [ContentTypeId <String>]: The unique identifier of contentType
  • [ConversationId <String>]: The unique identifier of conversation
  • [ConversationThreadId <String>]: The unique identifier of conversationThread
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
  • [DriveId <String>]: The unique identifier of drive
  • [DriveItemId <String>]: The unique identifier of driveItem
  • [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
  • [EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
  • [EventId <String>]: The unique identifier of event
  • [ExtensionId <String>]: The unique identifier of extension
  • [GroupId <String>]: The unique identifier of group
  • [GroupLifecyclePolicyId <String>]: The unique identifier of groupLifecyclePolicy
  • [GroupSettingId <String>]: The unique identifier of groupSetting
  • [GroupSettingTemplateId <String>]: The unique identifier of groupSettingTemplate
  • [HorizontalSectionColumnId <String>]: The unique identifier of horizontalSectionColumn
  • [HorizontalSectionId <String>]: The unique identifier of horizontalSection
  • [IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks}
  • [Interval <String>]: Usage: interval='{interval}'
  • [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
  • [OnenotePageId <String>]: The unique identifier of onenotePage
  • [OnenoteSectionId <String>]: The unique identifier of onenoteSection
  • [Path <String>]: Usage: path='{path}'
  • [PermissionId <String>]: The unique identifier of permission
  • [PostId <String>]: The unique identifier of post
  • [ProfilePhotoId <String>]: The unique identifier of profilePhoto
  • [Q <String>]: Usage: q='{q}'
  • [ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant
  • [SiteId <String>]: The unique identifier of site
  • [StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
  • [SubscriptionId <String>]: The unique identifier of subscription
  • [Token <String>]: Usage: token='{token}'
  • [UniqueName <String>]: Alternate key of group
  • [User <String>]: Usage: User='{User}'
  • [WebPartId <String>]: The unique identifier of webPart