New-AzureStorageKey
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
New-AzureStorageKey
Regenerates storage keys for an Azure storage account.
Syntax
Parameter Set: Default
New-AzureStorageKey [-KeyType] <String> [-StorageAccountName] <String> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The New-AzureStorageKey cmdlet regenerates the primary or secondary key for an Azure storage account. It returns an object with the storage account name, primary key, and secondary key as properties.
Parameters
-KeyType<String>
Specifies which key to regenerate. Supported values are "Primary" and "Secondary".
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StorageAccountName<String>
Specifies the name of the Azure storage account to regenerate a key for.
Aliases |
none |
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- StorageServiceKeys
Examples
-------------- Example 1 --------------
This command regenerates the primary storage key for the "mystore1" storage account.
PS C:\> New-AzureStorageKey –KeyType "Primary" –StorageAccountName "mystore1"
-------------- Example 2 --------------
This command regenerates the secondary storage key for the "mystore1" storage account and stores the updated storage account key information in $myStoreKey.
PS C:\> $myStoreKey = New-AzureStorageKey –KeyType "Secondary" –StorageAccountName "mystore1"