New-EntraApplicationKeyCredential

Hiermee maakt u een sleutelreferentie voor een toepassing.

Syntax

Default (Standaard)

New-EntraApplicationKeyCredential

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

Description

De New-EntraApplicationKeyCredential cmdlet maakt een sleutelreferentie voor een toepassing.

Een toepassing kan deze opdracht gebruiken om Remove-EntraApplicationKeyCredential de rolling van de verlopende sleutels te automatiseren.

Als onderdeel van de aanvraagvalidatie wordt het bewijs van het bezit van een bestaande sleutel gecontroleerd voordat de actie kan worden uitgevoerd.

Voorbeelden

Voorbeeld 1: Een nieuwe referentie voor de toepassingssleutel maken

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 dit voorbeeld ziet u hoe u een toepassingssleutelreferentie maakt.

  • -ApplicationId Hiermee geeft u een unieke id van een toepassing
  • -CustomKeyIdentifier Hiermee geeft u een aangepaste sleutel-id.
  • -StartDate Hiermee geeft u de tijd op waarop de sleutel geldig wordt als een DateTime-object.
  • -Type Hiermee geeft u het type van de sleutel.
  • -Usage Hiermee geeft u het sleutelgebruik. voor AsymmetricX509Cert het gebruik moet zijn Verifyen voor X509CertAndPassword het gebruik moet zijn Sign.
  • -Value Hiermee geeft u de waarde voor de sleutel.

U kunt de Get-EntraApplication cmdlet gebruiken om de object-id van de toepassing op te halen.

Voorbeeld 2: Een certificaat gebruiken om een toepassingssleutelreferentie toe te voegen

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 dit voorbeeld ziet u hoe u een toepassingssleutelreferentie maakt.

  • -ApplicationId Hiermee geeft u een unieke id van een toepassing
  • -CustomKeyIdentifier Hiermee geeft u een aangepaste sleutel-id.
  • -StartDate Hiermee geeft u de tijd op waarop de sleutel geldig wordt als een DateTime-object.
  • -EndDate Hiermee geeft u de tijd op waarop de sleutel ongeldig wordt als een DateTime-object.
  • -Type Hiermee geeft u het type van de sleutel.
  • -Usage Hiermee geeft u het sleutelgebruik. voor AsymmetricX509Cert het gebruik moet zijn Verifyen voor X509CertAndPassword het gebruik moet zijn Sign.
  • -Value Hiermee geeft u de waarde voor de sleutel.

Parameters

-ApplicationId

Hiermee geeft u een unieke id van een toepassing in Microsoft Entra ID.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:ObjectId

Parametersets

(All)
Position:Named
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-CustomKeyIdentifier

Hiermee geeft u een aangepaste sleutel-id.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-EndDate

Hiermee geeft u de tijd op waarop de sleutel ongeldig wordt als een DateTime-object.

Parametereigenschappen

Type:System.DateTime
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-StartDate

Hiermee geeft u de tijd op waarop de sleutel geldig wordt als een DateTime-object.

Parametereigenschappen

Type:System.DateTime
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-Type

Hiermee geeft u het type van de sleutel.

Parametereigenschappen

Type:KeyType
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-Usage

Hiermee geeft u het sleutelgebruik.

  • AsymmetricX509Cert: Het gebruik moet zijn Verify.
  • X509CertAndPassword: Het gebruik moet zijn Sign.

Parametereigenschappen

Type:KeyUsage
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-Value

Hiermee geeft u de waarde voor de sleutel.

Parametereigenschappen

Type:System.String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.