Microsoft.Storage storageAccounts/fileServices/shares 2023-01-01
Bicep resource definition
The storageAccounts/fileServices/shares resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Storage/storageAccounts/fileServices/shares resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Storage/storageAccounts/fileServices/shares@2023-01-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
accessTier: 'string'
enabledProtocols: 'string'
metadata: {
{customized property}: 'string'
}
rootSquash: 'string'
shareQuota: int
signedIdentifiers: [
{
accessPolicy: {
expiryTime: 'string'
permission: 'string'
startTime: 'string'
}
id: 'string'
}
]
}
}
Property values
storageAccounts/fileServices/shares
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 3-63 Valid characters: Lowercase letters, numbers, and hyphens. Can't start or end with hyphen. Can't use consecutive hyphens. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: fileServices |
| properties | Properties of the file share. | FileShareProperties |
FileShareProperties
| Name | Description | Value |
|---|---|---|
| accessTier | Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. | 'Cool' 'Hot' 'Premium' 'TransactionOptimized' |
| enabledProtocols | The authentication protocol that is used for the file share. Can only be specified when creating a share. | 'NFS' 'SMB' |
| metadata | A name-value pair to associate with the share as metadata. | FileSharePropertiesMetadata |
| rootSquash | The property is for NFS share only. The default is NoRootSquash. | 'AllSquash' 'NoRootSquash' 'RootSquash' |
| shareQuota | The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. | int Constraints: Min value = 1 Max value = 102400 |
| signedIdentifiers | List of stored access policies specified on the share. | SignedIdentifier[] |
FileSharePropertiesMetadata
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
SignedIdentifier
| Name | Description | Value |
|---|---|---|
| accessPolicy | Access policy | AccessPolicy |
| id | An unique identifier of the stored access policy. | string |
AccessPolicy
| Name | Description | Value |
|---|---|---|
| expiryTime | Expiry time of the access policy | string |
| permission | List of abbreviated permissions. | string |
| startTime | Start time of the access policy | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy Drupal with VM Scale Set, Azure Files and Mysql |
Deploy a VM Scale Set behind a load balancer/NAT & each VM running Drupal (Apache / PHP). All nodes share the created Azure file share storage and MySQL database |
| Azure Cloud Shell - VNet storage |
This template deploys Azure Cloud Shell storage into an Azure virtual network. |
| Connect to an Azure File Share via a Private Endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint. |
| Create a storage account with file share |
This template creates an Azure storage account and file share. |
| Create a storage account with multiple file shares |
Creates an Azure storage account and multiple file shares. |
| Private Function App and private endpoint-secured Storage |
This template provisions a function app on a Premium plan that has private endpoints and communicates with Azure Storage over private endpoints. |
| Create Function App and private endpoint-secured Storage |
This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints. |
| Function App secured by Azure Frontdoor |
This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link. |
ARM template resource definition
The storageAccounts/fileServices/shares resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Storage/storageAccounts/fileServices/shares resource, add the following JSON to your template.
{
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"apiVersion": "2023-01-01",
"name": "string",
"properties": {
"accessTier": "string",
"enabledProtocols": "string",
"metadata": {
"{customized property}": "string"
},
"rootSquash": "string",
"shareQuota": "int",
"signedIdentifiers": [
{
"accessPolicy": {
"expiryTime": "string",
"permission": "string",
"startTime": "string"
},
"id": "string"
}
]
}
}
Property values
storageAccounts/fileServices/shares
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Storage/storageAccounts/fileServices/shares' |
| apiVersion | The resource api version | '2023-01-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 3-63 Valid characters: Lowercase letters, numbers, and hyphens. Can't start or end with hyphen. Can't use consecutive hyphens. |
| properties | Properties of the file share. | FileShareProperties |
FileShareProperties
| Name | Description | Value |
|---|---|---|
| accessTier | Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. | 'Cool' 'Hot' 'Premium' 'TransactionOptimized' |
| enabledProtocols | The authentication protocol that is used for the file share. Can only be specified when creating a share. | 'NFS' 'SMB' |
| metadata | A name-value pair to associate with the share as metadata. | FileSharePropertiesMetadata |
| rootSquash | The property is for NFS share only. The default is NoRootSquash. | 'AllSquash' 'NoRootSquash' 'RootSquash' |
| shareQuota | The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. | int Constraints: Min value = 1 Max value = 102400 |
| signedIdentifiers | List of stored access policies specified on the share. | SignedIdentifier[] |
FileSharePropertiesMetadata
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
SignedIdentifier
| Name | Description | Value |
|---|---|---|
| accessPolicy | Access policy | AccessPolicy |
| id | An unique identifier of the stored access policy. | string |
AccessPolicy
| Name | Description | Value |
|---|---|---|
| expiryTime | Expiry time of the access policy | string |
| permission | List of abbreviated permissions. | string |
| startTime | Start time of the access policy | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Deploy Drupal with VM Scale Set, Azure Files and Mysql |
Deploy a VM Scale Set behind a load balancer/NAT & each VM running Drupal (Apache / PHP). All nodes share the created Azure file share storage and MySQL database |
| Azure Cloud Shell - VNet storage |
This template deploys Azure Cloud Shell storage into an Azure virtual network. |
| Connect to an Azure File Share via a Private Endpoint |
This sample shows how to use configure a virtual network and private DNS zone to access an Azure File Share via a private endpoint. |
| Create a storage account with file share |
This template creates an Azure storage account and file share. |
| Create a storage account with multiple file shares |
Creates an Azure storage account and multiple file shares. |
| Private Function App and private endpoint-secured Storage |
This template provisions a function app on a Premium plan that has private endpoints and communicates with Azure Storage over private endpoints. |
| Create Function App and private endpoint-secured Storage |
This template allows you to deploy an Azure Function App that communicates with Azure Storage over private endpoints. |
| Function App secured by Azure Frontdoor |
This template allows you to deploy an azure premium function protected and published by Azure Frontdoor premium. The conenction between Azure Frontdoor and Azure Functions is protected by Azure Private Link. |
Terraform (AzAPI provider) resource definition
The storageAccounts/fileServices/shares resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Storage/storageAccounts/fileServices/shares resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Storage/storageAccounts/fileServices/shares@2023-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
accessTier = "string"
enabledProtocols = "string"
metadata = {
{customized property} = "string"
}
rootSquash = "string"
shareQuota = int
signedIdentifiers = [
{
accessPolicy = {
expiryTime = "string"
permission = "string"
startTime = "string"
}
id = "string"
}
]
}
})
}
Property values
storageAccounts/fileServices/shares
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Storage/storageAccounts/fileServices/shares@2023-01-01" |
| name | The resource name | string (required) Character limit: 3-63 Valid characters: Lowercase letters, numbers, and hyphens. Can't start or end with hyphen. Can't use consecutive hyphens. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: fileServices |
| properties | Properties of the file share. | FileShareProperties |
FileShareProperties
| Name | Description | Value |
|---|---|---|
| accessTier | Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. | "Cool" "Hot" "Premium" "TransactionOptimized" |
| enabledProtocols | The authentication protocol that is used for the file share. Can only be specified when creating a share. | "NFS" "SMB" |
| metadata | A name-value pair to associate with the share as metadata. | FileSharePropertiesMetadata |
| rootSquash | The property is for NFS share only. The default is NoRootSquash. | "AllSquash" "NoRootSquash" "RootSquash" |
| shareQuota | The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. | int Constraints: Min value = 1 Max value = 102400 |
| signedIdentifiers | List of stored access policies specified on the share. | SignedIdentifier[] |
FileSharePropertiesMetadata
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
SignedIdentifier
| Name | Description | Value |
|---|---|---|
| accessPolicy | Access policy | AccessPolicy |
| id | An unique identifier of the stored access policy. | string |
AccessPolicy
| Name | Description | Value |
|---|---|---|
| expiryTime | Expiry time of the access policy | string |
| permission | List of abbreviated permissions. | string |
| startTime | Start time of the access policy | string |