Skip to content

Latest commit

 

History

History
145 lines (107 loc) · 3.28 KB

New-AzureStorageKey.md

File metadata and controls

145 lines (107 loc) · 3.28 KB
Raw
external help file ms.assetid online version schema
Microsoft.WindowsAzure.Commands.ServiceManagement.dll-Help.xml
09ABE9E2-1080-4DEF-92DD-B8FF4C8B308C
2.0.0

New-AzureStorageKey

SYNOPSIS

Regenerates storage keys for an Azure storage account.

[!INCLUDE rdfe-banner]

SYNTAX

New-AzureStorageKey [-KeyType] <String> [-StorageAccountName] <String> [-Profile <AzureSMProfile>]
 [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

The New-AzureStorageKey cmdlet regenerates the primary or secondary key for an Azure Storage account. It returns an object that contains the storage account name, primary key, and secondary key as properties.

EXAMPLES

Example 1: Regenerate a primary storage key

PS C:\> New-AzureStorageKey -KeyType "Primary" -StorageAccountName "ContosoStore01"

This command regenerates the primary storage key for the ContosoStore01 storage account.

Example 2: Regenerate a secondary storage key and save it in a variable

PS C:\> $ContosoStoreKey = New-AzureStorageKey -KeyType "Secondary" -StorageAccountName "ContosoStore01"

This command regenerate the secondary storage key for the ContosoStore01 storage account and stores the updated storage account key information in the $ContosoStoreKey.

PARAMETERS

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type: ActionPreference
Parameter Sets: (All)
Aliases: infa

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InformationVariable

Specifies an information variable.

Type: String
Parameter Sets: (All)
Aliases: iv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeyType

Specifies which key to regenerate. Valid values are: Primary and Secondary.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type: AzureSMProfile
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StorageAccountName

Specifies the name of the Azure Storage account for which to regenerate a key.

Type: String
Parameter Sets: (All)
Aliases: ServiceName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

StorageServiceKeys

NOTES

RELATED LINKS

Get-AzureStorageKey