Skip to content

Commit cbfc622

Browse files
Merge pull request #299178 from khdownie/patch-4
Update file-sync-managed-identities.md
2 parents 611e527 + 73ef018 commit cbfc622

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

articles/storage/file-sync/file-sync-managed-identities.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: How to use managed identities with Azure File Sync
3-
description: Learn how to configure Azure File Sync to use managed identities.
3+
description: Learn how to configure Azure File Sync to use system-assigned managed identities provided by Microsoft Entra ID.
44
author: khdownie
55
ms.service: azure-file-storage
66
ms.topic: conceptual
7-
ms.date: 03/31/2025
7+
ms.date: 05/01/2025
88
ms.author: kendownie
99
---
1010

@@ -19,18 +19,18 @@ When you enable this configuration, the system-assigned managed identities will
1919

2020
To learn more about the benefits of using managed identities, see [Managed identities for Azure resources](/entra/identity/managed-identities-azure-resources/overview).
2121

22-
To configure your Azure File Sync deployment to utilize system-assigned managed identities follow the guidance in the subsequent sections.
22+
To configure your Azure File Sync deployment to utilize system-assigned managed identities, follow the guidance in the subsequent sections.
2323

2424
## Prerequisites
2525
# [Portal](#tab/azure-portal)
2626
- **Azure File Sync agent version 20.0.0.0 or later** must be installed on the registered server.
2727

28-
- On your **storage accounts** used by Azure File Sync, you must be a **member of the Owner management role** or have Microsoft.Authorization/roleassignments/write permissions.
28+
- On your **storage accounts** used by Azure File Sync, you must be a **member of the Owner management role** or have `Microsoft.Authorization/roleassignments/write` permissions.
2929

3030
# [PowerShell](#tab/azure-powershell)
3131
- **Azure File Sync agent version 20.0.0.0 or later** must be installed on the registered server.
3232

33-
- On your **storage accounts** used by Azure File Sync, you must be a **member of the Owner management role** or have Microsoft.Authorization/roleassignments/write permissions.
33+
- On your **storage accounts** used by Azure File Sync, you must be a **member of the Owner management role** or have `Microsoft.Authorization/roleassignments/write` permissions.
3434

3535

3636

@@ -48,19 +48,20 @@ Azure File Sync support for system-assigned managed identities is available in
4848
Before you can configure Azure File Sync to use managed identities, your registered servers must have a system-assigned managed identity that will be used to authenticate to the Azure File Sync service and Azure file shares.
4949

5050
To enable a system-assigned managed identity on a registered server that has the Azure File Sync v20 agent installed, perform the following steps:
51-
- If the server is hosted outside of Azure, it must be an **Azure Arc-enabled server** to have a system-assigned managed identity. For more information on Azure Arc-enabled servers and how to install the Azure Connected Machine agent, see: [Azure Arc-enabled servers Overview](/entra/identity/managed-identities-azure-resources/overview).
51+
52+
- If the server is hosted outside of Azure, it must be an **Azure Arc-enabled server** to have a system-assigned managed identity. For more information on Azure Arc-enabled servers and how to install the Azure Connected Machine agent, see: [Azure Arc-enabled servers Overview](/azure/azure-arc/servers/overview).
5253
- If the server is an Azure virtual machine, **enable the system-assigned managed identity setting on the VM**. For more information, see: [Configure managed identities on Azure virtual machines](/entra/identity/managed-identities-azure-resources/how-to-configure-managed-identities?pivots=qs-configure-portal-windows-vm#enable-system-assigned-managed-identity-on-an-existing-vm).
5354

5455
> [!NOTE]
55-
> - Once the Storage Sync Service is configured to use managed identities, registered servers that do not have a system-assigned managed identity will continue to use a shared key to authenticate to your Azure file shares.
56+
> Once the Storage Sync Service is configured to use managed identities, registered servers that don't have a system-assigned managed identity will continue to use a shared key to authenticate to your Azure file shares.
5657
5758
### How to check if your registered servers have a system-assigned managed identity
5859
# [Portal](#tab/azure-portal)
59-
To check if your registered servers have a system-assigned managed identity, perform the following steps using the portal:
60+
To check if your registered servers have a system-assigned managed identity, perform the following steps using the Azure portal:
6061

6162
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity**.
6263

63-
2. In the Registered Servers section, click the **Ready to use Managed ID** tile. This tile displays a list of servers that have a system-assigned managed identity. If your server is not listed, perform the steps to [Enable a system-assigned managed identity on your registered servers]( #enable-a-system-assigned-managed-identity-on-your-registered-servers).
64+
2. In the **Registered Servers** section, select the **Ready to use Managed ID** tile. This tile displays a list of servers that have a system-assigned managed identity. If your server isn't listed, perform the steps to [Enable a system-assigned managed identity on your registered servers]( #enable-a-system-assigned-managed-identity-on-your-registered-servers).
6465

6566
# [PowerShell](#tab/azure-powershell)
6667
To check if your registered servers have a system-assigned managed identity, run the following PowerShell command:
@@ -69,9 +70,9 @@ To check if your registered servers have a system-assigned managed identity, run
6970
Get-AzStorageSyncServer -ResourceGroupName <string> -StorageSyncServiceName <string>
7071
```
7172

72-
Verify the **LatestApplicationId** property has a GUID which indicates the server has a system-assigned managed identity but is not currently configured to use the managed identity.
73+
Verify the **LatestApplicationId** property has a GUID which indicates the server has a system-assigned managed identity but isn't currently configured to use the managed identity.
7374

74-
If the value for the **ActiveAuthType** property is **Certificate** and the **LatestApplicationId** does not have a GUID, the server does not have a system-assigned managed identity and will use shared keys to authenticate to the Azure file share.
75+
If the value for the **ActiveAuthType** property is **Certificate** and the **LatestApplicationId** doesn't have a GUID, the server doesn't have a system-assigned managed identity and will use shared keys to authenticate to the Azure file share.
7576

7677
> [!NOTE]
7778
> Once a server is configured to use the system-assigned managed identity by following the steps in the following section, the **LatestApplicationId** property is no longer used (will be empty), the **ActiveAuthType** property value will be changed to **ManagedIdentity**, and the **ApplicationId** property will have a GUID which is the system-assigned managed identity.
@@ -80,11 +81,11 @@ If the value for the **ActiveAuthType** property is **Certificate** and the **La
8081
## Configure your Azure File Sync deployment to use system-assigned managed identities
8182
# [Portal](#tab/azure-portal)
8283

83-
To configure the Storage Sync Service and registered servers to use system-assigned managed identities, perform the following steps in the portal:
84+
To configure the Storage Sync Service and registered servers to use system-assigned managed identities, perform the following steps in the Azure portal:
8485

8586
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity**.
8687

87-
2. Click **Turn on Managed identity** to begin setup.
88+
2. Select **Turn on Managed identity** to begin setup.
8889

8990
The following steps are performed and will take several minutes (or longer for large topologies) to complete:
9091

@@ -110,6 +111,7 @@ To configure the Storage Sync Service and registered servers to use system-assig
110111
```powershell
111112
Set-AzStorageSyncServiceIdentity -ResourceGroupName <string> -StorageSyncServiceName <string> -Verbose
112113
```
114+
113115
The **Set-AzStorageSyncServiceIdentity** cmdlet performs the following steps for you and will take several minutes (or longer for large topologies) to complete:
114116
- Enables a system-assigned managed identity for Storage Sync Service resource.
115117
- Grants the Storage Sync Service system-assigned managed identity access to your Storage Accounts (Storage Account Contributor role).
@@ -128,37 +130,39 @@ Use the **Set-AzStorageSyncServiceIdentity** cmdlet anytime you need to configur
128130

129131
# [Portal](#tab/azure-portal)
130132

131-
To check if the Storage Sync Service is using a system-assigned managed identity, perform the following steps in the portal:
133+
To check if the Storage Sync Service is using a system-assigned managed identity, perform the following steps in the Azure portal:
132134

133-
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity**.
135+
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings**, and select **Managed identity**.
134136

135-
2. In the Registered Servers section, if you have at least one server listed in the **Using Managed ID** tile, your service is configured to use managed identities.
137+
2. In the **Registered Servers** section, if you have at least one server listed in the **Using Managed ID** tile, your service is configured to use managed identities.
136138

137139
# [PowerShell](#tab/azure-powershell)
138140
To check if the Storage Sync Service is using a system-assigned managed identity, run the following command from an elevated PowerShell window:
139141

140142
```powershell
141143
Get-AzStorageSyncService -ResourceGroupName <string> -StorageSyncServiceName <string>
142144
```
145+
143146
Verify the value for the **UseIdentity** property is **True**. If the value is **False**, the Storage Sync Service is using shared keys to authenticate to the Azure file shares.
144147

145148
---
146149
### How to check if a registered server is configured to use a system-assigned managed identity
147150

148151
# [Portal](#tab/azure-portal)
149152

150-
To check if a registered server is configured to use a system-assigned managed identity, perform the following steps in the portal:
153+
To check if a registered server is configured to use a system-assigned managed identity, perform the following steps in the Azure portal:
151154

152-
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity**.
155+
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings**, and select **Managed identity**.
153156

154-
2. In the Registered Servers section, click the **Using Managed ID** tile and verify the server is listed.
157+
2. In the **Registered Servers** section, select the **Using Managed ID** tile and verify the server is listed.
155158

156159
# [PowerShell](#tab/azure-powershell)
157160
To check if a registered server is configured to use a system-assigned managed identity, run the following command from an elevated PowerShell window:
158161

159162
```powershell
160163
Get-AzStorageSyncServer -ResourceGroupName <string> -StorageSyncServiceName <string>
161164
```
165+
162166
Verify the **ApplicationId** property has a GUID which indicates the server is configured to use the managed identity. The value for the **ActiveAuthType** property will be updated to **ManagedIdentity** once the server is using the system-assigned managed identity.
163167

164168
> [!NOTE]
@@ -168,6 +172,6 @@ Verify the **ApplicationId** property has a GUID which indicates the server is c
168172
## More information
169173
Once the Storage Sync Service and registered server(s) are configured to use a system-assigned managed identity:
170174
- New endpoints (cloud or server) that are created will use a system-assigned managed identity to authenticate to the Azure file share.
171-
- When you need to configure additional registered servers to use managed identities, go to the Managed identity blade in the portal and click Turn on Managed identity or use the Set-AzStorageSyncServiceIdentity PowerShell cmdlet.
175+
- When you need to configure additional registered servers to use managed identities, go to the Managed identity blade in the portal and select **Turn on Managed identity**, or use the `Set-AzStorageSyncServiceIdentity` PowerShell cmdlet.
172176

173177
If you experience issues, see: [Troubleshoot Azure File Sync managed identity issues](/troubleshoot/azure/azure-storage/files/file-sync/file-sync-troubleshoot-managed-identities).

0 commit comments

Comments
 (0)