New-EntraApplicationKeyCredential
Crée des informations d’identification de clé pour une application.
Syntaxe
Default (Par défaut)
New-EntraApplicationKeyCredential
-ApplicationId <String>
[-CustomKeyIdentifier <String>]
[-Type <KeyType>]
[-Usage <KeyUsage>]
[-Value <String>]
[-EndDate <DateTime>]
[-StartDate <DateTime>]
[<CommonParameters>]
Description
L’applet New-EntraApplicationKeyCredential de commande crée des informations d’identification de clé pour une application.
Une application peut utiliser cette commande avec Remove-EntraApplicationKeyCredential pour automatiser le déploiement de ses clés arrivant à expiration.
Dans le cadre de la validation de la demande, la preuve de possession d’une clé existante est vérifiée avant que l’action puisse être effectuée.
Exemples
Exemple 1 : Créer des informations d’identification de clé d’application
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}
Cet exemple montre comment créer des informations d’identification de clé d’application.
-
-ApplicationIdSpécifie un ID unique d’une application -
-CustomKeyIdentifierSpécifie un ID de clé personnalisé. -
-StartDateSpécifie l’heure à laquelle la clé devient valide en tant qu’objet DateTime. -
-TypeSpécifie le type de la clé. -
-UsageSpécifie l’utilisation de la clé. pourAsymmetricX509Certl’utilisation doit êtreVerifyet pourX509CertAndPasswordl’utilisation doit êtreSign. -
-ValueSpécifie la valeur de la clé.
Vous pouvez utiliser l’applet Get-EntraApplication de commande pour récupérer l’ID d’objet de l’application.
Exemple 2 : Utiliser un certificat pour ajouter des informations d’identification de clé d’application
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
Cet exemple montre comment créer des informations d’identification de clé d’application.
-
-ApplicationIdSpécifie un ID unique d’une application -
-CustomKeyIdentifierSpécifie un ID de clé personnalisé. -
-StartDateSpécifie l’heure à laquelle la clé devient valide en tant qu’objet DateTime. -
-EndDateSpécifie l’heure à laquelle la clé devient non valide en tant qu’objet DateTime. -
-TypeSpécifie le type de la clé. -
-UsageSpécifie l’utilisation de la clé. pourAsymmetricX509Certl’utilisation doit êtreVerifyet pourX509CertAndPasswordl’utilisation doit êtreSign. -
-ValueSpécifie la valeur de la clé.
Paramètres
-ApplicationId
Spécifie un ID unique d’une application dans Microsoft Entra ID.
Propriétés du paramètre
| Type: | System.String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Identifiant d'objet (ObjectId) |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-CustomKeyIdentifier
Spécifie un ID de clé personnalisé.
Propriétés du paramètre
| Type: | System.String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-EndDate
Spécifie l’heure à laquelle la clé devient non valide en tant qu’objet DateTime.
Propriétés du paramètre
| Type: | System.DateTime |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-StartDate
Spécifie l’heure à laquelle la clé devient valide en tant qu’objet DateTime.
Propriétés du paramètre
| Type: | System.DateTime |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Type
Spécifie le type de la clé.
Propriétés du paramètre
| Type: | KeyType |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Usage
Spécifie l’utilisation de la clé.
-
AsymmetricX509Cert: l’utilisation doit êtreVerify. -
X509CertAndPassword: l’utilisation doit êtreSign.
Propriétés du paramètre
| Type: | KeyUsage |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Value
Spécifie la valeur de la clé.
Propriétés du paramètre
| Type: | System.String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.