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 OneDrive #36768

Open
wants to merge 15 commits into
base: next
Choose a base branch
from
38 changes: 38 additions & 0 deletions source/_integrations/onedrive.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: OneDrive
description: Instructions on how to setup OneDrive to be used with backups.
ha_release: 2025.2
ha_category:
- Backup
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_domain: onedrive
ha_codeowners:
- '@zweckj'
ha_integration_type: service
c0ffeeca7 marked this conversation as resolved.
Show resolved Hide resolved
---

This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for use with Home Assistant Backups.
c0ffeeca7 marked this conversation as resolved.
Show resolved Hide resolved
Backups will be created in the `App Folder` of your OneDrive, the integration does have no access to any other parts of your OneDrive except its own folder.
zweckj marked this conversation as resolved.
Show resolved Hide resolved

{% include integrations/config_flow.md %}

## Getting application credentials

{% note %}
You will need an Azure tenant with an active Azure subscription to create your own client credentials.
{% endnote %}

This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home assistant account linking.
Everything is done in the user context, so nobody will every have access to your data except you. However, because you want to your own credentials this is possible,
follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix multiple text issues

There are several issues in this section that need to be addressed:

  1. Incorrect capitalization of "Home assistant"
  2. Typo: "every" should be "ever"
  3. Incomplete/unclear sentence about custom credentials
-This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home assistant account linking. 
-Everything is done in the user context, so nobody will every have access to your data except you. However, because you want to your own credentials this is possible, 
-follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret 
+This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home Assistant account linking. 
+Everything is done in the user context, so nobody will ever have access to your data except you. However, if you want to use your own credentials, 
+follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home assistant account linking.
Everything is done in the user context, so nobody will every have access to your data except you. However, because you want to your own credentials this is possible,
follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret
This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home Assistant account linking.
Everything is done in the user context, so nobody will ever have access to your data except you. However, if you want to use your own credentials,
follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret.
🧰 Tools
🪛 LanguageTool

[misspelling] ~27-~27: Did you mean “ever”?
Context: ...one in the user context, so nobody will every have access to your data except you. Ho...

(EVERY_EVER)

🪛 Markdownlint (0.37.0)

26-26: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


27-27: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


28-28: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

🪛 GitHub Actions: home-assistant.io Test

[error] 26-26: Incorrect usage of the term: "Home assistant", use "Home Assistant" instead


## Known Limitations
c0ffeeca7 marked this conversation as resolved.
Show resolved Hide resolved

- Only personal OneDrives are supported a the moment
zweckj marked this conversation as resolved.
Show resolved Hide resolved

## Removing the integration

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

{% include integrations/remove_device_service.md %}
Loading