New-MsolServicePrincipalCredential
サービス プリンシパルに資格情報キーを追加します。
構文
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:\> $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()
次の使用例は、資格情報 (キー) オブジェクトを既存のサービス プリンシパルに追加します。 この例では、指定された base64 でエンコードされたパブリック X509 証明書 (myapp.cer という名前) が、MyApp/myApp.com のサービス プリンシパル名の値を使用してサービス プリンシパルに追加されます。
例 2: オンプレミスのExchange Serverを登録する
PS C:\> New-MsolServicePrincipalCredential -AppPrincipalId -Type asymmetric -Value $CredValue
このコマンドは、オンプレミスのExchange Serverを登録して、Exchange ServerとOffice 365などのMicrosoft Azure Active Directoryサービス間の通信が行われるようにします。 この例では、$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-000000000000
パラメーター
-AppPrincipalId
資格情報を追加するサービス プリンシパルのアプリケーション ID を指定します。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-EndDate
資格情報の使用の有効な終了日を指定します。 既定値は、今日から 1 年です。 非対称型の資格情報の場合は、X509 証明書が有効になるまで有効な日付以前に設定する必要があります。それ以外の場合、このアプリケーションに対して OAuth トークンは発行されません。
型: | DateTime |
配置: | Named |
規定値: | Today + 1 year |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ObjectId
資格情報を追加するサービス プリンシパルの一意のオブジェクト ID を指定します。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ServicePrincipalName
資格情報を追加するサービス プリンシパルの名前を指定します。 SPN では、次のいずれかの形式を使用する必要があります。
appName
appName/hostname
- 有効な URL
AppName は、アプリケーションの名前を表します。 Hostname は、アプリケーションの URI 機関を表します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StartDate
資格情報の使用の有効な開始日を指定します。 既定値は現在です。 非対称型の資格情報の場合、X509 証明書が有効な日付以降に設定する必要があります。それ以外の場合、このアプリケーションに対して OAuth トークンは発行されません。
型: | DateTime |
配置: | Named |
規定値: | Today |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TenantId
操作を実行するテナントの一意の ID を指定します。 既定値は、現在のユーザーのテナントです。 このパラメーターは、パートナー ユーザーにのみ適用されます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Type
使用する資格情報の種類を指定します。 有効な値は次のとおりです。
- 非対称
- 対称
- password
既定値は対称です。
重要
非対称キーを使用することをお勧めします。 対称キーはセキュリティで保護されていないため、Microsoft ファースト パーティ アプリケーションにアクセスするサービス プリンシパルでは無効になります。
型: | ServicePrincipalCredentialType |
配置: | Named |
規定値: | Symmetric |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Usage
資格情報キーの使用法を指定します。 資格情報キーの使用法は、トークンに署名または検証するように設定できます。 既定値は verify です。 記号は対称キーに対してのみ許可されます。 すべてのキーの種類に対してが許可されていることを確認します。
要求トークンがこのサービス プリンシパルによって表されるアプリケーションによって送信されたことを確認するには、Azure Active Directory ディレクトリで資格情報の確認キーが必要です。
アプリケーションでは、必要に応じて、azure Active Directory サービスが、Microsoft Azure Active Directoryを識別する非対称公開キーではなく、署名キーで署名されたアプリケーションにトークンを発行することを要求する場合があります。 この場合は、サービス プリンシパルの署名資格情報キーを指定します。
型: | ServicePrincipalCredentialUsage |
配置: | Named |
規定値: | Verify |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Value
資格情報の値を指定します。
- 資格情報の種類が非対称の場合、値は base 64 でエンコードされた証明書を表します。
- 資格情報の種類が対称で 、Value パラメーターが指定されていない場合、256 ビットの AES キーが自動的に作成され、作成から 1 年間有効になります。
- 資格情報の種類が password の場合は、 Value を指定します。 Base 64 でエンコードしないでください。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |