Get-MsolGroup

モジュール:

MSOnline

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 つのグループを返すために使用できます。

例

例 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 パラメーターは 指定しないでください。

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

-GroupType

取得するグループの種類を指定します。 有効な値は、Security、MailEnabledSecurity、DistributionList です。

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

-HasErrorsOnly

このコマンドレットは、検証エラーが発生したグループのみを返すかどうかを示します。

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

-HasLicenseErrorsOnly

このコマンドレットが、ライセンス エラーがあるセキュリティ グループのみを返すかどうかを指定します。

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

-IsAgentRole

このコマンドレットがエージェント グループのみを返すように指定します。 この値は、パートナー ユーザーにのみ適用されます。

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

-MaxResults

このコマンドレットから返される結果の最大数を指定します。 既定値は 250 です。

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

-ObjectId

取得するグループの一意のオブジェクト ID を指定します。

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

-SearchString

文字列を指定します。 このコマンドレットは、この文字列で始まる表示名を持つセキュリティ グループを返します。

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

-TenantId

操作を実行するテナントの一意の ID を指定します。 既定値は、現在のユーザーのテナントです。 このパラメーターは、パートナー ユーザーにのみ適用されます。

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

-UserObjectId

ユーザーの一意の ID を指定します。 このコマンドレットは、このユーザーが属するセキュリティ グループを返します。 このパラメーターは 、IsAgentRole パラメーターと共に使用する必要があります。

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

-UserPrincipalName

ユーザーのユーザー プリンシパル名を指定します。 このコマンドレットは、このユーザーが属するセキュリティ グループを返します。 このパラメーターは 、IsAgentRole パラメーターと共に使用する必要があります。

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

出力

Microsoft.Online.Administration.Group

このコマンドレットは、次の情報を含むグループの一覧を返します。

• CommonName。 グループの共通名。

• 説明 グループの説明。

• DisplayName。 グループの表示名。

• Emailaddress。 グループの電子メール アドレス。 セキュリティ グループの場合は返されません。

• エラー。 グループのエラーの一覧。

• GroupType。 グループの種類。 種類には、SecurityGroup、DistributionList、MailEnabledSecurityGroup を指定できます。

• IsSystem。 このグループがシステム グループかどうか (Azure Active Directory によって作成されます)。 システム グループを更新または削除することはできません。

• LastDirSyncTime。 グループが最後に同期された日時。

• Managedby。 グループの所有者。

• Objectid。 グループの一意のオブジェクト ID。

• プロキシ アドレス。 このグループに関連付けられているプロキシ アドレス (メールが有効なグループの場合のみ)。

• ValidationStatus。 グループにエラーがあるかどうか。

関連リンク

• New-MsolGroup
• Remove-MsolGroup
• Set-MsolGroup