Skip to content

Commit 82e016b

Browse files
Merge pull request #274937 from khdownie/kendownie050924-2
SEO pass on auth articles
2 parents 06ea648 + d8ee4f6 commit 82e016b

6 files changed

+38
-37
lines changed

articles/storage/files/storage-files-identity-ad-ds-assign-permissions.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,40 @@
11
---
2-
title: Control access to Azure file shares by assigning share-level permissions
3-
description: Learn how to assign share-level permissions to a Microsoft Entra identity that represents a hybrid user to control user access to Azure file shares with identity-based authentication.
2+
title: Assign share-level permissions for Azure Files
3+
description: Learn how to control access to Azure Files by assigning share-level permissions to a Microsoft Entra identity that represents a hybrid user to control user access to Azure file shares with identity-based authentication.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 12/07/2022
7+
ms.date: 05/09/2024
88
ms.author: kendownie
99
ms.custom: devx-track-azurepowershell, subject-rbac-steps, devx-track-azurecli, engagement-fy23
1010
ms.devlang: azurecli
1111
recommendations: false
1212
---
1313

14-
# Assign share-level permissions
14+
# Assign share-level permissions for Azure file shares
1515

1616
Once you've enabled an Active Directory (AD) source for your storage account, you must configure share-level permissions in order to get access to your file share. There are two ways you can assign share-level permissions. You can assign them to [specific Microsoft Entra users/groups](#share-level-permissions-for-specific-azure-ad-users-or-groups), and you can assign them to all authenticated identities as a [default share-level permission](#share-level-permissions-for-all-authenticated-identities).
1717

1818
> [!IMPORTANT]
1919
> Full administrative control of a file share, including the ability to take ownership of a file, requires using the storage account key. Full administrative control isn't supported with identity-based authentication.
2020
2121
## Applies to
22+
2223
| File share type | SMB | NFS |
2324
|-|:-:|:-:|
2425
| Standard file shares (GPv2), LRS/ZRS | ![Yes](../media/icons/yes-icon.png) | ![No](../media/icons/no-icon.png) |
2526
| Standard file shares (GPv2), GRS/GZRS | ![Yes](../media/icons/yes-icon.png) | ![No](../media/icons/no-icon.png) |
2627
| Premium file shares (FileStorage), LRS/ZRS | ![Yes](../media/icons/yes-icon.png) | ![No](../media/icons/no-icon.png) |
2728

28-
## Which configuration should you use
29+
## Choose how to assign share-level permissions
2930

3031
Share-level permissions on Azure file shares are configured for Microsoft Entra users, groups, or service principals, while directory and file-level permissions are enforced using Windows access control lists (ACLs). You must assign share-level permissions to the Microsoft Entra identity representing the same user, group, or service principal in your AD DS in order to support AD DS authentication to your Azure file share. Authentication and authorization against identities that only exist in Microsoft Entra ID, such as Azure Managed Identities (MSIs), aren't supported.
3132

3233
Most users should assign share-level permissions to specific Microsoft Entra users or groups, and then use Windows ACLs for granular access control at the directory and file level. This is the most stringent and secure configuration.
3334

