New-EntraApplicationKeyCredential

Crea una credenziale chiave per un'applicazione.

Sintassi

Default (Impostazione predefinita)

New-EntraApplicationKeyCredential

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

Descrizione

Il New-EntraApplicationKeyCredential cmdlet crea una credenziale chiave per un'applicazione.

Un'applicazione può usare questo comando insieme Remove-EntraApplicationKeyCredential a per automatizzare il rollback delle chiavi in scadenza.

Nell'ambito della convalida della richiesta, la prova di possesso di una chiave esistente viene verificata prima di poter eseguire l'azione.

Esempio

Esempio 1: Creare una nuova credenziale della chiave dell'applicazione

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}

Questo esempio illustra come creare credenziali della chiave dell'applicazione.

  • -ApplicationId Specifica un ID univoco di un'applicazione
  • -CustomKeyIdentifier Specifica un ID chiave personalizzato.
  • -StartDate Specifica l'ora in cui la chiave diventa valida come oggetto DateTime.
  • -Type Specifica il tipo della chiave.
  • -Usage Specifica l'utilizzo della chiave. per AsymmetricX509Cert l'utilizzo deve essere e per Verify l'utilizzo deve essere X509CertAndPasswordSign.
  • -Value Specifica il valore per la chiave.

È possibile usare il Get-EntraApplication cmdlet per recuperare l'ID oggetto dell'applicazione.

Esempio 2: Usare un certificato per aggiungere credenziali della chiave dell'applicazione

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

Questo esempio illustra come creare credenziali della chiave dell'applicazione.

  • -ApplicationId Specifica un ID univoco di un'applicazione
  • -CustomKeyIdentifier Specifica un ID chiave personalizzato.
  • -StartDate Specifica l'ora in cui la chiave diventa valida come oggetto DateTime.
  • -EndDate Specifica l'ora in cui la chiave diventa non valida come oggetto DateTime.
  • -Type Specifica il tipo della chiave.
  • -Usage Specifica l'utilizzo della chiave. per AsymmetricX509Cert l'utilizzo deve essere e per Verify l'utilizzo deve essere X509CertAndPasswordSign.
  • -Value Specifica il valore per la chiave.

Parametri

-ApplicationId

Specifica un ID univoco di un'applicazione in Microsoft Entra ID.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:ObjectId

Set di parametri

(All)
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-CustomKeyIdentifier

Specifica un ID chiave personalizzato.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-EndDate

Specifica l'ora in cui la chiave diventa non valida come oggetto DateTime.

Proprietà dei parametri

Tipo:System.DateTime
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-StartDate

Specifica l'ora in cui la chiave diventa valida come oggetto DateTime.

Proprietà dei parametri

Tipo:System.DateTime
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Type

Specifica il tipo della chiave.

Proprietà dei parametri

Tipo:KeyType
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Usage

Specifica l'utilizzo della chiave.

  • AsymmetricX509Cert: l'utilizzo deve essere Verify.
  • X509CertAndPassword: l'utilizzo deve essere Sign.

Proprietà dei parametri

Tipo:KeyUsage
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Value

Specifica il valore per la chiave.

Proprietà dei parametri

Tipo:System.String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.