Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzRmStorageShare
- Module:
- Az.Storage Module
Creates a Storage file share.
Syntax
AccountName (Default)
New-AzRmStorageShare
[-ResourceGroupName] <String>
[-StorageAccountName] <String>
-Name <String>
[-QuotaGiB <Int32>]
[-Metadata <Hashtable>]
[-AccessTier <String>]
[-Snapshot]
[-EnabledProtocol <String>]
[-RootSquash <String>]
[-ProvisionedBandwidthMibps <Int32>]
[-ProvisionedIops <Int32>]
[-PaidBurstingEnabled]
[-PaidBurstingMaxIops <Int32>]
[-PaidBurstingMaxBandwidthMibps <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AccountObject
New-AzRmStorageShare
-StorageAccount <PSStorageAccount>
-Name <String>
[-QuotaGiB <Int32>]
[-Metadata <Hashtable>]
[-AccessTier <String>]
[-Snapshot]
[-EnabledProtocol <String>]
[-RootSquash <String>]
[-ProvisionedBandwidthMibps <Int32>]
[-ProvisionedIops <Int32>]
[-PaidBurstingEnabled]
[-PaidBurstingMaxIops <Int32>]
[-PaidBurstingMaxBandwidthMibps <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzRmStorageShare cmdlet creates a Storage file share.
Examples
Example 1: Create a Storage file share with Storage account name and share name, with metadata and share quota as 100 GiB.
New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -QuotaGiB 100 -Metadata @{"tag1" = "value1"; "tag2" = "value2" }
ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount
Name QuotaGiB EnabledProtocol AccessTier Deleted Version ShareUsageBytes
---- -------- --------------- ---------- ------- ------- ---------------
myshare
This command creates a Storage file share with metadata and share quota as 100 GiB.
Example 2: Create a Storage file share with Storage account object
Get-AzStorageAccount -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" | New-AzRmStorageShare -Name "myshare"
ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount
Name QuotaGiB EnabledProtocol AccessTier Deleted Version ShareUsageBytes
---- -------- --------------- ---------- ------- ------- ---------------
myshare
This command creates a Storage file share with Storage account object and share name.
Example 3: Create a Storage file share with accesstier as Hot
$share = New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -AccessTier Hot
ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount
Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes
---- -------- ---------------- ---------- ------- ------- ---------------
myshare Hot
This command creates a Storage file share with accesstier as Hot.
Example 4: Create a Storage file share snapshot of an existing share
$shareSnapshot = New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -Snapshot
ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount
Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes snapshotTime
---- -------- ---------------- ---------- ------- ------- --------------- ------------
myshare 2021-05-10T08:04:08
This command creates a Storage file share snapshot of an existing base file share.
Example 5: Create a Storage file share with EnabledProtocol property as NFS, and RootSquash property as NoRootSquash
$share = New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -EnabledProtocol NFS -RootSquash NoRootSquash
$share
ResourceGroupName: myresourcegroup, StorageAccountName: mystorageaccount
Name QuotaGiB EnabledProtocols AccessTier Deleted Version ShareUsageBytes
---- -------- ---------------- ---------- ------- ------- ---------------
myshare NFS
$share.RootSquash
NoRootSquash
This command creates a Storage file share with EnabledProtocol property as NFS, and RootSquash property as NoRootSquash.
Example 6: Create a Storage file share with provisioned bandwidth and IOPS
New-AzRmStorageShare -ResourceGroupName "myresourcegroup" -StorageAccountName "mystorageaccount" -Name "myshare" -ProvisionedBandwidthMibps 129 -ProvisionedIops 3032
This command creates a Storage file share with provisioned bandwidth and IOPS, it only work on Files Provisioned v2 account type.
Example 7: Create 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 creates 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
-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
-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
-EnabledProtocol
Sets protocols for file shares. It cannot be changed after file share creation. Possible values include: 'SMB', 'NFS'
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | NFS, SMB |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Metadata
Share Metadata
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Azure File share name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | N, ShareName |
Parameter sets
-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: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-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
-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
-QuotaGiB
Share Quota in Gibibyte.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Quota |
Parameter sets
-ResourceGroupName
Resource Group Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Snapshot
Create a snapshot of existing share with same name.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageAccount
Storage account object
Parameter properties
| Type: | PSStorageAccount |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageAccountName
Storage Account Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AccountName |
Parameter sets
-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
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
Outputs
PSShare
Azure PowerShell
Feedback
Was this page helpful?