Partager via


Get-AzKeyVaultCertificate

Obtient un certificat à partir d’un coffre de clés.

Syntaxe

ByName (Par défaut)

Get-AzKeyVaultCertificate
    [-VaultName] <String>
    [[-Name] <String>]
    [-InRemovedState]
    [-IncludePending]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByCertificateNameAndVersion

Get-AzKeyVaultCertificate
    [-VaultName] <String>
    [-Name] <String>
    [-Version] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByCertificateAllVersions

Get-AzKeyVaultCertificate
    [-VaultName] <String>
    [-Name] <String>
    [-IncludeVersions]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByNameInputObject

Get-AzKeyVaultCertificate
    [-InputObject] <PSKeyVault>
    [[-Name] <String>]
    [-InRemovedState]
    [-IncludePending]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByCertificateNameAndVersionInputObject

Get-AzKeyVaultCertificate
    [-InputObject] <PSKeyVault>
    [-Name] <String>
    [-Version] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByCertificateAllVersionsInputObject

Get-AzKeyVaultCertificate
    [-InputObject] <PSKeyVault>
    [-Name] <String>
    [-IncludeVersions]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByNameResourceId

Get-AzKeyVaultCertificate
    [-ResourceId] <String>
    [[-Name] <String>]
    [-InRemovedState]
    [-IncludePending]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByCertificateNameAndVersionResourceId

Get-AzKeyVaultCertificate
    [-ResourceId] <String>
    [-Name] <String>
    [-Version] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByCertificateAllVersionsResourceId

Get-AzKeyVaultCertificate
    [-ResourceId] <String>
    [-Name] <String>
    [-IncludeVersions]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

L’applet de commande Get-AzKeyVaultCertificate obtient le certificat spécifié ou les versions d’un certificat à partir d’un coffre de clés dans Azure Key Vault.

Exemples

Exemple 1 : Obtenir un certificat

Get-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01"
Name        : testCert01
Certificate : [Subject]
                CN=contoso.com

              [Issuer]
                CN=contoso.com

              [Serial Number]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

              [Not Before]
                2/8/2016 3:11:45 PM

              [Not After]
                8/8/2016 4:21:45 PM

              [Thumbprint]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

KeyId       : https://contoso.vault.azure.net:443/keys/TestCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
SecretId    : https://contoso.vault.azure.net:443/secrets/TestCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Thumbprint  : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Tags        :
Enabled     : True
Created     : 2/8/2016 11:21:45 PM
Updated     : 2/8/2016 11:21:45 PM

Cette commande obtient le certificat nommé TestCert01 à partir du coffre de clés nommé ContosoKV01

Exemple 2 : Obtenir le certificat et l’enregistrer en tant que pfx

$CertBase64 = Get-AzKeyVaultSecret -VaultName $vaultName -Name $certName -AsPlainText
$CertBytes = [Convert]::FromBase64String($CertBase64)
Set-Content -Path cert.pfx -Value $CertBytes -AsByteStream

Cette commande obtient le certificat nommé $certName à partir du coffre de clés nommé $vaultName. Ces commandes accèdent au secret $certName , puis enregistrent le contenu sous forme de fichier pfx.

Exemple 3 : Obtenez tous les certificats qui ont été supprimés, mais qui n’ont pas été vidés pour ce coffre de clés.

Get-AzKeyVaultCertificate -VaultName 'contoso' -InRemovedState
DeletedDate        : 5/24/2018 6:08:32 PM
Enabled            : True
Expires            : 11/24/2018 6:08:13 PM
NotBefore          : 5/24/2018 5:58:13 PM
Created            : 5/24/2018 6:08:13 PM
Updated            : 5/24/2018 6:08:13 PM
Tags               :
VaultName          : contoso
Name               : test1
Version            :
Id                 : https://contoso.vault.azure.net:443/certificates/test1

ScheduledPurgeDate : 8/22/2018 6:10:47 PM
DeletedDate        : 5/24/2018 6:10:47 PM
Enabled            : True
Expires            : 11/24/2018 6:09:44 PM
NotBefore          : 5/24/2018 5:59:44 PM
Created            : 5/24/2018 6:09:44 PM
Updated            : 5/24/2018 6:09:44 PM
Tags               :
VaultName          : contoso
Name               : test2
Version            :
Id                 : https://contoso.vault.azure.net:443/certificates/test2

