Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for azure_storage #36572

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions source/_integrations/azure_storage.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Azure Storage
description: Instructions on how to setup Azure storage accounts to be used with backups.
ha_release: 2025.2
ha_category:
- Backup
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_domain: azure_storage
ha_codeowners:
- '@zweckj'
ha_integration_type: service
---

This integration allows you to use [Azure storage accounts](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview) for use with Home Assistant Backups.

{% include integrations/config_flow.md %}

{% configuration_basic %}
Storage account name:
description: "The name of the storage account. Only the name, nothing else."
Container name:
description: "Blob container name to store the backups. If the container does not exist, it will be created. Defaults to `hass-backups`."
Storage account key:
description: "One of the two storage account keys. Used to authenticate against the storage account"
{% endconfiguration_basic %}
Comment on lines +19 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add more configuration details

Please enhance the configuration section with:

  1. Format requirements for the storage account name (allowed characters, length)
  2. Security best practices for handling the storage account key
  3. Container name restrictions and naming rules
  4. Optional configuration parameters if any



## Known Limitations

- Only storage accounts that have a default URL `storageaccountname.blob.core.windows.net` are supported at this point
- Since only key based authentication is possible, this has to be enabled in your storage account.

## Removing the integration

This integration follows standard integration removal. No extra steps are required.

{% include integrations/remove_device_service.md %}

## Troubleshooting

{% details "Authentication failure" %}

Check that your storage account allows [`Shared Key` access](https://learn.microsoft.com/en-us/azure/storage/common/shared-key-authorization-prevent?tabs=portal#remediate-authorization-via-shared-key).

{% enddetails %}
Loading