Update-AzRmStorageShare

Module:

Az.Storage Module

Modifies a Storage file share.

Syntax

AccountName (Default)

Update-AzRmStorageShare
    [-ResourceGroupName] <String>
    [-StorageAccountName] <String>
    -Name <String>
    [-QuotaGiB <Int32>]
    [-Metadata <Hashtable>]
    [-AccessTier <String>]
    [-RootSquash <String>]
    [-ProvisionedBandwidthMibps <Int32>]
    [-ProvisionedIops <Int32>]
    [-PaidBurstingEnabled <Boolean>]
    [-PaidBurstingMaxIops <Int32>]
    [-PaidBurstingMaxBandwidthMibps <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AccountObject

Update-AzRmStorageShare
    -Name <String>
    -StorageAccount <PSStorageAccount>
    [-QuotaGiB <Int32>]
    [-Metadata <Hashtable>]
    [-AccessTier <String>]
    [-RootSquash <String>]
    [-ProvisionedBandwidthMibps <Int32>]
    [-ProvisionedIops <Int32>]
    [-PaidBurstingEnabled <Boolean>]
    [-PaidBurstingMaxIops <Int32>]
    [-PaidBurstingMaxBandwidthMibps <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ShareResourceId

Update-AzRmStorageShare
    [-ResourceId] <String>
    [-QuotaGiB <Int32>]
    [-Metadata <Hashtable>]
    [-AccessTier <String>]
    [-RootSquash <String>]
    [-ProvisionedBandwidthMibps <Int32>]
    [-ProvisionedIops <Int32>]
    [-PaidBurstingEnabled <Boolean>]
    [-PaidBurstingMaxIops <Int32>]
    [-PaidBurstingMaxBandwidthMibps <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ShareObject

Update-AzRmStorageShare
    -InputObject <PSShare>
    [-QuotaGiB <Int32>]
    [-Metadata <Hashtable>]
    [-AccessTier <String>]
    [-RootSquash <String>]
    [-ProvisionedBandwidthMibps <Int32>]
    [-ProvisionedIops <Int32>]
    [-PaidBurstingEnabled <Boolean>]
    [-PaidBurstingMaxIops <Int32>]
    [-PaidBurstingMaxBandwidthMibps <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-AzRmStorageShare cmdlet modifies a Storage file share.

Examples

Example 1: Modifies a Storage file share's metadata and share quota with Storage account name and share name

$share = Update-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -QuotaGiB 200 -Metadata @{tag0="value0";tag1="value1"}

$share

   ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount

Name     QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes
----     -------- ---------------- ---------- ------- ------- ---------------
myshare  200

$share.Metadata

Key  Value
---  -----
tag0 value0
tag1 value1

This command modifies a Storage file share's metadata and share quota with Storage account name and share name, and show the modify result with the returned file share object.

Example 2: Modifies metadata on a Storage file share with Storage account object and share name

$accountObject = Get-AzStorageAccount -ResourceGroupName "myResourceGroup" -StorageAccountName "myStorageAccount"
$share = Update-AzRmStorageShare -StorageAccount $accountObject -Name "myshare" -Metadata @{tag0="value0";tag1="value1"}

This command modifies metadata on a Storage file share with Storage account object and share name.

Example 3: Modifies share quota for all Storage file shares in a Storage account with pipeline

Get-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" | Update-AzRmStorageShare -QuotaGiB 5000

ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount

Name     QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes
----     -------- ---------------- ---------- ------- ------- ---------------
share1   5000
share2   5000

This command modifies share quota as 5000 GiB for all Storage file shares in a Storage account with pipeline.

Example 4: Modify a Storage file share with accesstier as Cool

$share = Update-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -AccessTier Cool

ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount

Name     QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes
----     -------- ---------------- ---------- ------- ------- ---------------
myshare                            Cool

This command modifies a Storage file share with accesstier as Cool.

Example 5: Modifies rootsquash for a file shares in a Storage account

$share = Update-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -RootSquash NoRootSquash

$share

   ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount

Name     QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes
----     -------- ---------------- ---------- ------- ------- ---------------
myshare

$share.RootSquash
NoRootSquash

This command modifies share RootSquash property to NoRootSquash. RootSquash property is only available on share with EnabledProtocol as NFS.

Example 6: Modifies a Storage file share with provisioned bandwidth and IOPS

New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -ProvisionedBandwidthMibps 129 -ProvisionedIops 3032

This command modifies a Storage file share with provisioned bandwidth and IOPS, it only work on Files Provisioned v2 account type.

Example 7: Modifies a Storage file share with paid bursting bandwidth and IOPS

New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -PaidBurstingEnabled -PaidBurstingMaxBandwidthMibps 129 -PaidBurstingMaxIops 3032

This command modifies a Storage file share with paid bursting bandwidth and IOPS, it only work on Files Provisioned v1 account type.

Parameters

-AccessTier

Access tier for specific share. StorageV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

Parameter properties

Type:	String
Default value:	None
Accepted values:	TransactionOptimized, Premium, Hot, Cool
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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

Storage Share object

Parameter properties

Type:	PSShare
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Share

Parameter sets

ShareObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Metadata

Share Metadata

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Share Name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	N, ShareName

Parameter sets

AccountName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

AccountObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PaidBurstingEnabled

Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.

Parameter properties

Type:	Boolean
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PaidBurstingMaxBandwidthMibps

The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PaidBurstingMaxIops

The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProvisionedBandwidthMibps

The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the Get-AzStorageFileServiceUsage cmdlet output for the minimum and maximum allowed value for provisioned bandwidth.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProvisionedIops

The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the Get-AzStorageFileServiceUsage cmdlet output for the minimum and maximum allowed value for provisioned IOPS.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-QuotaGiB

Share Quota in Gibibyte.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Quota

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Resource Group Name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

AccountName

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

Input a File Share Resource Id.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ShareResourceId

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RootSquash

Sets reduction of the access rights for the remote superuser. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'

Parameter properties

Type:	String
Default value:	None
Accepted values:	NoRootSquash, RootSquash, AllSquash
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-StorageAccount

Storage account object

Parameter properties

Type:	PSStorageAccount
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

AccountObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-StorageAccountName

Storage Account Name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AccountName

Parameter sets

AccountName

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
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.

Inputs

String

PSStorageAccount

PSShare

Outputs

PSShare