New-MsolServicePrincipalCredential

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

サービス プリンシパルに資格情報キーを追加します。

構文

New-MsolServicePrincipalCredential
   -ObjectId <Guid>
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]
New-MsolServicePrincipalCredential
   -ServicePrincipalName <String>
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]
New-MsolServicePrincipalCredential
   -AppPrincipalId <Guid>
   [-Type <ServicePrincipalCredentialType>]
   [-Value <String>]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [-Usage <ServicePrincipalCredentialUsage>]
   [-TenantId <Guid>]
   [<CommonParameters>]

説明

New-MsolServicePrincipalCredential コマンドレットは、サービス プリンシパルに新しい資格情報を追加するか、アプリケーションの資格情報キーを追加またはロールします。 サービス プリンシパルは、オブジェクト ID、アプリ プリンシパル ID、またはサービス プリンシパル名 (SPN) を指定することによって識別されます。

例

例 1: サービス プリンシパルに資格情報を追加する

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

このコマンドは、資格情報 (キー) オブジェクトを既存のサービス プリンシパルに追加します。 この例では、この資格情報の対称キーが生成され、MyApp/myApp.com のサービス プリンシパル名の値を使用してサービス プリンシパルに追加されます。

例 2: 既存の資格情報をサービス プリンシパルに追加する

PS C:\> $Certificate = New-Object System.Security.Cryptography.X509Certificates.X509Certificate
PS C:\> $Certificate.Import("C:\myapp.cer")
PS C:\> $BinCert = $Certificate.GetRawCertData()
PS C:\> $CredValue = [System.Convert]::ToBase64String($binCert);
PS C:\> New-MsolServicePrincipalCredential -ServicePrincipalName "MyApp/myApp.com" -Type asymmetric -Value $CredValue -StartDate $Certificate.GetEffectiveDateString() -EndDate $Certificate.GetExpirationDateString()

この例では、資格情報またはキーオブジェクトを既存のサービス プリンシパルに追加します。 この例では、myapp/myApp.com のサービス プリンシパル名の値を使用して、myapp.cer という名前の指定された base64 でエンコードされたパブリック X509 証明書がサービス プリンシパルに追加されます。

例 3: オンプレミスのExchange Serverを登録する

PS C:\> New-MsolServicePrincipalCredential -AppPrincipalId  -Type asymmetric -Value $CredValue

このコマンドは、オンプレミスのExchange Serverを登録して、Exchange ServerサービスとMicrosoft Azure Active Directory サービス (Office 365 など) 間の通信を行えるようにします。 この例では、$credValue に含まれる base64 エンコードされた公開 X509 証明書を使用して、オンプレミスの Exchange Server を表します。 Office 365 サーバーの既知の ID は次のとおりです。

  • Exchange: 00000002-0000-0ff1-ce00-00000000000
  • SharePoint: 00000003-0000-0ff1-ce00-00000000000
  • Lync: 00000004-0000-0ff1-ce00-00000000000

パラメーター

-AppPrincipalId

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

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

-EndDate

資格情報の使用の有効終了日を指定します。 既定値は今日から 1 年です。 非対称型の資格情報の場合は、X509 証明書が有効になるまで有効な日付以前に設定する必要があります。それ以外の場合、このアプリケーションに対して OAuth トークンは発行されません。

Type:DateTime
Position:Named
Default value:Today + 1 year
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

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

Type:Guid
Position:Named
Default value:None
Required:True
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

-StartDate

資格情報の使用の有効な開始日を指定します。 既定値は今日です。 非対称型の資格情報の場合は、X509 証明書が有効な日付以降に設定する必要があります。それ以外の場合、このアプリケーションに対して OAuth トークンは発行されません。

Type:DateTime
Position:Named
Default value:Today
Required:False
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

-Type

使用する資格情報の種類を指定します。 有効な値は次のとおりです。

  • 非対称
  • 対称
  • password

既定値は対称です。

Type:ServicePrincipalCredentialType
Position:Named
Default value:Symmetric
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Usage

資格情報キーの使用法を指定します。 資格情報キーの使用法は、トークンに署名または検証するように設定できます。 既定値は verify です。 署名は対称キーに対してのみ許可されます。 すべてのキーの種類に対して許可されていることを確認します。

要求トークンがこのサービス プリンシパルによって表されるアプリケーションによって送信されたことを確認するには、Azure Active Directory ディレクトリで検証資格情報キーが必要です。

アプリケーションでは、必要に応じて、azure Active Directory サービスが、Microsoft Azure Active Directoryを識別する非対称公開キーではなく、署名キーで署名されたアプリケーションにトークンを発行することを要求する場合があります。 この場合は、サービス プリンシパルの署名資格情報キーを指定します。

Type:ServicePrincipalCredentialUsage
Position:Named
Default value:Verify
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Value

資格情報の値を指定します。

  • 資格情報の種類が非対称の場合、値は base 64 でエンコードされた証明書を表します。
  • 資格情報の種類が対称で 、Value パラメーターが指定されていない場合、256 ビットの AES キーが自動的に作成され、作成から 1 年間有効になります。
  • 資格情報の種類がパスワードの場合は、値を指定 します。 Base 64 でエンコードしないでください。
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False