Set-AzureStorageAccount

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-AzureStorageAccount

Updates the properties of a storage account in an Azure subscription.

Syntax

Parameter Set: GeoReplicationEnabled
Set-AzureStorageAccount [-StorageAccountName] <String> [-Description <String> ] [-GeoReplicationEnabled <Boolean> ] [-Label <String> ] [ <CommonParameters>]

Parameter Set: AccountType
Set-AzureStorageAccount [-StorageAccountName] <String> [-Description <String> ] [-Label <String> ] [-Type <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 Set-AzureStorageAccount cmdlet updates the properties of an Azure storage account in the current subscription. Properties that can be set are: "Label", "Description" and "GeoReplicationEnabled".

Parameters

-Description<String>

Specifies a description for the storage account. The description may be up to 1024 characters in length. You must specify either a label or a description, or both.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-GeoReplicationEnabled<Boolean>

Specifies whether geo-replication is enabled for the storage account.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Label<String>

Specifies a label for the storage account. The label may be up to 100 characters in length. You must specify either a label or a description, or both.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-StorageAccountName<String>

Specifies the name of the storage account to be updated.


Aliases

ServiceName

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Type<String>

Specifies the type of the storage account. Valid values are:

-- Standard_LRS
-- Standard_ZRS
-- Standard_GRS
-- Standard_RAGRS

If you do not specify this parameter, the cmdlet uses a default value of Standard_GRS.

Standard_ZRS accounts cannot be changed to other account types, and vice versa. The GeoReplicationEnabled parameter functionality is the same as specifying Standard_GRS in Type parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://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.

  • ManagementOperationContext

Examples

-------------- Example 1 --------------

This command updates the label and description of the 'qatest1' storage account in the specified subscription.


C:\PS>Set-AzureStorageAccount -StorageAccountName qatest1 -Label "QATestAccnt" -Description "QA test storage account"

-------------- Example 2 --------------

This command enables geo-replication of the "qatest1" storage account in the current subscription.


C:\PS>Set-AzureStorageAccount -StorageAccountName "qatest1" –GeoReplicationEnabled $True –Label "QATestAccount" 

Related topics

Show: