> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/azure-files.md).

# Azure Files

Azure Files offers fully managed file shares in the cloud that are accessible via SMB and REST APIs. Browse, read, and write files in Azure File Shares.

* Knowledge base source

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector                       | Authentication |
| ------------------------------- | -------------- |
| Azure Files                     | Credentials    |
| Azure Files (Service Principal) | Credentials    |

#### Azure Files

Connect to Azure File Shares to browse, read, and write files. Uses connection string authentication from your Azure Storage account.

**Set up in Azure Files**

1. Sign in to the Azure portal and open the Storage account that holds your file shares.
2. In the left menu under Security + networking, select Access keys.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Azure Files**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                                                                                                                   |
| ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Connection String | Yes      | Azure Storage connection string from Azure Portal. Go to Storage Account → Access Keys → Connection string. [Provider instructions](https://portal.azure.com/). |

**Provider documentation:** [Setup reference](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage).

#### Azure Files (Service Principal)

Connect to Azure File Shares using a Service Principal (OAuth). This method uses Azure AD authentication instead of storage account keys. Requires 'Storage File Data Privileged Reader' or 'Storage File Data Privileged Contributor' role.

**Set up in Azure Files**

1. In the Azure portal, register an application in Microsoft Entra ID (App registrations → New registration) to create a service principal, and note its Application (client) ID and Directory (tenant) ID.
2. Under the app's Certificates & secrets, create a new client secret and copy its value immediately.
3. On the target Storage account, open Access Control (IAM) and assign the service principal the 'Storage File Data Privileged Reader' role (or 'Storage File Data Privileged Contributor' if the workflow needs to write).

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Azure Files (Service Principal)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field        | Required                 | What to enter                                                                                                                                                                                                                                      |
| -------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tenant ID            | Yes                      | Azure AD tenant ID where the app registration is located. [Provider instructions](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Overview).                                                                            |
| Client ID            | Yes                      | Application (client) ID from the Azure AD app registration. [Provider instructions](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps).                                                                    |
| Client Secret        | Yes                      | Client secret value from the Azure AD app registration. [Provider instructions](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps).                                                                        |
| Storage Account Name | Yes                      | The exact name of your Azure Storage Account. [Provider instructions](https://portal.azure.com/#browse/Microsoft.Storage%2FstorageAccounts).                                                                                                       |
| Share Name           | Optional / as applicable | The specific file share to access. Required if the Service Principal has permissions scoped to a specific share rather than the entire storage account. If not provided, the Service Principal must have account-level permissions to list shares. |

**Provider documentation:** [Setup reference](https://learn.microsoft.com/en-us/azure/storage/files/storage-files-identity-auth-active-directory-enable).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Azure Files** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List File Shares

List all file shares in the Azure Storage account.

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field       | Type          | Description                                 |
| ----------- | ------------- | ------------------------------------------- |
| File Shares | object\_array | List of file shares in the storage account. |
| Total Count | number        | Total number of file shares found.          |

#### List Directory

List files and subdirectories in an Azure file share directory.

**Inputs**

| Field          | Type   | Required | Description                                          |
| -------------- | ------ | -------- | ---------------------------------------------------- |
| Share Name     | string | Yes      | Name of the file share to browse.                    |
| Directory Path | string | No       | Path to the directory to list. Leave empty for root. |

**Outputs**

| Field             | Type          | Description               |
| ----------------- | ------------- | ------------------------- |
| Directories       | object\_array | List of subdirectories.   |
| Files             | object\_array | List of files.            |
| Total Directories | number        | Number of subdirectories. |
| Total Files       | number        | Number of files.          |

#### Get File

Download a file from an Azure file share.

**Inputs**

| Field      | Type   | Required | Description                                 |
| ---------- | ------ | -------- | ------------------------------------------- |
| Share Name | string | Yes      | Name of the file share containing the file. |
| File Path  | string | Yes      | Full path to the file within the share.     |

**Outputs**

| Field     | Type   | Description                                             |
| --------- | ------ | ------------------------------------------------------- |
| File URL  | string | Temporary URL to download the file (expires in 1 hour). |
| File Name | string | Name of the downloaded file.                            |

#### Upload File from URL

Download a file from a URL and upload it to an Azure file share.

**Inputs**

| Field      | Type   | Required | Description                              |
| ---------- | ------ | -------- | ---------------------------------------- |
| Share Name | string | Yes      | Name of the file share to upload to.     |
| File Path  | string | Yes      | Full path for the file within the share. |
| Source URL | string | Yes      | URL of the file to download and upload.  |

**Outputs**

| Field        | Type   | Description                                |
| ------------ | ------ | ------------------------------------------ |
| File Path    | string | Full path to the uploaded file.            |
| Size (Bytes) | number | Size of the uploaded file in bytes.        |
| Content Type | string | MIME type of the uploaded file.            |
| Source URL   | string | Original URL the file was downloaded from. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/azure-files.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
