New-EntraApplicationKeyCredential

Skapar en nyckelautentiseringsuppgift för ett program.

Syntax

Default (Standard)

New-EntraApplicationKeyCredential

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

Description

Cmdleten New-EntraApplicationKeyCredential skapar en nyckelautentiseringsuppgift för ett program.

Ett program kan använda det här kommandot tillsammans med Remove-EntraApplicationKeyCredential för att automatisera rullningen av dess utgångna nycklar.

Som en del av valideringen av begäran verifieras bevis på innehav av en befintlig nyckel innan åtgärden kan utföras.

Exempel

Exempel 1: Skapa en ny autentiseringsuppgift för programnycklar

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}

Det här exemplet visar hur du skapar en autentiseringsuppgift för programnycklar.

  • -ApplicationId Anger ett unikt ID för ett program
  • -CustomKeyIdentifier Anger ett anpassat nyckel-ID.
  • -StartDate Anger den tid då nyckeln blir giltig som ett DateTime-objekt.
  • -Type Anger typ av nyckel.
  • -Usage Anger nyckelanvändningen. för AsymmetricX509Cert användningen måste vara Verifyoch för X509CertAndPassword användningen måste vara Sign.
  • -Value Anger värdet för nyckeln.

Du kan använda cmdleten Get-EntraApplication för att hämta programmets objekt-ID.

Exempel 2: Använd ett certifikat för att lägga till en programnyckelautentiseringsuppgift

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

Det här exemplet visar hur du skapar en autentiseringsuppgift för programnycklar.

  • -ApplicationId Anger ett unikt ID för ett program
  • -CustomKeyIdentifier Anger ett anpassat nyckel-ID.
  • -StartDate Anger den tid då nyckeln blir giltig som ett DateTime-objekt.
  • -EndDate Anger den tid då nyckeln blir ogiltig som ett DateTime-objekt.
  • -Type Anger typ av nyckel.
  • -Usage Anger nyckelanvändningen. för AsymmetricX509Cert användningen måste vara Verifyoch för X509CertAndPassword användningen måste vara Sign.
  • -Value Anger värdet för nyckeln.

Parametrar

-ApplicationId

Anger ett unikt ID för ett program i Microsoft Entra ID.

Parameteregenskaper

Typ:System.String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Objekt-ID

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-CustomKeyIdentifier

Anger ett anpassat nyckel-ID.

Parameteregenskaper

Typ:System.String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-EndDate

Anger den tid då nyckeln blir ogiltig som ett DateTime-objekt.

Parameteregenskaper

Typ:System.DateTime
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-StartDate

Anger den tid då nyckeln blir giltig som ett DateTime-objekt.

Parameteregenskaper

Typ:System.DateTime
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Type

Anger typ av nyckel.

Parameteregenskaper

Typ:KeyType
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Usage

Anger nyckelanvändningen.

  • AsymmetricX509Cert: Användningen måste vara Verify.
  • X509CertAndPassword: Användningen måste vara Sign.

Parameteregenskaper

Typ:KeyUsage
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Value

Anger värdet för nyckeln.

Parameteregenskaper

Typ:System.String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.