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>]
Description
Get-MsolGroup Cmdlet 會從 Azure Active Directory 取得群組。 如果您指定 ObjectId 參數,或搜尋所有群組內,可以使用這個 Cmdlet 來傳回單一群組。
範例
範例 1:使用標識碼取得群組
PS C:\> Get-MsolGroup -ObjectId af407072-7ae1-4b07-a0ca-6634b7396054
此命令會傳回具有指定標識碼的群組物件。
範例 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
指定要取得之群組的唯一對象識別碼。
類型: | Guid |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-SearchString
指定字串。 此 Cmdlet 會傳回具有以這個字串開頭之顯示名稱的安全組。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-TenantId
指定要執行作業之租使用者的唯一標識符。 預設值是目前使用者的租使用者。 此參數僅適用於合作夥伴使用者。
類型: | Guid |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-UserObjectId
指定使用者的唯一識別碼。 此 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。 群組的唯一物件識別碼。
Proxy 位址。 與這個群組相關聯的 Proxy 位址, (僅) 啟用郵件的群組。
ValidationStatus。 群組是否有任何錯誤。