< Back
Update-AzureKeyVaultManagedStorageAccount
Post
NAME Update-AzureKeyVaultManagedStorageAccount
SYNOPSIS
Update editable attributes of a Key Vault managed Azure Storage Account.
SYNTAX
Update-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-ActiveKeyName <String>] [-AutoRegenerateKey <Boolean>]
[-DefaultProfile <IAzureContextContainer>] [-Enable <Boolean>] [-PassThru] [-RegenerationPeriod <TimeSpan>] [-Tag <Hashtable>] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
Update the editable attributes of a Key Vault managed Azure Storage Account.
PARAMETERS
-AccountName <String>
Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected
environment and manged storage account name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ActiveKeyName <String>
Active key name. If not specified, the existing value of managed storage account's active key name remains unchanged
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AutoRegenerateKey <Boolean>
Auto regenerate key. If not specified, the existing value of auto regenerate key of managed storage account remains unchanged
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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>
If present, enables a use of a managed storage account key for sas token generation if value is true. Disables use of a managed storage
account key for sas token generation if value is false. If not specified, the existing value of the storage account's enabled/disabled state
remains unchanged.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Cmdlet does not return object by default. If this switch is specified, return managed storage account object.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RegenerationPeriod <TimeSpan>
Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after which managed storage account's inactive
keygets auto regenerated and becomes the active key. If not specified, the existing value of regeneration period of keys of managed storage
account remains unchanged
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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>
Vault name. Cmdlet constructs the FQDN of a 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
-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.ManagedStorageAccount
NOTES
Example 1:Update the active key to 'key2' on a Key Vault managed Azure Storage Account.
PS C:\\> Update-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -ActiveKeyName 'key2'
Updates the Key Vault managed Azure Storage Account active key to 'key2'. 'key2' will be used to generate SAS tokens after this update.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ageaccount
AzureRM.KeyVault
SYNOPSIS
Update editable attributes of a Key Vault managed Azure Storage Account.
SYNTAX
Update-AzureKeyVaultManagedStorageAccount [-VaultName] <String> [-AccountName] <String> [-ActiveKeyName <String>] [-AutoRegenerateKey <Boolean>]
[-DefaultProfile <IAzureContextContainer>] [-Enable <Boolean>] [-PassThru] [-RegenerationPeriod <TimeSpan>] [-Tag <Hashtable>] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
Update the editable attributes of a Key Vault managed Azure Storage Account.
PARAMETERS
-AccountName <String>
Key Vault managed storage account name. Cmdlet constructs the FQDN of a managed storage account name from vault name, currently selected
environment and manged storage account name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ActiveKeyName <String>
Active key name. If not specified, the existing value of managed storage account's active key name remains unchanged
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AutoRegenerateKey <Boolean>
Auto regenerate key. If not specified, the existing value of auto regenerate key of managed storage account remains unchanged
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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>
If present, enables a use of a managed storage account key for sas token generation if value is true. Disables use of a managed storage
account key for sas token generation if value is false. If not specified, the existing value of the storage account's enabled/disabled state
remains unchanged.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Cmdlet does not return object by default. If this switch is specified, return managed storage account object.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RegenerationPeriod <TimeSpan>
Regeneration period. If auto regenerate key is enabled, this value specifies the timespan after which managed storage account's inactive
keygets auto regenerated and becomes the active key. If not specified, the existing value of regeneration period of keys of managed storage
account remains unchanged
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
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>
Vault name. Cmdlet constructs the FQDN of a 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
-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.ManagedStorageAccount
NOTES
Example 1:Update the active key to 'key2' on a Key Vault managed Azure Storage Account.
PS C:\\> Update-AzureKeyVaultManagedStorageAccount -VaultName 'myvault' -AccountName 'mystorageaccount' -ActiveKeyName 'key2'
Updates the Key Vault managed Azure Storage Account active key to 'key2'. 'key2' will be used to generate SAS tokens after this update.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ageaccount
AzureRM.KeyVault