你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-MsolGroup

从 Azure Active Directory 获取组。

语法

Get-MsolGroup
   [-UserObjectId <Guid>]
   [-IsAgentRole]
   [-UserPrincipalName <String>]
   [-GroupType <GroupType>]
   [-HasErrorsOnly]
   [-HasLicenseErrorsOnly <Boolean>]
   [-SearchString <String>]
   [-MaxResults <Int32>]
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolGroup
   -ObjectId <Guid>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolGroup
   [-UserObjectId <Guid>]
   [-IsAgentRole]
   [-UserPrincipalName <String>]
   [-GroupType <GroupType>]
   [-HasErrorsOnly]
   [-HasLicenseErrorsOnly <Boolean>]
   [-SearchString <String>]
   [-All]
   [-TenantId <Guid>]
   [<CommonParameters>]

说明

Get-MsolGroup cmdlet 从 Azure Active Directory 获取组。 如果指定 ObjectId 参数,则此 cmdlet 可用于返回单个组,或用于在所有组中搜索。

示例

示例 1:使用 ID 获取组

PS C:\> Get-MsolGroup -ObjectId af407072-7ae1-4b07-a0ca-6634b7396054

此命令返回具有指定 ID 的组对象。

示例 2:获取所有组

PS C:\> Get-MsolGroup

此命令返回租户的整个组集,最多返回默认的 250 个结果。

示例 3:使用用户主体名称获取组

PS C:\> Get-MsolGroup -isAgentRole -UserPrincipalName "pattifuller@contoso.com"

此命令将返回用户所属的代理组。 这只适用于拥有合作伙伴权限的公司。

参数

-All

指示此 cmdlet 返回它找到的所有结果。 不要指定此参数和 MaxResults 参数。

类型:SwitchParameter
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-GroupType

指定要获取的组的类型。 有效值为 Security、MailEnabledSecurity 和 DistributionList。

类型:GroupType
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-HasErrorsOnly

指示此 cmdlet 仅返回具有验证错误的组。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-HasLicenseErrorsOnly

指定此 cmdlet 是否仅返回具有许可证错误的安全组。

类型:Boolean
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-IsAgentRole

指定此 cmdlet 仅返回代理组。 此值仅适用于合作伙伴用户。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-MaxResults

指定此 cmdlet 返回的最大结果数。 默认值为 250。

类型:Int32
Position:Named
默认值:250
必需:False
接受管道输入:False
接受通配符:False

-ObjectId

指定要获取的组的唯一对象 ID。

类型:Guid
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-SearchString

指定字符串。 此 cmdlet 返回显示名称以此字符串开头的安全组。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TenantId

指定要对其执行操作的租户的唯一 ID。 默认值为当前用户的租户。 此参数仅适用于合作伙伴用户。

类型:Guid
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-UserObjectId

指定用户的唯一 ID。 此 cmdlet 返回此用户所属的安全组。 此参数必须与 IsAgentRole 参数一起使用。

类型:Guid
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-UserPrincipalName

指定用户的用户主体名称。 此 cmdlet 返回此用户所属的安全组。 此参数必须与 IsAgentRole 参数一起使用。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输出

Microsoft.Online.Administration.Group

此 cmdlet 返回组列表,其中包括以下信息:

  • CommonName。 组的通用名称。

  • 说明。 组的说明。

  • DisplayName。 组的显示名称。

  • EmailAddress。 组的电子邮件地址。 将不返回安全组的此信息。

  • “错误”。 组的错误列表。

  • GroupType。 组的类型。 类型可以是 SecurityGroup、DistributionList 或 MailEnabledSecurityGroup。

  • IsSystem。 此组是否是由 Azure Active Directory) 创建的 (系统组。 无法更新或删除这些组。

  • LastDirSyncTime。 上次同步组的日期和时间。

  • ManagedBy。 组的所有者。

  • ObjectId。 组的唯一对象 ID。

  • 代理地址。 与此组关联的代理地址 (启用邮件的组仅) 。

  • ValidationStatus。 组是否出现任何错误。