Microsoft.Storage storageAccounts/blobServices/containers 2022-09-01

• 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

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@2022-09-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    defaultEncryptionScope: 'string'
    denyEncryptionScopeOverride: bool
    enableNfsV3AllSquash: bool
    enableNfsV3RootSquash: bool
    immutableStorageWithVersioning: {
      enabled: bool
    }
    metadata: {
      {customized property}: 'string'
    }
    publicAccess: 'string'
  }
}

Property values

storageAccounts/blobServices/containers

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. Start with lowercase letter or number. 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: blobServices
properties	Properties of the blob container.	ContainerProperties

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
enableNfsV3AllSquash	Enable NFSv3 all squash on blob container.	bool
enableNfsV3RootSquash	Enable NFSv3 root squash on blob container.	bool
immutableStorageWithVersioning	The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.	ImmutableStorageWithVersioning
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'

ImmutableStorageWithVersioning

Name	Description	Value
enabled	This is an immutable property, when set to true it enables object level immutability at the container level.	bool

ContainerPropertiesMetadata

Name	Description	Value
{customized property}		string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
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.
JBoss EAP on RHEL (clustered, VMSS)	This template allows you to create RHEL 8.6 VMSS instances 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.
min.io Azure Gateway	Fully private min.io Azure Gateway deployment to provide an S3 compliant storage API backed by blob storage
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.
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
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
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 Storage Account & enable protection via Backup Vault	Template that creates storage account and enable operational and vaulted backup via Backup Vault
Create a data share from a storage account	This template creates a data share from a storage account
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.
Deploy Azure Data Explorer db with Event Grid connection	Deploy Azure Data Explorer db with Event Grid connection.
Create AML workspace with multiple Datasets & Datastores	This template creates Azure Machine Learning workspace with multiple datasets & datastores.
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 a storage account with multiple Blob containers	Creates an Azure storage account and multiple blob containers.
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.
Azure Synapse Proof-of-Concept	This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools
App Service Environment with Azure SQL backend	This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.
Web App with diagnostics logging to Blob Container	Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled.

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": "2022-09-01",
  "name": "string",
  "properties": {
    "defaultEncryptionScope": "string",
    "denyEncryptionScopeOverride": "bool",
    "enableNfsV3AllSquash": "bool",
    "enableNfsV3RootSquash": "bool",
    "immutableStorageWithVersioning": {
      "enabled": "bool"
    },
    "metadata": {
      "{customized property}": "string"
    },
    "publicAccess": "string"
  }
}

Property values

storageAccounts/blobServices/containers

Name	Description	Value
type	The resource type	'Microsoft.Storage/storageAccounts/blobServices/containers'
apiVersion	The resource api version	'2022-09-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. Start with lowercase letter or number. Can't use consecutive hyphens.
properties	Properties of the blob container.	ContainerProperties

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
enableNfsV3AllSquash	Enable NFSv3 all squash on blob container.	bool
enableNfsV3RootSquash	Enable NFSv3 root squash on blob container.	bool
immutableStorageWithVersioning	The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.	ImmutableStorageWithVersioning
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'

ImmutableStorageWithVersioning

Name	Description	Value
enabled	This is an immutable property, when set to true it enables object level immutability at the container level.	bool

ContainerPropertiesMetadata

Name	Description	Value
{customized property}		string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
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.
JBoss EAP on RHEL (clustered, VMSS)	This template allows you to create RHEL 8.6 VMSS instances 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.
min.io Azure Gateway	Fully private min.io Azure Gateway deployment to provide an S3 compliant storage API backed by blob storage
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.
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
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
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 Storage Account & enable protection via Backup Vault	Template that creates storage account and enable operational and vaulted backup via Backup Vault
Create a data share from a storage account	This template creates a data share from a storage account
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.
Deploy Azure Data Explorer db with Event Grid connection	Deploy Azure Data Explorer db with Event Grid connection.
Create AML workspace with multiple Datasets & Datastores	This template creates Azure Machine Learning workspace with multiple datasets & datastores.
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 a storage account with multiple Blob containers	Creates an Azure storage account and multiple blob containers.
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.
Azure Synapse Proof-of-Concept	This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools
App Service Environment with Azure SQL backend	This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.
Web App with diagnostics logging to Blob Container	Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled.

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@2022-09-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      defaultEncryptionScope = "string"
      denyEncryptionScopeOverride = bool
      enableNfsV3AllSquash = bool
      enableNfsV3RootSquash = bool
      immutableStorageWithVersioning = {
        enabled = bool
      }
      metadata = {
        {customized property} = "string"
      }
      publicAccess = "string"
    }
  })
}

Property values

storageAccounts/blobServices/containers

Name	Description	Value
type	The resource type	"Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
name	The resource name	string (required) Character limit: 3-63 Valid characters: Lowercase letters, numbers, and hyphens. Start with lowercase letter or number. Can't use consecutive hyphens.
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: blobServices
properties	Properties of the blob container.	ContainerProperties

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
enableNfsV3AllSquash	Enable NFSv3 all squash on blob container.	bool
enableNfsV3RootSquash	Enable NFSv3 root squash on blob container.	bool
immutableStorageWithVersioning	The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.	ImmutableStorageWithVersioning
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"

ImmutableStorageWithVersioning

Name	Description	Value
enabled	This is an immutable property, when set to true it enables object level immutability at the container level.	bool

ContainerPropertiesMetadata

Name	Description	Value
{customized property}		string