Microsoft.Storage storageAccounts/fileServices 2020-08-01-preview
Bicep resource definition
The storageAccounts/fileServices 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Storage/storageAccounts/fileServices@2020-08-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
cors: {
corsRules: [
{
allowedHeaders: [
'string'
]
allowedMethods: [
'string'
]
allowedOrigins: [
'string'
]
exposedHeaders: [
'string'
]
maxAgeInSeconds: int
}
]
}
protocolSettings: {
smb: {
multichannel: {
enabled: bool
}
}
}
shareDeleteRetentionPolicy: {
days: int
enabled: bool
}
}
}
Property values
CorsRule
| Name | Description | Value |
|---|---|---|
| allowedHeaders | Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. | string[] (required) |
| allowedMethods | Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. | String array containing any of: 'DELETE' 'GET' 'HEAD' 'MERGE' 'OPTIONS' 'POST' 'PUT' (required) |
| allowedOrigins | Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains | string[] (required) |
| exposedHeaders | Required if CorsRule element is present. A list of response headers to expose to CORS clients. | string[] (required) |
| maxAgeInSeconds | Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. | int (required) |
CorsRules
| Name | Description | Value |
|---|---|---|
| corsRules | The List of CORS rules. You can include up to five CorsRule elements in the request. | CorsRule[] |
DeleteRetentionPolicy
| Name | Description | Value |
|---|---|---|
| days | Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. | int Constraints: Min value = 1 Max value = 365 |
| enabled | Indicates whether DeleteRetentionPolicy is enabled. | bool |
FileServicePropertiesProperties
| Name | Description | Value |
|---|---|---|
| cors | Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. | CorsRules |
| protocolSettings | Protocol settings for file service | ProtocolSettings |
| shareDeleteRetentionPolicy | The file service properties for share soft delete. | DeleteRetentionPolicy |
Microsoft.Storage/storageAccounts/fileServices
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| 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: storageAccounts |
| properties | The properties of File services in storage account. | FileServicePropertiesProperties |
Multichannel
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether multichannel is enabled | bool |
ProtocolSettings
| Name | Description | Value |
|---|---|---|
| smb | Setting for SMB protocol | SmbSetting |
SmbSetting
| Name | Description | Value |
|---|---|---|
| multichannel | Multichannel setting. Applies to Premium FileStorage only. | Multichannel |
ARM template resource definition
The storageAccounts/fileServices 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Storage/storageAccounts/fileServices",
"apiVersion": "2020-08-01-preview",
"name": "string",
"properties": {
"cors": {
"corsRules": [
{
"allowedHeaders": [ "string" ],
"allowedMethods": [ "string" ],
"allowedOrigins": [ "string" ],
"exposedHeaders": [ "string" ],
"maxAgeInSeconds": "int"
}
]
},
"protocolSettings": {
"smb": {
"multichannel": {
"enabled": "bool"
}
}
},
"shareDeleteRetentionPolicy": {
"days": "int",
"enabled": "bool"
}
}
}
Property values
CorsRule
| Name | Description | Value |
|---|---|---|
| allowedHeaders | Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. | string[] (required) |
| allowedMethods | Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. | String array containing any of: 'DELETE' 'GET' 'HEAD' 'MERGE' 'OPTIONS' 'POST' 'PUT' (required) |
| allowedOrigins | Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains | string[] (required) |
| exposedHeaders | Required if CorsRule element is present. A list of response headers to expose to CORS clients. | string[] (required) |
| maxAgeInSeconds | Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. | int (required) |
CorsRules
| Name | Description | Value |
|---|---|---|
| corsRules | The List of CORS rules. You can include up to five CorsRule elements in the request. | CorsRule[] |
DeleteRetentionPolicy
| Name | Description | Value |
|---|---|---|
| days | Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. | int Constraints: Min value = 1 Max value = 365 |
| enabled | Indicates whether DeleteRetentionPolicy is enabled. | bool |
FileServicePropertiesProperties
| Name | Description | Value |
|---|---|---|
| cors | Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. | CorsRules |
| protocolSettings | Protocol settings for file service | ProtocolSettings |
| shareDeleteRetentionPolicy | The file service properties for share soft delete. | DeleteRetentionPolicy |
Microsoft.Storage/storageAccounts/fileServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-08-01-preview' |
| name | The resource name | 'default' (required) |
| properties | The properties of File services in storage account. | FileServicePropertiesProperties |
| type | The resource type | 'Microsoft.Storage/storageAccounts/fileServices' |
Multichannel
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether multichannel is enabled | bool |
ProtocolSettings
| Name | Description | Value |
|---|---|---|
| smb | Setting for SMB protocol | SmbSetting |
SmbSetting
| Name | Description | Value |
|---|---|---|
| multichannel | Multichannel setting. Applies to Premium FileStorage only. | Multichannel |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Azure Cloud Shell - VNet storage |
This template deploys Azure Cloud Shell storage into an Azure virtual network. |
Terraform (AzAPI provider) resource definition
The storageAccounts/fileServices 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Storage/storageAccounts/fileServices@2020-08-01-preview"
name = "string"
body = jsonencode({
properties = {
cors = {
corsRules = [
{
allowedHeaders = [
"string"
]
allowedMethods = [
"string"
]
allowedOrigins = [
"string"
]
exposedHeaders = [
"string"
]
maxAgeInSeconds = int
}
]
}
protocolSettings = {
smb = {
multichannel = {
enabled = bool
}
}
}
shareDeleteRetentionPolicy = {
days = int
enabled = bool
}
}
})
}
Property values
CorsRule
| Name | Description | Value |
|---|---|---|
| allowedHeaders | Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. | string[] (required) |
| allowedMethods | Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. | String array containing any of: 'DELETE' 'GET' 'HEAD' 'MERGE' 'OPTIONS' 'POST' 'PUT' (required) |
| allowedOrigins | Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains | string[] (required) |
| exposedHeaders | Required if CorsRule element is present. A list of response headers to expose to CORS clients. | string[] (required) |
| maxAgeInSeconds | Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. | int (required) |
CorsRules
| Name | Description | Value |
|---|---|---|
| corsRules | The List of CORS rules. You can include up to five CorsRule elements in the request. | CorsRule[] |
DeleteRetentionPolicy
| Name | Description | Value |
|---|---|---|
| days | Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. | int Constraints: Min value = 1 Max value = 365 |
| enabled | Indicates whether DeleteRetentionPolicy is enabled. | bool |
FileServicePropertiesProperties
| Name | Description | Value |
|---|---|---|
| cors | Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. | CorsRules |
| protocolSettings | Protocol settings for file service | ProtocolSettings |
| shareDeleteRetentionPolicy | The file service properties for share soft delete. | DeleteRetentionPolicy |
Microsoft.Storage/storageAccounts/fileServices
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: storageAccounts |
| properties | The properties of File services in storage account. | FileServicePropertiesProperties |
| type | The resource type | "Microsoft.Storage/storageAccounts/fileServices@2020-08-01-preview" |
Multichannel
| Name | Description | Value |
|---|---|---|
| enabled | Indicates whether multichannel is enabled | bool |
ProtocolSettings
| Name | Description | Value |
|---|---|---|
| smb | Setting for SMB protocol | SmbSetting |
SmbSetting
| Name | Description | Value |
|---|---|---|
| multichannel | Multichannel setting. Applies to Premium FileStorage only. | Multichannel |