Cette commande obtient tous les certificats qui ont été précédemment supprimés, mais pas vidés, dans le coffre de clés nommé Contoso.

Exemple 4 : Obtient le certificat MyCert qui a été supprimé, mais pas vidé pour ce coffre de clés.

Get-AzKeyVaultCertificate -VaultName 'contoso' -Name 'test1' -InRemovedState
Certificate        : [Subject]
                       CN=contoso.com

                     [Issuer]
                       CN=contoso.com

                     [Serial Number]
                       XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

                     [Not Before]
                       5/24/2018 10:58:13 AM

                     [Not After]
                       11/24/2018 10:08:13 AM

                     [Thumbprint]
                       XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

KeyId              : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
SecretId           : https://contoso.vault.azure.net:443/secrets/test1/7fe415d5518240c1a6fce89986b8d334
Thumbprint         : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
RecoveryLevel      : Recoverable+Purgeable
ScheduledPurgeDate : 8/22/2018 6:08:32 PM
DeletedDate        : 5/24/2018 6:08:32 PM
Enabled            : True
Expires            : 11/24/2018 6:08:13 PM
NotBefore          : 5/24/2018 5:58:13 PM
Created            : 5/24/2018 6:08:13 PM
Updated            : 5/24/2018 6:08:13 PM
Tags               :
VaultName          : contoso
Name               : test1
Version            : 7fe415d5518240c1a6fce89986b8d334
Id                 : https://contoso.vault.azure.net:443/certificates/test1/7fe415d5518240c1a6fce89986b8d334

Cette commande obtient le certificat nommé « MyCert » qui a été précédemment supprimé, mais pas vidé, dans le coffre de clés nommé Contoso. Cette commande retourne des métadonnées telles que la date de suppression et la date de purge planifiée de ce certificat supprimé.

Exemple 5 : Répertorier les certificats à l’aide du filtrage

Get-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "test*"
Enabled   : True
Expires   : 8/5/2019 2:39:25 AM
NotBefore : 2/5/2019 2:29:25 AM
Created   : 2/5/2019 2:39:25 AM
Updated   : 2/5/2019 2:39:25 AM
Tags      :
VaultName : ContosoKV01
Name      : test1
Version   :
Id        : https://ContosoKV01.vault.azure.net:443/certificates/test1

Enabled   : True
Expires   : 8/5/2019 2:39:25 AM
NotBefore : 2/5/2019 2:29:25 AM
Created   : 2/5/2019 2:39:25 AM
Updated   : 2/5/2019 2:39:25 AM
Tags      :
VaultName : ContosoKV01
Name      : test2
Version   :
Id        : https://ContosoKV01.vault.azure.net:443/certificates/test2

Cette commande obtient tous les certificats commençant par « test » à partir du coffre de clés nommé ContosoKV01.

Paramètres

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IncludePending

Spécifie s’il faut inclure des certificats en attente dans la sortie

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByNameInputObject
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByNameResourceId
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IncludeVersions

Indique que cette opération obtient toutes les versions du certificat.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByCertificateAllVersions
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateAllVersionsInputObject
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateAllVersionsResourceId
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Objet KeyVault.

Propriétés du paramètre

Type:PSKeyVault
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByNameInputObject
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateNameAndVersionInputObject
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateAllVersionsInputObject
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InRemovedState

Spécifie s’il faut inclure des certificats précédemment supprimés dans la sortie

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByNameInputObject
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByNameResourceId
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

Spécifie le nom du certificat à obtenir.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False
Alias:CertificateName

Jeux de paramètres

ByName
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByNameInputObject
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByNameResourceId
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ResourceId

ID de ressource KeyVault.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByNameResourceId
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False
ByCertificateNameAndVersionResourceId
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False
ByCertificateAllVersionsResourceId
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-VaultName

Spécifie le nom d’un coffre de clés.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateNameAndVersion
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateAllVersions
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Version

Spécifie la version d’un certificat.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:CertificateVersion

Jeux de paramètres

ByCertificateNameAndVersion
Position:2
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateNameAndVersionInputObject
Position:2
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
ByCertificateNameAndVersionResourceId
Position:2
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
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.

Entrées

PSKeyVault

String

Sorties

PSKeyVaultCertificateIdentityItem

PSKeyVaultCertificate

PSDeletedKeyVaultCertificate

PSDeletedKeyVaultCertificateIdentityItem