> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/resources/depot/supported-sources/abfss.md).

# Azure Blob File System Secure (ABFSS)

To create an ABFSS Depot, you must have the following details:

## Pre-requisites specific to DataOS

You must have the Data Admin role to create a Depot. To get the Data Admin role, contact the DataOS Operator or the Tenant Admin.

Run the command below to check your assigned roles.

```bash
dataos-ctl user get
#Expected Output: 
time="2026-03-30T17:49:18+05:30" level=info msg="😃 user get..."
time="2026-03-30T17:49:19+05:30" level=info msg="😃 user get...complete"

     NAME     │        ID         │  TYPE  │        EMAIL         │                  TAGS
──────────────┼───────────────────┼────────┼──────────────────────┼────────────────────────────────────────
 I Am Groot   │ iamgroottmdcio    │ person │ iam.groot@tmdc.io    │ roles:id:ct-onboarding-data-developer,
              │                   │        │                      │ roles:id:data-dev,
              │                   │        │                      │ roles:id:system-dev,
              │                   │        │                      │ roles:id:user,
              │                   │        │                      │ users:id:iamgroottmdcio

```

## Pre-requisites specific to the source system

* **Storage Account Name**: The name of the Azure storage account used to store your data. This can be obtained from the Azure portal under your storage account settings or from the administrator managing your Azure resources.
* **Storage Account Key**: The key used to authenticate and access the Azure storage account. It is generated when the storage account is created and can be retrieved from the Azure portal under the "Access keys" section of your storage account.
* **Container**: The name of the container within the Azure storage account that holds your data. You can find this information in the Azure portal under the "Containers" section of your storage account, or it can be provided by your Azure administrator.
* **Relative Path (`relativePath`)**: The relative path to the specific data within the container. This path is relative to the root of the container and can be provided by the person managing the data stored in the container or found by navigating through the container in Azure Blob Storage.
* **Data format (`format`)**: `format` specifies the type of table format used to store the data in the container. Common values are `iceberg` or `delta`, depending on how the data is organized.

## Create an ABFSS Depot

Azure Blob File System Secure (ABFSS) is an object storage system: a distributed store for large volumes of unstructured data. A Depot of type `abfss` reads data from an Azure Blob Storage account. The Depot exposes the storage account, which can contain multiple containers (a container groups multiple blobs). Define a separate Depot for each container. To create a Depot of type `abfss`, follow these steps:

### **Step 1: Create a Secret for securing ABFSS credentials**

Begin by creating a Secret Resource by following the [Azure Blob File System Secure (ABFSS)](/concepts/resources/secret/data-sources/azure-blob-file-system-secure-abfss.md) guide.

### **Step 2: Create an ABFSS Depot manifest file**

Create a manifest file with the configuration details for your ABFSS Depot and a reference to the Secret.

{% tabs %}
{% tab title="Manifest file" %}

```yaml
name: ${{abfss-name}}
version: v2alpha
type: depot
tags:
  - ABFSS
  - depot
  - storage
description: "Azure Blob File System Storage depot"
spec:
  type: abfss
  spec:
    account: ${{abfss-account}}
    container: ${{abfss-container}}
    relativePath: ${{abfss-relative-path}}
    format: ${{abfss-format}}
    endpointSuffix: ${{abfss-endpoint-suffix}}
  secrets:
    - id: "${{tenant-id}}:${{abfss-secret-name}}"
      purpose: scan
    - id: "${{tenant-id}}:${{abfss-secret-name}}"
      purpose: rw
```

{% endtab %}

{% tab title="Example" %}

```yaml
name: ${{abfss-name}}
version: v2alpha
type: depot
tags:
  - ABFSS
  - depot
  - storage
description: "Azure Blob File System Storage depot"
spec:
  type: abfss
  spec:
    account: ${{abfss-account}}
    container: ${{abfss-container}}
    relativePath: ${{abfss-relative-path}}
    format: ${{abfss-format}}
    endpointSuffix: ${{abfss-endpoint-suffix}}
  secrets:
    - id: "${{tenant-id}}:${{abfss-secret-name}}"
      purpose: scan
    - id: "${{tenant-id}}:${{abfss-secret-name}}"
      purpose: rw
```

{% endtab %}
{% endtabs %}

### **Step 3: Apply the Depot manifest file**

Apply the manifest through the DataOS CLI:

```bash
dataos-ctl resource apply -f ${{manifest-file-path}}
```

## Verify the Depot creation

Verify the Depot in two ways:

* Check the name of the newly created Depot in the list of Depots you own:

  ```bash
  dataos-ctl resource get -t depot
  ```
* List all Depots created in the current Tenant:

  ```bash
  dataos-ctl resource get -t depot -a
  ```

## Delete a Depot

{% hint style="warning" %}
Best practice: Delete Resources that are no longer in use to save time and reduce costs.
{% endhint %}

To delete a Depot, run the following command in the DataOS CLI:

{% tabs %}
{% tab title="Command 1" %}

```bash
dataos-ctl resource delete -t depot -n ${{name}}
```

{% endtab %}

{% tab title="Command 2 " %}

```bash
dataos-ctl resource delete -i "${{resource-name}}|v2alpha|depot"
```

{% endtab %}

{% tab title="Command 3" %}

```bash
dataos-ctl resource delete -f ${{manifest-file-path}}
```

{% endtab %}
{% endtabs %}

Specify the Resource type and Depot name in the `delete` command.

**Example Usage:**

{% tabs %}
{% tab title="Command 1" %}

```bash
dataos-ctl resource delete -t depot -n testdepot
#output
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}

{% tab title="Command 2" %}

```bash
dataos-ctl resource delete -i "testdepot|v2alpha|depot"
#output
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}

{% tab title="Command 3" %}

```bash
dataos-ctl resource delete -f /path/to/depot.yaml
#output
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}
{% endtabs %}

## Limit the data source's file format

A Depot can also restrict the file types that can be read from and written to a data source. In the `abfss` section of the config file, set the `format` of the files you want to allow access to. For file-based systems, if you define the format as `iceberg`, you can choose the metastore catalog between Hadoop and Hive:

```yaml
spec:
  type: abfss
  description: "ABFSS Iceberg Depot for sanity"
  spec:
    account: 
    container: 
    relativePath:
    format: iceberg
    endpointSuffix:
    icebergCatalogType: Hive
```

If you do not set the catalog name to Hive, Hadoop is used as the default catalog for the Iceberg format. Hive keeps the pointer updated to the latest metadata version automatically. If you use Hadoop, you must run the set metadata command manually as described here: [Set Metadata](broken://pages/7mdiOZ53ZSi81YHHX3Hb).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/concepts/resources/depot/supported-sources/abfss.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
