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 コマンドレットは、Azure Active Directory からグループを取得します。 このコマンドレットは、 ObjectId パラメーターを指定した場合、またはすべてのグループ内で検索する場合に、単一のグループを返すために使用できます。
例
例 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
このコマンドレットは、検出されたすべての結果を返します。 このパラメーターと MaxResults パラメーターは 指定しないでください。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-GroupType
取得するグループの種類を指定します。 有効な値は、Security、MailEnabledSecurity、DistributionList です。
| 型: | GroupType |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HasErrorsOnly
このコマンドレットは、検証エラーがあるグループのみを返します。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HasLicenseErrorsOnly
このコマンドレットがライセンス エラーを持つセキュリティ グループのみを返すかどうかを指定します。
| 型: | Boolean |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IsAgentRole
このコマンドレットがエージェント グループのみを返すように指定します。 この値は、パートナー ユーザーにのみ適用されます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-MaxResults
このコマンドレットが返す結果の最大数を指定します。 既定値は 250 です。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | 250 |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ObjectId
取得するグループの一意のオブジェクト ID を指定します。
| 型: | Guid |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SearchString
文字列を指定します。 このコマンドレットは、この文字列で始まる表示名を持つセキュリティ グループを返します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TenantId
操作を実行するテナントの一意の ID を指定します。 既定値は、現在のユーザーのテナントです。 このパラメーターは、パートナー ユーザーにのみ適用されます。
| 型: | Guid |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-UserObjectId
ユーザーの一意の ID を指定します。 このコマンドレットは、このユーザーが属するセキュリティ グループを返します。 このパラメーターは 、IsAgentRole パラメーターと共に使用する必要があります。
| 型: | Guid |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-UserPrincipalName
ユーザーのユーザー プリンシパル名を指定します。 このコマンドレットは、このユーザーが属するセキュリティ グループを返します。 このパラメーターは 、IsAgentRole パラメーターと共に使用する必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
出力
Microsoft.Online.Administration.Group
このコマンドレットは、次の情報を含むグループの一覧を返します。
CommonName。 グループの共通名。
説明 グループの説明。
DisplayName。 グループの表示名。
Emailaddress。 グループの電子メール アドレス。 セキュリティ グループの場合は返されません。
エラー。 グループのエラーの一覧。
GroupType。 グループの種類。 種類には、SecurityGroup、DistributionList、MailEnabledSecurityGroup を指定できます。
IsSystem。 このグループがシステム グループであるかどうか (Azure Active Directory によって作成されます)。 システム グループを更新または削除することはできません。
LastDirSyncTime。 グループが最後に同期された日時。
Managedby。 グループの所有者。
Objectid。 グループの一意のオブジェクト ID。
プロキシ アドレス。 このグループに関連付けられているプロキシ アドレス (メールが有効なグループの場合のみ)。
ValidationStatus。 グループにエラーがあるかどうか。