3435
There are three scenarios where we instead recommend using a [default share-level permission](#share-level-permissions-for-all-authenticated-identities) to allow contributor, elevated contributor, or reader access to all authenticated identities:
3536

36-
- If you are unable to sync your on-premises AD DS to Microsoft Entra ID, you can use a default share-level permission. Assigning a default share-level permission allows you to work around the sync requirement because you don't need to specify the permission to identities in Microsoft Entra ID. Then you can use Windows ACLs for granular permission enforcement on your files and directories.
37+
- If you're unable to sync your on-premises AD DS to Microsoft Entra ID, you can use a default share-level permission. Assigning a default share-level permission allows you to work around the sync requirement because you don't need to specify the permission to identities in Microsoft Entra ID. Then you can use Windows ACLs for granular permission enforcement on your files and directories.
3738
- Identities that are tied to an AD but aren't synching to Microsoft Entra ID can also leverage the default share-level permission. This could include standalone Managed Service Accounts (sMSA), group Managed Service Accounts (gMSA), and computer accounts.
3839
- The on-premises AD DS you're using is synched to a different Microsoft Entra ID than the Microsoft Entra ID the file share is deployed in.
3940
- This is typical when you're managing multi-tenant environments. Using a default share-level permission allows you to bypass the requirement for a Microsoft Entra ID [hybrid identity](../../active-directory/hybrid/whatis-hybrid-identity.md). You can still use Windows ACLs on your files and directories for granular permission enforcement.
@@ -42,7 +43,7 @@ There are three scenarios where we instead recommend using a [default share-leve
4243
> [!NOTE]
4344
> Because computer accounts don't have an identity in Microsoft Entra ID, you can't configure Azure role-based access control (RBAC) for them. However, computer accounts can access a file share by using a [default share-level permission](#share-level-permissions-for-all-authenticated-identities).
4445
45-
## Share-level permissions
46+
## Share-level permissions and Azure RBAC roles
4647

4748
The following table lists the share-level permissions and how they align with the built-in Azure RBAC roles:
4849

@@ -81,7 +82,7 @@ To assign an Azure role to a Microsoft Entra identity, using the [Azure portal](
8182
1. In the Azure portal, go to your file share, or [create a file share](storage-how-to-create-file-share.md).
8283
1. Select **Access Control (IAM)**.
8384
1. Select **Add a role assignment**
84-
1. In the **Add role assignment** blade, select the [appropriate built-in role](#share-level-permissions) from the **Role** list.
85+
1. In the **Add role assignment** blade, select the [appropriate built-in role](#share-level-permissions-and-azure-rbac-roles) from the **Role** list.
8586
1. Storage File Data SMB Share Reader
8687
1. Storage File Data SMB Share Contributor
8788
1. Storage File Data SMB Share Elevated Contributor
@@ -117,7 +118,7 @@ az role assignment create --role "<role-name>" --assignee <user-principal-name>
117118

118119
## Share-level permissions for all authenticated identities
119120

120-
You can add a default share-level permission on your storage account, instead of configuring share-level permissions for Microsoft Entra users or groups. A default share-level permission assigned to your storage account applies to all file shares contained in the storage account.
121+
You can add a default share-level permission on your storage account, instead of configuring share-level permissions for Microsoft Entra users or groups. A default share-level permission assigned to your storage account applies to all file shares contained in the storage account.
121122

122123
When you set a default share-level permission, all authenticated users and groups will have the same permission. Authenticated users or groups are identified as the identity can be authenticated against the on-premises AD DS the storage account is associated with. The default share-level permission is set to **None** at initialization, implying that no access is allowed to files or directories in the Azure file share.
123124

@@ -131,7 +132,7 @@ To configure default share-level permissions on your storage account using the [
131132

132133
:::image type="content" source="media/storage-files-identity-ad-ds-assign-permissions/set-default-share-level-permission.png" alt-text="Screenshot showing how to set a default share-level permission using the Azure portal." lightbox="media/storage-files-identity-ad-ds-assign-permissions/set-default-share-level-permission.png" border="true":::
133134

134-
1. Select the appropriate role to be enabled as the default [share permission](#share-level-permissions) from the dropdown list.
135+
1. Select the appropriate role to be enabled as the default [share permission](#share-level-permissions-and-azure-rbac-roles) from the dropdown list.
135136
1. Select **Save**.
136137

137138
# [Azure PowerShell](#tab/azure-powershell)
@@ -168,6 +169,6 @@ az storage account update --name $storageAccountName --resource-group $resourceG
168169

169170
You could also assign permissions to all authenticated Microsoft Entra users and specific Microsoft Entra users/groups. With this configuration, a specific user or group will have whichever is the higher-level permission from the default share-level permission and RBAC assignment. In other words, say you granted a user the **Storage File Data SMB Reader** role on the target file share. You also granted the default share-level permission **Storage File Data SMB Share Elevated Contributor** to all authenticated users. With this configuration, that particular user will have **Storage File Data SMB Share Elevated Contributor** level of access to the file share. Higher-level permissions always take precedence.
170171

171-
## Next steps
172+
## Next step
172173

173-
Now that you've assigned share-level permissions, you can [configure directory and file-level permissions](storage-files-identity-ad-ds-configure-permissions.md). Remember that share-level permissions can take up to three hours to take effect.
174+
Now that you've assigned share-level permissions, you can [configure directory and file-level permissions](storage-files-identity-ad-ds-configure-permissions.md). Remember that share-level permissions can take up to three hours to take effect.

articles/storage/files/storage-files-identity-ad-ds-configure-permissions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Control what a user can do at the directory and file level - Azure Files
3-
description: Learn how to configure Windows ACLs for directory and file level permissions for Active Directory authentication to Azure file shares, allowing you to take advantage of granular access control.
2+
title: Configure directory and file level permissions for Azure Files
3+
description: Learn how to configure Windows ACLs for directory and file level permissions for Active Directory (AD) authentication to Azure file shares over SMB for granular access control.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 05/03/2024
7+
ms.date: 05/09/2024
88
ms.author: kendownie
99
ms.custom: engagement-fy23
1010
recommendations: false
1111
---
1212

13-
# Configure directory and file-level permissions over SMB
13+
# Configure directory and file-level permissions for Azure file shares
1414

1515
Before you begin this article, make sure you've read [Assign share-level permissions to an identity](storage-files-identity-ad-ds-assign-permissions.md) to ensure that your share-level permissions are in place with Azure role-based access control (RBAC).
1616

articles/storage/files/storage-files-identity-ad-ds-enable.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Enable AD DS authentication for Azure file shares
3-
description: Learn how to enable Active Directory Domain Services authentication over SMB for Azure file shares. Your domain-joined Windows virtual machines can then access Azure file shares by using AD DS credentials.
2+
title: Enable AD DS authentication for Azure Files
3+
description: Learn how to enable Active Directory Domain Services authentication over SMB for Azure file shares. Your domain-joined Windows virtual machines can then access Azure file shares by using AD DS credentials.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 01/12/2024
7+
ms.date: 05/09/2024
88
ms.author: kendownie
99
ms.custom: engagement-fy23, devx-track-azurepowershell
1010
recommendations: false
1111
---
1212

13-
# Enable AD DS authentication for Azure file shares
13+
# Enable Active Directory Domain Services authentication for Azure file shares
1414

1515
This article describes the process for enabling Active Directory Domain Services (AD DS) authentication on your storage account in order to use on-premises Active Directory (AD) credentials for authenticating to Azure file shares.
1616

@@ -269,6 +269,6 @@ DomainSid:<yourSIDHere>
269269
AzureStorageID:<yourStorageSIDHere>
270270
```
271271

272-
## Next steps
272+
## Next step
273273

274274
You've now successfully enabled AD DS on your storage account. To use the feature, you must [assign share-level permissions](storage-files-identity-ad-ds-assign-permissions.md).

articles/storage/files/storage-files-identity-ad-ds-mount-file-share.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Mount SMB Azure file share using AD DS credentials
3-
description: Learn how to mount an SMB Azure file share using your on-premises Active Directory Domain Services credentials.
3+
description: Learn how to mount an SMB Azure file share using your on-premises Active Directory Domain Services (AD DS) credentials.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 12/21/2023
7+
ms.date: 05/09/2024
88
ms.author: kendownie
99
ms.custom: engagement-fy23
1010
recommendations: false
@@ -106,6 +106,6 @@ To use this method, complete the following steps:
106106

107107
You should now be able to mount the file share using *storageaccount.domainname.com*. You can also mount the file share using the storage account key.
108108

109-
## Next steps
109+
## Next step
110110

111111
If the identity you created in AD DS to represent the storage account is in a domain or OU that enforces password rotation, you might need to [update the password of your storage account identity in AD DS](storage-files-identity-ad-ds-update-password.md).

articles/storage/files/storage-files-identity-ad-ds-update-password.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Update AD DS storage account password
3-
description: Learn how to update the password of the Active Directory Domain Services computer or service account that represents your storage account. This prevents authentication failures and keeps the storage account from being deleted when the password expires.
2+
title: Update password for an AD DS storage account identity
3+
description: Learn how to update the password of the Active Directory Domain Services (AD DS) identity that represents your storage account. This prevents authentication failures and keeps the storage account from being deleted when the password expires.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 11/17/2022
7+
ms.date: 05/09/2024
88
ms.author: kendownie
99
recommendations: false
1010
---
@@ -16,20 +16,21 @@ If you registered the Active Directory Domain Services (AD DS) identity/account
1616
To prevent unintended password rotation, during the onboarding of the Azure storage account in the domain, make sure to place the Azure storage account into a separate organizational unit in AD DS. Disable Group Policy inheritance on this organizational unit to prevent default domain policies or specific password policies from being applied.
1717

1818
> [!NOTE]
19-
> A storage account identity in AD DS can be either a service account or a computer account. Service account passwords can expire in AD; however, because computer account password changes are driven by the client machine and not AD, they don't expire in AD.
19+
> A storage account identity in AD DS can be either a service account or a computer account. Service account passwords can expire in Active Directory (AD); however, because computer account password changes are driven by the client machine and not AD, they don't expire in AD.
2020
2121
There are two options for triggering password rotation. You can use the `AzFilesHybrid` module or Active Directory PowerShell. Use one method, not both.
2222

2323
## Applies to
24+
2425
| File share type | SMB | NFS |
2526
|-|:-:|:-:|
2627
| Standard file shares (GPv2), LRS/ZRS | ![Yes](../media/icons/yes-icon.png) | ![No](../media/icons/no-icon.png) |
2728
| Standard file shares (GPv2), GRS/GZRS | ![Yes](../media/icons/yes-icon.png) | ![No](../media/icons/no-icon.png) |
2829
| Premium file shares (FileStorage), LRS/ZRS | ![Yes](../media/icons/yes-icon.png) | ![No](../media/icons/no-icon.png) |
2930

30-
## Use AzFilesHybrid module
31+
## Option 1: Use AzFilesHybrid module
3132

32-
You can run the `Update-AzStorageAccountADObjectPassword` cmdlet from the [AzFilesHybrid module](https://github.com/Azure-Samples/azure-files-samples/releases). This command must be run in an on-premises AD DS-joined environment by a [hybrid identity](../../active-directory/hybrid/whatis-hybrid-identity.md) with owner permission to the storage account and AD DS permissions to change the password of the identity representing the storage account. The command performs actions similar to storage account key rotation. Specifically, it gets the second Kerberos key of the storage account and uses it to update the password of the registered account in AD DS. Then it regenerates the target Kerberos key of the storage account and updates the password of the registered account in AD DS.
33+
You can run the `Update-AzStorageAccountADObjectPassword` cmdlet from the [AzFilesHybrid module](https://github.com/Azure-Samples/azure-files-samples/releases). You must run this command in an on-premises AD DS-joined environment by a [hybrid identity](../../active-directory/hybrid/whatis-hybrid-identity.md) with owner permission to the storage account and AD DS permissions to change the password of the identity representing the storage account. The command performs actions similar to storage account key rotation. Specifically, it gets the second Kerberos key of the storage account and uses it to update the password of the registered account in AD DS. Then it regenerates the target Kerberos key of the storage account and updates the password of the registered account in AD DS.
3334

3435
```PowerShell
3536
# Update the password of the AD DS account registered for the storage account
@@ -42,7 +43,7 @@ Update-AzStorageAccountADObjectPassword `
4243

4344
This action will change the password for the AD object from kerb1 to kerb2. This is intended to be a two-stage process: rotate from kerb1 to kerb2 (kerb2 will be regenerated on the storage account before being set), wait several hours, and then rotate back to kerb1 (this cmdlet will likewise regenerate kerb1).
4445

45-
## Use Active Directory PowerShell
46+
## Option 2: Use Active Directory PowerShell
4647

4748
If you don't want to download the `AzFilesHybrid` module, you can use [Active Directory PowerShell](/powershell/module/activedirectory).
4849

@@ -59,4 +60,3 @@ $NewPassword = ConvertTo-SecureString -String $KerbKey -AsPlainText -Force
5960
6061
Set-ADAccountPassword -Identity <domain-object-identity> -Reset -NewPassword $NewPassword
6162
```
62-

articles/storage/files/storage-files-identity-auth-active-directory-enable.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Overview - On-premises AD DS authentication to Azure file shares
3-
description: Learn about Active Directory Domain Services (AD DS) authentication to Azure file shares. This article goes over supported scenarios, availability, and explains how the permissions work between your AD DS and Microsoft Entra ID.
2+
title: Overview of on-premises AD DS authentication for Azure Files
3+
description: Learn about Active Directory Domain Services (AD DS) authentication to Azure file shares over SMB, including supported scenarios and how permissions work between AD DS and Microsoft Entra ID.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: how-to
7-
ms.date: 03/04/2024
7+
ms.date: 05/09/2024
88
ms.author: kendownie
99
recommendations: false
1010
---
1111

12-
# Overview - on-premises Active Directory Domain Services authentication over SMB for Azure file shares
12+
# Overview: On-premises Active Directory Domain Services authentication over SMB for Azure file shares
1313

1414
[!INCLUDE [storage-files-aad-auth-include](../../../includes/storage-files-aad-auth-include.md)]
1515

@@ -95,6 +95,6 @@ The following diagram illustrates the end-to-end workflow for enabling AD DS aut
9595

9696
Identities used to access Azure file shares must be synced to Microsoft Entra ID to enforce share-level file permissions through the [Azure role-based access control (Azure RBAC)](../../role-based-access-control/overview.md) model. Alternatively, you can use a default share-level permission. [Windows-style DACLs](/previous-versions/technet-magazine/cc161041(v=msdn.10)) on files/directories carried over from existing file servers will be preserved and enforced. This offers seamless integration with your enterprise AD DS environment. As you replace on-premises file servers with Azure file shares, existing users can access Azure file shares from their current clients with a single sign-on experience, without any change to the credentials in use.
9797

98-
## Next steps
98+
## Next step
9999

100100
To get started, you must [enable AD DS authentication for your storage account](storage-files-identity-ad-ds-enable.md).

0 commit comments

Comments
 (0)