Use storage mounts in Azure Container Apps

When configuring replica-scoped storage using the Azure CLI, you must use a YAML definition to create or update your container app.

1. To update an existing container app to use replica-scoped storage, export your app's specification to a YAML file named app.yaml.

   az containerapp show -n <APP_NAME> -g <RESOURCE_GROUP_NAME> -o yaml > app.yaml
   

2. Make the following changes to your container app specification.

   • Add a volumes array to the template section of your container app definition and define a volume. If you already have a volumes array, add a new volume to the array.
     • The name is an identifier for the volume.
     • Use EmptyDir as the storageType.
   • For each container in the template that you want to mount the volume, define a volume mount in the volumeMounts array of the container definition.
     • The volumeName is the name defined in the volumes array.
     • The mountPath is the path in the container to mount the volume.

   properties:
     managedEnvironmentId: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP_NAME>/providers/Microsoft.App/managedEnvironments/<ENVIRONMENT_NAME>
     configuration:
       activeRevisionsMode: Single
     template:
       containers:
       - image: <IMAGE_NAME1>
         name: my-container-1
         volumeMounts:
         - mountPath: /myempty
           volumeName: myempty
       - image: <IMAGE_NAME_2>
         name: my-container-2
         volumeMounts:
         - mountPath: /myempty
           volumeName: myempty
       volumes:
       - name: myempty
         storageType: EmptyDir
   

3. Update your container app using the YAML file.

   az containerapp update --name <APP_NAME> --resource-group <RESOURCE_GROUP_NAME> \
       --yaml app.yaml
   

See the YAML specification for a full example.

To create a replica-scoped volume and mount it in a container, make the following changes to the container apps resource in an ARM template:

• Add a volumes array to the template section of your container app definition and define a volume. If you already have a volumes array, add a new volume to the array.
  • The name is an identifier for the volume.
  • Use EmptyDir as the storageType.
• For each container in the template that you want to mount the volume, define a volume mount in the volumeMounts array of the container definition.
  • The volumeName is the name defined in the volumes array.
  • The mountPath is the path in the container to mount the volume.

Example ARM template snippet:

{
  "apiVersion": "2022-03-01",
  "type": "Microsoft.App/containerApps",
  "name": "[parameters('containerappName')]",
  "location": "[parameters('location')]",
  "properties": {

    ...

    "template": {
      "revisionSuffix": "myrevision",
      "containers": [
        {
          "name": "main",
          "image": "[parameters('container_image')]",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          },
          "volumeMounts": [
            {
              "mountPath": "/myempty",
              "volumeName": "myempty"
            }
          ]
        },
        {
          "name": "sidecar",
          "image": "[parameters('sidecar_image')]",
          "resources": {
            "cpu": 0.5,
            "memory": "1Gi"
          },
          "volumeMounts": [
            {
              "mountPath": "/myempty",
              "volumeName": "myempty"
            }
          ]
        }
      ],
      "scale": {
        "minReplicas": 1,
        "maxReplicas": 3
      },
      "volumes": [
        {
          "name": "myempty",
          "storageType": "EmptyDir"
        }
      ]
    }
  }
}

See the ARM template API specification for a full example.

To create a replica-scoped volume and mount it in a container, deploy a new revision of your container app using the Azure portal.

1. In the Azure portal, navigate to your container app.

2. Select Revision management in the left menu.

3. Select Create new revision.

4. Select the container where you want to mount the volume.

5. In the Edit a container context pane, select the Volume mounts tab.

6. Under the Ephemeral storage section, create a new volume with the following information.

   • Volume name: A name for the ephemeral volume.
   • Mount path: The absolute path in the container to mount the volume.

7. Select Save to save changes and exit the context pane.

8. Select Create to create the new revision.

When configuring a container app to mount an Azure Files volume using the Azure CLI, you must use a YAML definition to create or update your container app.

For a step-by-step tutorial on mounting an SMB file share, refer to Create an Azure Files storage mount in Azure Container Apps.

1. Add a storage definition to your Container Apps environment.

   • SMB
   • NFS

   az containerapp env storage set --name my-env --resource-group my-group \
       --storage-name mystorage \
       --storage-type AzureFile \
       --azure-file-account-name <STORAGE_ACCOUNT_NAME> \
       --azure-file-account-key <STORAGE_ACCOUNT_KEY> \
       --azure-file-share-name <STORAGE_SHARE_NAME> \
       --access-mode ReadWrite
   

   Replace <STORAGE_ACCOUNT_NAME> and <STORAGE_ACCOUNT_KEY> with the name and key of your storage account. Replace <STORAGE_SHARE_NAME> with the name of the file share in the storage account.

   Valid values for --access-mode are ReadWrite and ReadOnly.

