< Back
Get-AzureKeyVaultCertificate
Post
NAME Get-AzureKeyVaultCertificate
SYNOPSIS
Gets a certificate from a key vault.
SYNTAX
Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] -IncludeVersions
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] -IncludeVersions
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [-InRemovedState]
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-VaultName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [-InRemovedState]
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-Version] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureKeyVaultCertificate cmdlet gets the specified certificate or the versions of a certificate from a key vault in Azure Key Vault.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncludeVersions [<SwitchParameter>]
Indicates that this operation gets all versions of the certificate.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSKeyVault>
KeyVault object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-InRemovedState [<SwitchParameter>]
Specifies whether to include previously deleted certificates in the output
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the certificate to get.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the name of a key vault.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the version of a certificate.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem]
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate
NOTES
Example 1: Get a certificate
PS C:\\>Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01"
Name : testCert01
Certificate : [Subject]
CN=contoso.com
[Issuer]
CN=contoso.com
[Serial Number]
05979C5A2F0741D5A3B6F97673E8A118
[Not Before]
2/8/2016 3:11:45 PM
[Not After]
8/8/2016 4:21:45 PM
[Thumbprint]
3E9B6848AD1834284157D68B060F748037F663C8
Thumbprint : 3E9B6848AD1834284157D68B060F748037F663C8
Tags :
Enabled : True
Created : 2/8/2016 11:21:45 PM
Updated : 2/8/2016 11:21:45 PM
This command gets the certificate named TestCert01 from the key vault named ContosoKV01.
Example 2: Get all the certificates that have been deleted but not purged for this key vault.
PS C:\\>Get-AzureKeyVaultCertificate -VaultName 'Contoso' -InRemovedState
This command gets all the certificates that have been previously deleted, but not purged, in the key vault named Contoso.
Example 3: Gets the certificate MyCert that has been deleted but not purged for this key vault.
PS C:\\>Get-AzureKeyVaultCertificate -VaultName 'Contoso' -Name 'MyCert' -InRemovedState
This command gets the certificate named 'MyCert' that has been previously deleted, but not purged, in the key vault named Contoso. This command
will return metadata such as the deletion date, and the scheduled purging date of this deleted certificate.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ertificate
Add-AzureKeyVaultCertificate
Import-AzureKeyVaultCertificate
Remove-AzureKeyVaultCertificate
Undo-AzureKeyVaultSecretCertificate
SYNOPSIS
Gets a certificate from a key vault.
SYNTAX
Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] -IncludeVersions
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] -IncludeVersions
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [-InRemovedState]
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-Version] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-VaultName] <String> [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>] [-InRemovedState]
[<CommonParameters>]
Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-Version] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureKeyVaultCertificate cmdlet gets the specified certificate or the versions of a certificate from a key vault in Azure Key Vault.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncludeVersions [<SwitchParameter>]
Indicates that this operation gets all versions of the certificate.
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSKeyVault>
KeyVault object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-InRemovedState [<SwitchParameter>]
Specifies whether to include previously deleted certificates in the output
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the certificate to get.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the name of a key vault.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the version of a certificate.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Collections.Generic.List`1[Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificateIdentityItem]
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate
NOTES
Example 1: Get a certificate
PS C:\\>Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01"
Name : testCert01
Certificate : [Subject]
CN=contoso.com
[Issuer]
CN=contoso.com
[Serial Number]
05979C5A2F0741D5A3B6F97673E8A118
[Not Before]
2/8/2016 3:11:45 PM
[Not After]
8/8/2016 4:21:45 PM
[Thumbprint]
3E9B6848AD1834284157D68B060F748037F663C8
Thumbprint : 3E9B6848AD1834284157D68B060F748037F663C8
Tags :
Enabled : True
Created : 2/8/2016 11:21:45 PM
Updated : 2/8/2016 11:21:45 PM
This command gets the certificate named TestCert01 from the key vault named ContosoKV01.
Example 2: Get all the certificates that have been deleted but not purged for this key vault.
PS C:\\>Get-AzureKeyVaultCertificate -VaultName 'Contoso' -InRemovedState
This command gets all the certificates that have been previously deleted, but not purged, in the key vault named Contoso.
Example 3: Gets the certificate MyCert that has been deleted but not purged for this key vault.
PS C:\\>Get-AzureKeyVaultCertificate -VaultName 'Contoso' -Name 'MyCert' -InRemovedState
This command gets the certificate named 'MyCert' that has been previously deleted, but not purged, in the key vault named Contoso. This command
will return metadata such as the deletion date, and the scheduled purging date of this deleted certificate.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ertificate
Add-AzureKeyVaultCertificate
Import-AzureKeyVaultCertificate
Remove-AzureKeyVaultCertificate
Undo-AzureKeyVaultSecretCertificate