Get-AzKeyVaultKeyRotationPolicy
Gets the key rotation policy for the specified key in Key Vault.
Syntax
ByVaultName (Default)
Get-AzKeyVaultKeyRotationPolicy
[-VaultName] <String>
[-Name] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByKeyInputObject
Get-AzKeyVaultKeyRotationPolicy
[-InputObject] <PSKeyVaultKeyIdentityItem>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
This cmdlet requires the keys/get permission. It returns key rotation policy for the specified key.
Examples
Example 1
Get-AzKeyVaultKeyRotationPolicy -VaultName test-kv -Name test-key
Id :
VaultName : test-kv
KeyName : test-key
LifetimeActions : {[Action: Notify, TimeAfterCreate: , TimeBeforeExpiry: P30D]}
ExpiresIn :
CreatedOn :
UpdatedOn :
This cmdlet gets the key rotation policy for test-kv.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Key object
Parameter properties
| Type: | PSKeyVaultKeyIdentityItem |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Key |
Parameter sets
ByKeyInputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Key name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | KeyName |
Parameter sets
ByVaultName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VaultName
Vault name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByVaultName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
