-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
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
zweckj
wants to merge
2
commits into
home-assistant:next
Choose a base branch
from
zweckj:azure_storage/init
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %} | ||
|
||
|
||
## 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 %} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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: