Microsoft.Storage storageAccounts/blobServices/containers 2020-08-01-preview

• Latest
• 2023-05-01
• 2023-04-01
• 2023-01-01
• 2022-09-01
• 2022-05-01
• 2021-09-01
• 2021-08-01
• 2021-06-01
• 2021-04-01
• 2021-02-01
• 2021-01-01
• 2020-08-01-preview
• 2019-06-01
• 2019-04-01
• 2018-11-01
• 2018-07-01
• 2018-03-01-preview
• 2018-02-01

Bicep resource definition

The storageAccounts/blobServices/containers 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/containers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Storage/storageAccounts/blobServices/containers@2020-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    defaultEncryptionScope: 'string'
    denyEncryptionScopeOverride: bool
    metadata: {
      {customized property}: 'string'
    }
    publicAccess: 'string'
  }
}

Property values

ContainerProperties

Name	Description	Value
defaultEncryptionScope	Default the container to use specified encryption scope for all writes.	string
denyEncryptionScopeOverride	Block override of encryption scope from the container default.	bool
metadata	A name-value pair to associate with the container as metadata.	ContainerPropertiesMetadata
publicAccess	Specifies whether data in the container may be accessed publicly and the level of access.	'Blob' 'Container' 'None'

ContainerPropertiesMetadata

Name	Description	Value

Microsoft.Storage/storageAccounts/blobServices/containers

Name	Description	Value
name	The resource name	string Constraints: Min length = 3 Max length = 3 (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/blobServices
properties	Properties of the blob container.	ContainerProperties

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create a blob for the data factory copy data tool quickstart	This template creates a blob storage and uploads a file for the copy data tool quickstart
Create a data share from a storage account	This template creates a data share from a storage account
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.
Create Storage Account & enable protection via Backup Vault	Template that creates storage account and enable operational and vaulted backup via Backup Vault
Create Storage Account with SFTP enabled	Creates an Azure Storage account and a blob container that can be accessed using SFTP protocol. Access can be password or public-key based.
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.
Front Door Premium with blob origin and Private Link	This template creates a Front Door Premium and an Azure Storage blob container, and uses a private endpoint for Front Door to send traffic to the storage account.
JBoss EAP on RHEL (clustered, multi-VM)	This template allows you to create multiple RHEL 8.6 VMs running JBoss EAP 7.4 cluster and also deploys a web application called eap-session-replication, you can log into the admin console using the JBoss EAP username and password configured at the time of the deployment.
More is possible with Azure Data Factory - One click to try Azure Data Factory	This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
Use ARM template to create IoT Hub, route and view messages	Use this template to deploy an IoT Hub and a storage account. Run an app to send messages to the hub that are routed to storage, then view the results.

ARM template resource definition

The storageAccounts/blobServices/containers 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/containers resource, add the following JSON to your template.

{
  "type": "Microsoft.Storage/storageAccounts/blobServices/containers",
  "apiVersion": "2020-08-01-preview",
  "name": "string",
  "properties": {
    "defaultEncryptionScope": "string",
    "denyEncryptionScopeOverride": "bool",
    "metadata": {
      "{customized property}": "string"
    },
    "publicAccess": "string"
  }
}

Property values

ContainerProperties

Name	Description	Value
defaultEncryptionScope	Default the container to use specified encryption scope for all writes.	string
denyEncryptionScopeOverride	Block override of encryption scope from the container default.	bool
metadata	A name-value pair to associate with the container as metadata.	ContainerPropertiesMetadata
publicAccess	Specifies whether data in the container may be accessed publicly and the level of access.	'Blob' 'Container' 'None'

ContainerPropertiesMetadata

Name	Description	Value

Microsoft.Storage/storageAccounts/blobServices/containers

Name	Description	Value
apiVersion	The api version	'2020-08-01-preview'
name	The resource name	string Constraints: Min length = 3 Max length = 3 (required)
properties	Properties of the blob container.	ContainerProperties
type	The resource type	'Microsoft.Storage/storageAccounts/blobServices/containers'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a blob for the data factory copy data tool quickstart	This template creates a blob storage and uploads a file for the copy data tool quickstart
Create a data share from a storage account	This template creates a data share from a storage account
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.
Create Storage Account & enable protection via Backup Vault	Template that creates storage account and enable operational and vaulted backup via Backup Vault
Create Storage Account with SFTP enabled	Creates an Azure Storage account and a blob container that can be accessed using SFTP protocol. Access can be password or public-key based.
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.
Front Door Premium with blob origin and Private Link	This template creates a Front Door Premium and an Azure Storage blob container, and uses a private endpoint for Front Door to send traffic to the storage account.
JBoss EAP on RHEL (clustered, multi-VM)	This template allows you to create multiple RHEL 8.6 VMs running JBoss EAP 7.4 cluster and also deploys a web application called eap-session-replication, you can log into the admin console using the JBoss EAP username and password configured at the time of the deployment.
More is possible with Azure Data Factory - One click to try Azure Data Factory	This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob
Use ARM template to create IoT Hub, route and view messages	Use this template to deploy an IoT Hub and a storage account. Run an app to send messages to the hub that are routed to storage, then view the results.

Terraform (AzAPI provider) resource definition

The storageAccounts/blobServices/containers 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/containers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/blobServices/containers@2020-08-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      defaultEncryptionScope = "string"
      denyEncryptionScopeOverride = bool
      metadata = {
        {customized property} = "string"
      }
      publicAccess = "string"
    }
  })
}

Property values

ContainerProperties

Name	Description	Value
defaultEncryptionScope	Default the container to use specified encryption scope for all writes.	string
denyEncryptionScopeOverride	Block override of encryption scope from the container default.	bool
metadata	A name-value pair to associate with the container as metadata.	ContainerPropertiesMetadata
publicAccess	Specifies whether data in the container may be accessed publicly and the level of access.	'Blob' 'Container' 'None'

ContainerPropertiesMetadata

Name	Description	Value

Microsoft.Storage/storageAccounts/blobServices/containers

Name	Description	Value
name	The resource name	string Constraints: Min length = 3 Max length = 3 (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: storageAccounts/blobServices
properties	Properties of the blob container.	ContainerProperties
type	The resource type	"Microsoft.Storage/storageAccounts/blobServices/containers@2020-08-01-preview"