You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/storage/file-sync/file-sync-managed-identities.md
+24-20Lines changed: 24 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
---
2
2
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.
4
4
author: khdownie
5
5
ms.service: azure-file-storage
6
6
ms.topic: conceptual
7
-
ms.date: 03/31/2025
7
+
ms.date: 05/01/2025
8
8
ms.author: kendownie
9
9
---
10
10
@@ -19,18 +19,18 @@ When you enable this configuration, the system-assigned managed identities will
19
19
20
20
To learn more about the benefits of using managed identities, see [Managed identities for Azure resources](/entra/identity/managed-identities-azure-resources/overview).
21
21
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.
23
23
24
24
## Prerequisites
25
25
# [Portal](#tab/azure-portal)
26
26
-**Azure File Sync agent version 20.0.0.0 or later** must be installed on the registered server.
27
27
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.
29
29
30
30
# [PowerShell](#tab/azure-powershell)
31
31
-**Azure File Sync agent version 20.0.0.0 or later** must be installed on the registered server.
32
32
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.
34
34
35
35
36
36
@@ -48,19 +48,20 @@ Azure File Sync support for system-assigned managed identities is available in
48
48
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.
49
49
50
50
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).
52
53
- 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).
53
54
54
55
> [!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.
56
57
57
58
### How to check if your registered servers have a system-assigned managed identity
58
59
# [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:
60
61
61
62
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity**.
62
63
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).
64
65
65
66
# [PowerShell](#tab/azure-powershell)
66
67
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
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.
73
74
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.
75
76
76
77
> [!NOTE]
77
78
> 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
80
81
## Configure your Azure File Sync deployment to use system-assigned managed identities
81
82
# [Portal](#tab/azure-portal)
82
83
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:
84
85
85
86
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity**.
86
87
87
-
2.Click**Turn on Managed identity** to begin setup.
88
+
2.Select**Turn on Managed identity** to begin setup.
88
89
89
90
The following steps are performed and will take several minutes (or longer for large topologies) to complete:
90
91
@@ -110,6 +111,7 @@ To configure the Storage Sync Service and registered servers to use system-assig
The **Set-AzStorageSyncServiceIdentity** cmdlet performs the following steps for you and will take several minutes (or longer for large topologies) to complete:
114
116
- Enables a system-assigned managed identity for Storage Sync Service resource.
115
117
- 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
128
130
129
131
# [Portal](#tab/azure-portal)
130
132
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:
132
134
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**.
134
136
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.
136
138
137
139
# [PowerShell](#tab/azure-powershell)
138
140
To check if the Storage Sync Service is using a system-assigned managed identity, run the following command from an elevated PowerShell window:
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.
144
147
145
148
---
146
149
### How to check if a registered server is configured to use a system-assigned managed identity
147
150
148
151
# [Portal](#tab/azure-portal)
149
152
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:
151
154
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**.
153
156
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.
155
158
156
159
# [PowerShell](#tab/azure-powershell)
157
160
To check if a registered server is configured to use a system-assigned managed identity, run the following command from an elevated PowerShell window:
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.
163
167
164
168
> [!NOTE]
@@ -168,6 +172,6 @@ Verify the **ApplicationId** property has a GUID which indicates the server is c
168
172
## More information
169
173
Once the Storage Sync Service and registered server(s) are configured to use a system-assigned managed identity:
170
174
- 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.
172
176
173
177
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