New-AzureRmADSpCredential
既存のサービス プリンシパルに資格情報を追加します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日に正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
New-AzureRmADSpCredential
-ObjectId <Guid>
[-Password <SecureString>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmADSpCredential
-ObjectId <Guid>
-CertValue <String>
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmADSpCredential
-ServicePrincipalName <String>
-CertValue <String>
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmADSpCredential
-ServicePrincipalName <String>
[-Password <SecureString>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmADSpCredential
-ServicePrincipalObject <PSADServicePrincipal>
-CertValue <String>
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmADSpCredential
-ServicePrincipalObject <PSADServicePrincipal>
[-Password <SecureString>]
[-StartDate <DateTime>]
[-EndDate <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
New-AzureRmADSpCredential コマンドレットを使用して、新しい資格情報を追加したり、サービス プリンシパルの資格情報をロールすることができます。 サービス プリンシパルは、オブジェクト ID またはサービス プリンシパル名を指定することによって識別されます。
例
例 1 - 生成されたパスワードを使用して新しいサービス プリンシパル資格情報を作成する
PS C:\> New-AzureRmADSpCredential -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476
Secret : System.Security.SecureString
StartDate : 11/12/2018 9:36:05 PM
EndDate : 11/12/2019 9:36:05 PM
KeyId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Type : Password
オブジェクト ID '1f99cf81-0146-4f4e-beae-2007d0668476' を持つ新しいパスワード資格情報が既存のサービス プリンシパルに追加されます。
例 2 - 証明書を使用して新しいサービス プリンシパル資格情報を作成する
PS C:\> $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate
PS C:\> $cer.Import("C:\myapp.cer")
PS C:\> $binCert = $cer.GetRawCertData()
PS C:\> $credValue = [System.Convert]::ToBase64String($binCert)
PS C:\> New-AzureRmADSpCredential -ServicePrincipalName "http://test123" -CertValue $credValue -StartDate $cer.GetEffectiveDateString() -EndDate $cer.GetExpirationDateString()
指定された base64 でエンコードされたパブリック X509 証明書 ("myapp.cer") は、SPN を使用して既存のサービス プリンシパルに追加されます。
例 3 - パイプを使用して新しいサービス プリンシパル資格情報を作成する
PS C:\> Get-AzureRmADServicePrincipal -ObjectId 1f99cf81-0146-4f4e-beae-2007d0668476 | New-AzureRmADSpCredential
Secret : System.Security.SecureString
StartDate : 11/12/2018 9:36:05 PM
EndDate : 11/12/2019 9:36:05 PM
KeyId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Type : Password
オブジェクト ID '1f99cf81-0146-4f4e-beae-2007d0668476' を持つサービス プリンシパルを取得し、New-AzureRmADSpCredential にパイプして、生成されたパスワードでそのサービス プリンシパルの新しいサービス プリンシパル資格情報を作成します。
パラメーター
-CertValue
"非対称" 資格情報の種類の値。 Base 64 でエンコードされた証明書を表します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EndDate
資格情報の使用の有効な終了日。 既定の終了日の値は、今日から 1 年です。 "非対称" 型の資格情報の場合は、X509 証明書が有効な日付以前に設定する必要があります。
型: | DateTime |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ObjectId
資格情報を追加するサービス プリンシパルのオブジェクト ID。
型: | Guid |
Aliases: | ServicePrincipalObjectId |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Password
アプリケーションに関連付けるパスワード。
型: | SecureString |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ServicePrincipalName
資格情報を追加するサービス プリンシパルの名前 (SPN)。
型: | String |
Aliases: | SPN |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ServicePrincipalObject
資格情報を追加するサービス プリンシパル オブジェクト。
型: | PSADServicePrincipal |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-StartDate
資格情報の使用の有効な開始日。 既定の開始日の値は今日です。 "非対称" 型の資格情報の場合は、X509 証明書が有効な日付以降に設定する必要があります。
型: | DateTime |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
パラメーター: ServicePrincipalObject (ByValue)
出力
Microsoft.Azure.Commands.Resources.Models.Authorization.PSADCredentialWrapper