< Back
Set-AzureKeyVaultCertificateAttribute
Post
NAME Set-AzureKeyVaultCertificateAttribute
SYNOPSIS
Modifies editable attributes of a certificate.
SYNTAX
Set-AzureKeyVaultCertificateAttribute [-InputObject] <PSKeyVaultCertificateIdentityItem> [[-Version] <String>] [-DefaultProfile
<IAzureContextContainer>] [-Enable <Boolean>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureKeyVaultCertificateAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-DefaultProfile <IAzureContextContainer>]
[-Enable <Boolean>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureKeyVaultCertificateAttribute cmdlet modifies the editable attributes of a certificate.
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
-Enable <Boolean>
Indicates whether to enable or disable a certificate. Specify $True to enable or $False to disable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSKeyVaultCertificateIdentityItem>
Certificate object
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the certificate to modify. This cmdlet constructs the FQDN of a certificate based on the key vault name, your currently
selected environment, the certificate name, and the certificate version.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the key vault name in which this cmdlet modifies a certificate. This cmdlet constructs the FQDN of a key vault based on the name and
currently selected environment.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the version of a certificate. This cmdlet constructs the FQDN of a certificate based on the key vault name, your currently selected
environment, the certificate name, and the certificate version.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate
NOTES
Example 1: Modify the tags associated with a certificate
PS C:\\>$Tags = @{ "Team" = "Azure" ; "Role" = "Engg" }
PS C:\\> Set-AzureKeyVaultCertificateAttribute -VaultName "ContosoKV01" -Name "TestCert01" -Tag $Tags
PS C:\\> Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01"
Name : "TestCert01"
Certificate : [Subject]
CN=AZURE
[Issuer]
CN=AZURE
[Serial Number]
5A2EF60501F241D6A4336841B36FEA41
[Not Before]
7/27/2016 6:50:01 PM
[Not After]
7/27/2018 7:00:01 PM
[Thumbprint]
A565D568082FEE2BE33B356ECC3703C2E9886555
Id : https://ContosoKV01.vault.azure.net:443 ... cates/tt02
KeyId : https://ContosoKV01.vault.azure.net:443/keys/tt02
SecretId : https://ContosoKV01.vault.azure.net:443/secrets/tt02
Thumbprint : A565D568082FEE2BE33B356ECC3703C2E9886555
Tags : {[Role, Engg], [Team, Azure]}
Enabled : True
Created : 7/28/2016 2:00:01 AM
Updated : 8/1/2016 5:37:48 PM
The first command assigns an array of key/value pairs to the $Tags variable.
The second command sets the tags value of the certificate named TestCert01 to be $Tags.
The final command displays the TestCert01 certificate by using the Get-AzureKeyVaultCertificate cmdlet to verify the operation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... eattribute
Add-AzureKeyVaultCertificateContact
SYNOPSIS
Modifies editable attributes of a certificate.
SYNTAX
Set-AzureKeyVaultCertificateAttribute [-InputObject] <PSKeyVaultCertificateIdentityItem> [[-Version] <String>] [-DefaultProfile
<IAzureContextContainer>] [-Enable <Boolean>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureKeyVaultCertificateAttribute [-VaultName] <String> [-Name] <String> [[-Version] <String>] [-DefaultProfile <IAzureContextContainer>]
[-Enable <Boolean>] [-PassThru] [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureKeyVaultCertificateAttribute cmdlet modifies the editable attributes of a certificate.
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
-Enable <Boolean>
Indicates whether to enable or disable a certificate. Specify $True to enable or $False to disable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSKeyVaultCertificateIdentityItem>
Certificate object
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the certificate to modify. This cmdlet constructs the FQDN of a certificate based on the key vault name, your currently
selected environment, the certificate name, and the certificate version.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VaultName <String>
Specifies the key vault name in which this cmdlet modifies a certificate. This cmdlet constructs the FQDN of a key vault based on the name and
currently selected environment.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the version of a certificate. This cmdlet constructs the FQDN of a certificate based on the key vault name, your currently selected
environment, the certificate name, and the certificate version.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultCertificate
NOTES
Example 1: Modify the tags associated with a certificate
PS C:\\>$Tags = @{ "Team" = "Azure" ; "Role" = "Engg" }
PS C:\\> Set-AzureKeyVaultCertificateAttribute -VaultName "ContosoKV01" -Name "TestCert01" -Tag $Tags
PS C:\\> Get-AzureKeyVaultCertificate -VaultName "ContosoKV01" -Name "TestCert01"
Name : "TestCert01"
Certificate : [Subject]
CN=AZURE
[Issuer]
CN=AZURE
[Serial Number]
5A2EF60501F241D6A4336841B36FEA41
[Not Before]
7/27/2016 6:50:01 PM
[Not After]
7/27/2018 7:00:01 PM
[Thumbprint]
A565D568082FEE2BE33B356ECC3703C2E9886555
Id : https://ContosoKV01.vault.azure.net:443 ... cates/tt02
KeyId : https://ContosoKV01.vault.azure.net:443/keys/tt02
SecretId : https://ContosoKV01.vault.azure.net:443/secrets/tt02
Thumbprint : A565D568082FEE2BE33B356ECC3703C2E9886555
Tags : {[Role, Engg], [Team, Azure]}
Enabled : True
Created : 7/28/2016 2:00:01 AM
Updated : 8/1/2016 5:37:48 PM
The first command assigns an array of key/value pairs to the $Tags variable.
The second command sets the tags value of the certificate named TestCert01 to be $Tags.
The final command displays the TestCert01 certificate by using the Get-AzureKeyVaultCertificate cmdlet to verify the operation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... eattribute
Add-AzureKeyVaultCertificateContact