2. To update an existing container app to mount a file share, export your app's specification to a YAML file named app.yaml.

   az containerapp show -n <APP_NAME> -g <RESOURCE_GROUP_NAME> -o yaml > app.yaml
   

3. Make the following changes to your container app specification.

   • Add a volumes array to the template section of your container app definition and define a volume. If you already have a volumes array, add a new volume to the array.
     • The name is an identifier for the volume.
     • For storageType, use AzureFile for SMB, or NfsAzureFile for NFS. This value must match the storage type you defined in the environment.
     • For storageName, use the name of the storage you defined in the environment.
   • For each container in the template that you want to mount Azure Files storage, define a volume mount in the volumeMounts array of the container definition.
     • The volumeName is the name defined in the volumes array.
     • The mountPath is the path in the container to mount the volume.
   • SMB
   • NFS

   properties:
     managedEnvironmentId: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP_NAME>/providers/Microsoft.App/managedEnvironments/<ENVIRONMENT_NAME>
     configuration:
     template:
       containers:
       - image: <IMAGE_NAME>
         name: my-container
         volumeMounts:
         - volumeName: azure-files-volume
           mountPath: /my-files
       volumes:
       - name: azure-files-volume
         storageType: AzureFile
         storageName: mystorage
   

4. Update your container app using the YAML file.

   az containerapp update --name <APP_NAME> --resource-group <RESOURCE_GROUP_NAME> \
       --yaml app.yaml
   

See the YAML specification for a full example.

The following ARM template snippets demonstrate how to add an Azure Files share to a Container Apps environment and use it in a container app.

1. Add a storages child resource to the Container Apps environment.

   • SMB
   • NFS

   {
     "type": "Microsoft.App/managedEnvironments",
     "apiVersion": "2022-03-01",
     "name": "[parameters('environment_name')]",
     "location": "[parameters('location')]",
     "properties": {
       "daprAIInstrumentationKey": "[parameters('dapr_ai_instrumentation_key')]",
       "appLogsConfiguration": {
         "destination": "log-analytics",
         "logAnalyticsConfiguration": {
           "customerId": "[parameters('log_analytics_customer_id')]",
           "sharedKey": "[parameters('log_analytics_shared_key')]"
         }
       }
     },
     "resources": [
       {
         "type": "storages",
         "name": "myazurefiles",
         "apiVersion": "2022-03-01",
         "dependsOn": [
           "[resourceId('Microsoft.App/managedEnvironments', parameters('environment_name'))]"
         ],
         "properties": {
           "azureFile": {
             "accountName": "[parameters('storage_account_name')]",
             "accountKey": "[parameters('storage_account_key')]",
             "shareName": "[parameters('storage_share_name')]",
             "accessMode": "ReadWrite"
           }
         }
       }
     ]
   }
   

2. Update the container app resource to add a volume and volume mount.

   • SMB
   • NFS

   {
     "apiVersion": "2023-05-01",
     "type": "Microsoft.App/containerApps",
     "name": "[parameters('containerappName')]",
     "location": "[parameters('location')]",
     "properties": {
   
       ...
   
       "template": {
         "revisionSuffix": "myrevision",
         "containers": [
           {
             "name": "main",
             "image": "[parameters('container_image')]",
             "resources": {
               "cpu": 0.5,
               "memory": "1Gi"
             },
             "volumeMounts": [
               {
                 "mountPath": "/myfiles",
                 "volumeName": "azure-files-volume"
               }
             ]
           }
         ],
         "scale": {
           "minReplicas": 1,
           "maxReplicas": 3
         },
         "volumes": [
           {
             "name": "azure-files-volume",
             "storageType": "AzureFile",
             "storageName": "myazurefiles"
           }
         ]
       }
     }
   }
   

   • Add a volumes array to the template section of your container app definition and define a volume. If you already have a volumes array, add a new volume to the array.
     • The name is an identifier for the volume.
     • For storageType, use AzureFile for SMB, or NfsAzureFile for NFS. This value must match the storage type you defined in the environment.
     • For storageName, use the name of the storage you defined in the environment.
   • For each container in the template that you want to mount Azure Files storage, define a volume mount in the volumeMounts array of the container definition.
     • The volumeName is the name defined in the volumes array.
     • The mountPath is the path in the container to mount the volume.

See the ARM template API specification for a full example.