Microsoft.Storage storageAccounts/blobServices 2018-07-01
Bicep resource definition
The storageAccounts/blobServices 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/blobServices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Storage/storageAccounts/blobServices@2018-07-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
cors: {
corsRules: [
{
allowedHeaders: [
'string'
]
allowedMethods: [
'string'
]
allowedOrigins: [
'string'
]
exposedHeaders: [
'string'
]
maxAgeInSeconds: int
}
]
}
defaultServiceVersion: 'string'
deleteRetentionPolicy: {
days: int
enabled: bool
}
}
}
Property values
BlobServicePropertiesProperties
| Name | Description | Value |
|---|---|---|
| cors | Specifies CORS rules for the Blob 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 Blob service. | CorsRules |
| defaultServiceVersion | DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. | string |
| deleteRetentionPolicy | The blob service properties for soft delete. | DeleteRetentionPolicy |
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 blob 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 for the Blob service. | bool |
Microsoft.Storage/storageAccounts/blobServices
| 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 a storage account’s Blob service. | BlobServicePropertiesProperties |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Create a storage account with multiple Blob containers | Creates an Azure storage account and multiple blob containers. |
| Create a V2 data factory | This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Create an Azure Machine Learning Sweep job | This template creates an Azure Machine Learning Sweep job for hyperparameter tuning. |
| Create an Azure Storage Account and Blob Container on Azure | This template creates an Azure Storage account and a blob container. |
| Creates a Dapr microservices app using Container Apps | Create a Dapr microservices app using Container Apps. |
| Creates a Dapr pub-sub servicebus app using Container Apps | Create a Dapr pub-sub servicebus app using Container Apps. |
| Deploy Azure Data Explorer db with Event Grid connection | Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Secure Azure AI Studio with a managed virtual network | This template creates a secure Azure AI Studio environment with robust network and identity security restrictions. |
| FinOps hub | This template creates a new FinOps hub instance, including Data Lake storage and a Data Factory. |
| Storage Account with SSE and blob deletion retention policy | This template creates a Storage Account with Storage Service Encryption and a blob deletion retention policy |
ARM template resource definition
The storageAccounts/blobServices 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/blobServices resource, add the following JSON to your template.
{
"type": "Microsoft.Storage/storageAccounts/blobServices",
"apiVersion": "2018-07-01",
"name": "string",
"properties": {
"cors": {
"corsRules": [
{
"allowedHeaders": [ "string" ],
"allowedMethods": [ "string" ],
"allowedOrigins": [ "string" ],
"exposedHeaders": [ "string" ],
"maxAgeInSeconds": "int"
}
]
},
"defaultServiceVersion": "string",
"deleteRetentionPolicy": {
"days": "int",
"enabled": "bool"
}
}
}
Property values
BlobServicePropertiesProperties
| Name | Description | Value |
|---|---|---|
| cors | Specifies CORS rules for the Blob 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 Blob service. | CorsRules |
| defaultServiceVersion | DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. | string |
| deleteRetentionPolicy | The blob service properties for soft delete. | DeleteRetentionPolicy |
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 blob 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 for the Blob service. | bool |
Microsoft.Storage/storageAccounts/blobServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-07-01' |
| name | The resource name | 'default' (required) |
| properties | The properties of a storage account’s Blob service. | BlobServicePropertiesProperties |
| type | The resource type | 'Microsoft.Storage/storageAccounts/blobServices' |
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. |
| Create a storage account with multiple Blob containers |
Creates an Azure storage account and multiple blob containers. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Create an Azure Machine Learning Sweep job |
This template creates an Azure Machine Learning Sweep job for hyperparameter tuning. |
| Create an Azure Storage Account and Blob Container on Azure |
This template creates an Azure Storage account and a blob container. |
| Creates a Dapr microservices app using Container Apps |
Create a Dapr microservices app using Container Apps. |
| Creates a Dapr pub-sub servicebus app using Container Apps |
Create a Dapr pub-sub servicebus app using Container Apps. |
| Deploy Azure Data Explorer db with Event Grid connection |
Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Secure Azure AI Studio with a managed virtual network |
This template creates a secure Azure AI Studio environment with robust network and identity security restrictions. |
| FinOps hub |
This template creates a new FinOps hub instance, including Data Lake storage and a Data Factory. |
| Storage Account with SSE and blob deletion retention policy |
This template creates a Storage Account with Storage Service Encryption and a blob deletion retention policy |
Terraform (AzAPI provider) resource definition
The storageAccounts/blobServices 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/blobServices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Storage/storageAccounts/blobServices@2018-07-01"
name = "string"
body = jsonencode({
properties = {
cors = {
corsRules = [
{
allowedHeaders = [
"string"
]
allowedMethods = [
"string"
]
allowedOrigins = [
"string"
]
exposedHeaders = [
"string"
]
maxAgeInSeconds = int
}
]
}
defaultServiceVersion = "string"
deleteRetentionPolicy = {
days = int
enabled = bool
}
}
})
}
Property values
BlobServicePropertiesProperties
| Name | Description | Value |
|---|---|---|
| cors | Specifies CORS rules for the Blob 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 Blob service. | CorsRules |
| defaultServiceVersion | DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. | string |
| deleteRetentionPolicy | The blob service properties for soft delete. | DeleteRetentionPolicy |
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 blob 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 for the Blob service. | bool |
Microsoft.Storage/storageAccounts/blobServices
| 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 a storage account’s Blob service. | BlobServicePropertiesProperties |
| type | The resource type | "Microsoft.Storage/storageAccounts/blobServices@2018-07-01" |