New-EntraApplicationKeyCredential

New-EntraApplicationKeyCredential

    -ApplicationId <String>
    [-CustomKeyIdentifier <String>]
    [-Type <KeyType>]
    [-Usage <KeyUsage>]
    [-Value <String>]
    [-EndDate <DateTime>]
    [-StartDate <DateTime>]
    [<CommonParameters>]

New-EntraApplicationKeyCredential コマンドレットは、アプリケーションのキー資格情報を作成します。

アプリケーションでは、このコマンドを Remove-EntraApplicationKeyCredential と共に使用して、期限切れのキーのローリングを自動化できます。

要求の検証の一環として、アクションを実行する前に、既存のキーの所有証明が検証されます。

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
$params = @{
    ApplicationId = $application.Id
    CustomKeyIdentifier = 'EntraPowerShellKey'
    StartDate = '2024-03-21T14:14:14Z'
    Type = 'Symmetric'
    Usage = 'Sign'
    Value = '<my-value>'
}
New-EntraApplicationKeyCredential @params

CustomKeyIdentifier : {84, 101, 115, 116}
EndDate             : 2024-03-21T14:14:14Z
KeyId               : aaaaaaaa-0b0b-1c1c-2d2d-333333333333
StartDate           : 2025-03-21T14:14:14Z
Type                : Symmetric
Usage               : Sign
Value               : {49, 50, 51}

この例では、アプリケーション キーの資格情報を作成する方法を示します。

• -ApplicationId アプリケーションの一意の ID を指定します
• -CustomKeyIdentifier カスタム キー ID を指定します。
• -StartDate キーが DateTime オブジェクトとして有効になる時刻を指定します。
• -Type キーの種類を指定します。
• -Usage キーの使用法を指定します。 使用AsymmetricX509CertVerifyする必要があります。また、使用X509CertAndPasswordはSignする必要があります。
• -Value キーの値を指定します。

Get-EntraApplication コマンドレットを使用して、アプリケーション オブジェクト ID を取得できます。

Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy'
$application = Get-EntraApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
$cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 #create a new certificate object
$cer.Import('C:\Users\ContosoUser\appcert.cer')
$bin = $cer.GetRawCertData()
$base64Value = [System.Convert]::ToBase64String($bin)
$bin = $cer.GetCertHash()
$base64Thumbprint = [System.Convert]::ToBase64String($bin)
$keyid = [System.Guid]::NewGuid().ToString()

$params = @{
    ApplicationId = $application.Id
    CustomKeyIdentifier = $base64Thumbprint
    Type = 'AsymmetricX509Cert'
    Usage = 'Verify'
    Value = $base64Value
    StartDate = $cer.GetEffectiveDateString()
    EndDate = $cer.GetExpirationDateString()
}
New-EntraApplicationKeyCredential @params

この例では、アプリケーション キーの資格情報を作成する方法を示します。

• -ApplicationId アプリケーションの一意の ID を指定します
• -CustomKeyIdentifier カスタム キー ID を指定します。
• -StartDate キーが DateTime オブジェクトとして有効になる時刻を指定します。
• -EndDate DateTime オブジェクトとしてキーが無効になる時刻を指定します。
• -Type キーの種類を指定します。
• -Usage キーの使用法を指定します。 使用AsymmetricX509CertVerifyする必要があります。また、使用X509CertAndPasswordはSignする必要があります。
• -Value キーの値を指定します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。