Share via

Get-MsolServicePrincipal

  • リファレンス
モジュール:
MSOnline

Azure Active Directory からサービス プリンシパルを取得します。

構文

Get-MsolServicePrincipal
   [-SearchString <String>]
   [-MaxResults <Int32>]
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolServicePrincipal
   -ObjectId <Guid>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolServicePrincipal
   -AppPrincipalId <Guid>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolServicePrincipal
   -ServicePrincipalName <String>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolServicePrincipal
   [-SearchString <String>]
   [-All]
   [-TenantId <Guid>]
   [<CommonParameters>]

説明

Get-MsolServicePrincipal コマンドレットは、Azure Active Directory からサービス プリンシパルまたはサービス プリンシパルの一覧を取得します。

例

例 1: すべてのサービス プリンシパルを表示する

PS C:\> Get-MsolServicePrincipal

このコマンドは、組織のテナント内のすべての既存のサービス プリンシパルを表示します。

例 2: 名前を使用してサービス プリンシパルを取得する

PS C:\> Get-MsolServicePrincipal -ServicePrincipalName "MyApp"

このコマンドは、MyApp で始まるサービス プリンシパル名を持つ既存のすべてのサービス プリンシパルを取得します。 これは、サービス プリンシパル名の appClass 部分のスラッシュまでの完全一致です。

例 3: サービス プリンシパルを取得する

PS C:\> Get-MsolServicePrincipal -AppPrincipalId 5e964d2f-e384-4292-ae55-dd24c89cc53b

このコマンドは、特定のアプリケーション プリンシパル ID を持つサービス プリンシパルを取得します。

パラメーター

-All

このコマンドレットによってすべての結果が返されることを示します。 MaxResults パラメーターと共に指定しないでください。

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

-AppPrincipalId

取得するサービス プリンシパルの一意のアプリケーション ID を指定します。

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

-MaxResults

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

Type:Int32
Position:Named
Default value:500
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:True
Accept wildcard characters:False

-ServicePrincipalName

取得するサービス プリンシパルまたはサービス プリンシパルの名前を指定します。 SPN では、次のいずれかの形式を使用する必要があります。

  • appName
  • appName/hostname
  • 有効な URL

AppName はアプリケーションの名前を表し、ホスト名はアプリケーションの URI 機関を表します。

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

-TenantId

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

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

出力

Microsoft.Online.Administration.ServicePrincipal[]

このコマンドレットは、Azure Active Directory からサービス プリンシパルまたはサービス プリンシパルの一覧を返します。 各サービス プリンシパルには次の情報が含まれています。

  • Objectid。 サービス プリンシパルの一意の識別子。
  • AppPrincipalId。 サービス プリンシパルのアプリケーション識別子。
  • DisplayName。 サービス プリンシパルのフレンドリ名。
  • ServicePrincipalName。 サービス プリンシパルに関連付けられているサービス プリンシパル名 (SPN) の一覧。
  • AccountEnabled。 アカウントが有効かどうかを示す値。