Get-MsolServicePrincipalCredential

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

サービス プリンシパルに関連付けられている資格情報を取得します。

構文

Get-MsolServicePrincipalCredential
   -ObjectId <Guid>
   -ReturnKeyValues <Boolean>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolServicePrincipalCredential
   -ReturnKeyValues <Boolean>
   -AppPrincipalId <Guid>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolServicePrincipalCredential
   -ReturnKeyValues <Boolean>
   -ServicePrincipalName <String>
   [-TenantId <Guid>]
   [<CommonParameters>]

説明

Get-MsolServicePrincipalCredential コマンドレットは、サービス プリンシパルに関連付けられている資格情報を取得します。

例

例 1: 資格情報のプロパティを取得する

PS C:\> Get-MsolServicePrincipalCredential -ServicePrincipalName "MyApp/myApp.com"

このコマンドは、サービス プリンシパル名 (SPN) MyApp/myApp.com に関連付けられている資格情報の値を除くすべての資格情報プロパティを取得します。 SPN は appClass/hostname という形式に従う必要があります。appClass はアプリケーション クラス ("MyApp") を表し、hostname はアプリケーションのホスト名 (myApp.com) を表します。

パラメーター

-AppPrincipalId

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

型:Guid
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ObjectId

資格情報を取得するサービス プリンシパルの一意のオブジェクト ID を指定します。

型:Guid
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ReturnKeyValues

このコマンドレットがキー値を返すかどうかを示します。

型:Boolean
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ServicePrincipalName

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

  • appName
  • appName/hostname
  • 有効な URL

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-TenantId

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

型:Guid
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

出力

Microsoft.Online.Administration.ServicePrincipalCredential[]

このコマンドレットは、サービス プリンシパルに関連付けられている資格情報を返します。 返される各オブジェクトには、次の情報が含まれます。

  • [Type](種類)。 サービス プリンシパル資格情報の種類 (非対称/対称/パスワード)。
  • Value。 資格情報の値。
    • 資格情報の種類が証明書の場合、これは Base 64 エンコード証明書を表します。
    • 資格情報の種類が対称の場合は、AES キーを表します。
  • KeyGroupId。 内部使用のために予約されている識別子。
  • KeyId。 キーの一意識別子。
  • Startdate。 資格情報の使用の有効な開始日。
  • Enddate。 資格情報の使用の有効な終了日。
  • 使用方法 : トークンの "署名" または "検証" に資格情報を使用するかどうかを指定します。