|
1 | 1 | ---
|
2 |
| -title: Enable admin-level read and write access to Azure file shares using Azure Active Directory with Azure Files OAuth over REST (preview) |
| 2 | +title: Enable admin-level read and write access to Azure file shares using Azure Active Directory with Azure Files OAuth over REST |
3 | 3 | description: Authorize access to Azure file shares and directories via the OAuth authentication protocol over REST APIs using Azure Active Directory (Azure AD). Assign Azure roles for access rights. Access files with an Azure AD account.
|
4 | 4 | author: khdownie
|
5 | 5 | ms.service: azure-file-storage
|
6 | 6 | ms.topic: conceptual
|
7 |
| -ms.date: 05/11/2023 |
| 7 | +ms.date: 07/13/2023 |
8 | 8 | ms.author: kendownie
|
9 | 9 | ms.custom: devx-track-azurepowershell
|
10 | 10 | ---
|
11 | 11 |
|
12 |
| -# Access Azure file shares using Azure Active Directory with Azure Files OAuth over REST (preview) |
| 12 | +# Access Azure file shares using Azure Active Directory with Azure Files OAuth over REST |
13 | 13 |
|
14 |
| -Azure Files OAuth over REST (preview) enables admin-level read and write access to Azure file shares for users and applications via the [OAuth](https://oauth.net/) authentication protocol, using Azure Active Directory (Azure AD) for REST API based access. Users, groups, first-party services such as Azure portal, and third-party services and applications using REST interfaces can now use OAuth authentication and authorization with an Azure AD account to access data in Azure file shares. PowerShell cmdlets and Azure CLI commands that call REST APIs can also use OAuth to access Azure file shares. |
| 14 | +Azure Files OAuth over REST enables admin-level read and write access to Azure file shares for users and applications via the [OAuth](https://oauth.net/) authentication protocol, using Azure Active Directory (Azure AD) for REST API based access. Users, groups, first-party services such as Azure portal, and third-party services and applications using REST interfaces can now use OAuth authentication and authorization with an Azure AD account to access data in Azure file shares. PowerShell cmdlets and Azure CLI commands that call REST APIs can also use OAuth to access Azure file shares. |
15 | 15 |
|
16 | 16 | > [!IMPORTANT]
|
17 | 17 | > You must call the REST API using an explicit header to indicate your intent to use the additional privilege. This is also true for Azure PowerShell and Azure CLI access.
|
18 | 18 |
|
19 | 19 | ## Limitations
|
20 | 20 |
|
21 |
| -Azure Files OAuth over REST (preview) only supports the FileREST Data APIs that support operations on files and directories. OAuth isn't supported on FilesREST data plane APIs that manage FileService and FileShare resources. These management APIs are called using the Storage Account Key or SAS token, and are exposed through the data plane for legacy reasons. We recommend using the control plane APIs (the storage resource provider - Microsoft.Storage) that support OAuth for all management activities related to FileService and FileShare resources. |
| 21 | +Azure Files OAuth over REST only supports the FileREST Data APIs that support operations on files and directories. OAuth isn't supported on FilesREST data plane APIs that manage FileService and FileShare resources. These management APIs are called using the Storage Account Key or SAS token, and are exposed through the data plane for legacy reasons. We recommend using the control plane APIs (the storage resource provider - Microsoft.Storage) that support OAuth for all management activities related to FileService and FileShare resources. |
22 | 22 |
|
23 | 23 | Authorizing file data operations with Azure AD is supported only for REST API versions 2022-11-02 and later. See [Versioning for Azure Storage](/rest/api/storageservices/versioning-for-the-azure-storage-services).
|
24 | 24 |
|
@@ -52,7 +52,7 @@ To use the Azure Files OAuth over REST feature, there are additional permissions
|
52 | 52 |
|
53 | 53 | Users, groups, or service principals that call the REST API with OAuth must have either the `readFileBackupSemantics` or `writeFileBackupSemantics` action assigned to the role that allows data access. This is a requirement to use this feature. For details on the permissions required to call specific File service operations, see [Permissions for calling data operations](/rest/api/storageservices/authorize-with-azure-active-directory#permissions-for-calling-data-operations).
|
54 | 54 |
|
55 |
| -This preview provides two new built-in roles that include these new actions. |
| 55 | +This feature provides two new built-in roles that include these new actions. |
56 | 56 |
|
57 | 57 | | **Role** | **Data actions** |
|
58 | 58 | |----------|------------------|
|
|
0 commit comments