New-EntraApplicationKeyCredential

Erstellt eine Schlüsselanmeldeinformation für eine Anwendung.

Syntax

Default (Standard)

New-EntraApplicationKeyCredential

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

Beschreibung

Das New-EntraApplicationKeyCredential Cmdlet erstellt eine Schlüsselanmeldeinformationen für eine Anwendung.

Eine Anwendung kann diesen Befehl zusammen mit Remove-EntraApplicationKeyCredential dem Ausführen der Ablauftasten automatisieren.

Im Rahmen der Anforderungsüberprüfung wird der Nachweis des Besitzes eines vorhandenen Schlüssels überprüft, bevor die Aktion ausgeführt werden kann.

Beispiele

Beispiel 1: Erstellen einer neuen Anmeldeinformationen für den Anwendungsschlüssel

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}

In diesem Beispiel wird gezeigt, wie Sie anmeldeinformationen für den Anwendungsschlüssel erstellen.

  • -ApplicationId Gibt eine eindeutige ID einer Anwendung an.
  • -CustomKeyIdentifier Gibt eine benutzerdefinierte Schlüssel-ID an.
  • -StartDate Gibt die Uhrzeit an, zu der der Schlüssel als DateTime-Objekt gültig wird.
  • -Type Gibt den Typ des Schlüssels an.
  • -Usage Gibt die Schlüsselverwendung an. für AsymmetricX509Cert die Nutzung muss Verifyund für X509CertAndPassword die Nutzung muss sein Sign.
  • -Value Gibt den Wert für den Schlüssel an.

Sie können das Get-EntraApplication Cmdlet verwenden, um die Anwendungsobjekt-ID abzurufen.

Beispiel 2: Verwenden eines Zertifikats zum Hinzufügen von Anmeldeinformationen mit Anwendungsschlüsseln

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

In diesem Beispiel wird gezeigt, wie Sie anmeldeinformationen für den Anwendungsschlüssel erstellen.

  • -ApplicationId Gibt eine eindeutige ID einer Anwendung an.
  • -CustomKeyIdentifier Gibt eine benutzerdefinierte Schlüssel-ID an.
  • -StartDate Gibt die Uhrzeit an, zu der der Schlüssel als DateTime-Objekt gültig wird.
  • -EndDate Gibt die Uhrzeit an, zu der der Schlüssel als DateTime-Objekt ungültig wird.
  • -Type Gibt den Typ des Schlüssels an.
  • -Usage Gibt die Schlüsselverwendung an. für AsymmetricX509Cert die Nutzung muss Verifyund für X509CertAndPassword die Nutzung muss sein Sign.
  • -Value Gibt den Wert für den Schlüssel an.

Parameter

-ApplicationId

Gibt eine eindeutige ID einer Anwendung in Microsoft Entra ID an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Objekt-ID

Parametersätze

(All)
Position:Named
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-CustomKeyIdentifier

Gibt eine benutzerdefinierte Schlüssel-ID an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-EndDate

Gibt die Uhrzeit an, zu der der Schlüssel als DateTime-Objekt ungültig wird.

Parametereigenschaften

Typ:System.DateTime
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-StartDate

Gibt die Uhrzeit an, zu der der Schlüssel als DateTime-Objekt gültig wird.

Parametereigenschaften

Typ:System.DateTime
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Type

Gibt den Typ des Schlüssels an.

Parametereigenschaften

Typ:KeyType
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Usage

Gibt die Schlüsselverwendung an.

  • AsymmetricX509Cert: Die Verwendung muss sein Verify.
  • X509CertAndPassword: Die Verwendung muss sein Sign.

Parametereigenschaften

Typ:KeyUsage
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Value

Gibt den Wert für den Schlüssel an.

Parametereigenschaften

Typ:System.String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.