New-EntraApplicationKeyCredential

Tworzy poświadczenia klucza dla aplikacji.

Składnia

Default (domyślnie)

New-EntraApplicationKeyCredential

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

Opis

Polecenie New-EntraApplicationKeyCredential cmdlet tworzy poświadczenia klucza dla aplikacji.

Aplikacja może używać tego polecenia wraz z poleceniem Remove-EntraApplicationKeyCredential w celu zautomatyzowania rolowania wygasających kluczy.

W ramach weryfikacji żądania dowód posiadania istniejącego klucza jest weryfikowany przed wykonaniem akcji.

Przykłady

Przykład 1. Tworzenie nowego poświadczenia klucza aplikacji

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}

W tym przykładzie pokazano, jak utworzyć poświadczenia klucza aplikacji.

  • -ApplicationId Określa unikatowy identyfikator aplikacji
  • -CustomKeyIdentifier Określa identyfikator klucza niestandardowego.
  • -StartDate Określa czas, kiedy klucz staje się prawidłowy jako obiekt DateTime.
  • -Type Określa typ klucza.
  • -Usage Określa użycie klucza. dla AsymmetricX509Cert użycia musi mieć Verifywartość i dla X509CertAndPassword użycia musi mieć wartość Sign.
  • -Value Określa wartość klucza.

Możesz użyć Get-EntraApplication polecenia cmdlet , aby pobrać identyfikator obiektu aplikacji.

Przykład 2. Dodawanie poświadczeń klucza aplikacji przy użyciu certyfikatu

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

W tym przykładzie pokazano, jak utworzyć poświadczenia klucza aplikacji.

  • -ApplicationId Określa unikatowy identyfikator aplikacji
  • -CustomKeyIdentifier Określa identyfikator klucza niestandardowego.
  • -StartDate Określa czas, kiedy klucz staje się prawidłowy jako obiekt DateTime.
  • -EndDate Określa czas, kiedy klucz staje się nieprawidłowy jako obiekt DateTime.
  • -Type Określa typ klucza.
  • -Usage Określa użycie klucza. dla AsymmetricX509Cert użycia musi mieć Verifywartość i dla X509CertAndPassword użycia musi mieć wartość Sign.
  • -Value Określa wartość klucza.

Parametry

-ApplicationId

Określa unikatowy identyfikator aplikacji w Microsoft Entra ID.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Identyfikator Obiektu

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-CustomKeyIdentifier

Określa identyfikator klucza niestandardowego.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-EndDate

Określa czas, kiedy klucz staje się nieprawidłowy jako obiekt DateTime.

Właściwości parametru

Typ:System.DateTime
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-StartDate

Określa czas, kiedy klucz staje się prawidłowy jako obiekt DateTime.

Właściwości parametru

Typ:System.DateTime
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Type

Określa typ klucza.

Właściwości parametru

Typ:KeyType
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Usage

Określa użycie klucza.

  • AsymmetricX509Cert: Użycie musi mieć wartość Verify.
  • X509CertAndPassword: Użycie musi mieć wartość Sign.

Właściwości parametru

Typ:KeyUsage
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Value

Określa wartość klucza.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.