Skip to content

Commit 8fc4c58

Browse files
authored
Merge pull request #295284 from rladbsal/patch-3
Update file-sync-managed-identities.md
2 parents 63bd0de + e1d4b09 commit 8fc4c58

File tree

1 file changed

+85
-7
lines changed

1 file changed

+85
-7
lines changed

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

Lines changed: 85 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,38 @@ To learn more about the benefits of using managed identities, see [Managed ident
2424
To configure your Azure File Sync deployment to utilize system-assigned managed identities, please follow the guidance in the subsequent sections.
2525

2626
## Prerequisites
27-
- You need to have a **Storage Sync Service** [deployed](file-sync-deployment-guide.md) with at least one **registered server**.
28-
- **Azure File Sync agent version 19.1.0.0 or later** must be installed on the registered server.
29-
- On your **storage accounts** used by Azure File Sync:
30-
- You must be a **member of the Owner management role** or have “Microsoft.Authorization/roleassignments/write” permissions.
31-
- **Allow Azure services on the trusted services list to access this storage account** exception must be enabled for preview. [Learn more](file-sync-networking-endpoints.md#grant-access-to-trusted-azure-services-and-restrict-access-to-the-storage-account-public-endpoint-to-specific-virtual-networks)
27+
# [Portal](#tab/azure-portal)
28+
- You need to have a **Storage Sync Service** [deployed](file-sync-deployment-guide.md) with at least one **registered server**.
29+
30+
- **Azure File Sync agent version 19.1.0.0 or later** must be installed on the registered server.
31+
32+
- On your **storage accounts** used by Azure File Sync:
33+
34+
- You must be a **member of the Owner management role** or have “Microsoft.Authorization/roleassignments/write” permissions.
35+
36+
- **Allow Azure services on the trusted services list to access this storage account** exception must be enabled for preview. [Learn more](file-sync-networking-endpoints.md#grant-access-to-trusted-azure-services-and-restrict-access-to-the-storage-account-public-endpoint-to-specific-virtual-networks)
37+
3238
- **Allow storage account key access** must be enabled for preview. To check this setting, navigate to your storage account and select **Configuration** under the Settings section.
33-
- **Az.StorageSync [PowerShell module](https://www.powershellgallery.com/packages/Az.StorageSync) version 2.2.0 or later** must be installed on the machine that will be used to configure Azure File Sync to use managed identities. To install the latest Az.StorageSync PowerShell module, run the following command from an elevated PowerShell window:
39+
40+
# [PowerShell](#tab/azure-powershell)
41+
- You need to have a **Storage Sync Service** [deployed](file-sync-deployment-guide.md) with at least one **registered server**.
42+
43+
- **Azure File Sync agent version 19.1.0.0 or later** must be installed on the registered server.
44+
45+
- On your **storage accounts** used by Azure File Sync:
46+
47+
- You must be a **member of the Owner management role** or have “Microsoft.Authorization/roleassignments/write” permissions.
48+
49+
- **Allow Azure services on the trusted services list to access this storage account** exception must be enabled for preview. [Learn more](file-sync-networking-endpoints.md#grant-access-to-trusted-azure-services-and-restrict-access-to-the-storage-account-public-endpoint-to-specific-virtual-networks)
50+
51+
- **Allow storage account key access** must be enabled for preview. To check this setting, navigate to your storage account and select **Configuration** under the Settings section.
52+
53+
- **Az.StorageSync [PowerShell module](https://www.powershellgallery.com/packages/Az.StorageSync) version 2.2.0 or later** must be installed on the machine that will be used to configure Azure File Sync to use managed identities. To install the latest Az.StorageSync PowerShell module, run the following command from an elevated PowerShell window:
3454

3555
```powershell
3656
Install-Module Az.StorageSync -Force
3757
```
38-
58+
---
3959
## Regional availability
4060
4161
Azure File Sync support for system-assigned managed identities (preview) is available in [all Azure Public and Gov regions](https://azure.microsoft.com/global-infrastructure/locations/) that support Azure File Sync.
@@ -52,7 +72,14 @@ To enable a system-assigned managed identity on a registered server that has the
5272
> - 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.
5373
5474
### How to check if your registered servers have a system-assigned managed identity
75+
# [Portal](#tab/azure-portal)
76+
To check if your registered servers have a system-assigned managed identity, perform the following steps using the portal:
77+
78+
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
5579
80+
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).
81+
82+
# [PowerShell](#tab/azure-powershell)
5683
To check if your registered servers have a system-assigned managed identity, run the following PowerShell command:
5784
5885
```powershell
@@ -66,7 +93,35 @@ If the value for the **ActiveAuthType** property is **Certificate** and the **La
6693
> [!NOTE]
6794
> 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.
6895
96+
---
6997
## Configure your Azure File Sync deployment to use system-assigned managed identities
98+
# [Portal](#tab/azure-portal)
99+
100+
To configure the Storage Sync Service and registered servers to use system-assigned managed identities, perform the following steps in the portal:
101+
102+
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
103+
104+
2. Click **Turn on Managed identity** to begin setup.
105+
106+
The following steps are performed and will take several minutes (or longer for large topologies) to complete:
107+
108+
- Enables a system-assigned managed identity for Storage Sync Service resource.
109+
110+
- Grants the Storage Sync Service system-assigned managed identity access to your Storage Accounts (Storage Account Contributor role).
111+
112+
- Grants the Storage Sync Service system-assigned managed identity access to your Azure file shares (Storage File Data Privileged Contributor role).
113+
114+
- Grants the registered server(s) system-assigned managed identity access to the Azure file shares (Storage File Data Privileged Contributor role).
115+
116+
- Configures the Storage Sync Service to use system-assigned managed identity.
117+
118+
- Configures registered server(s) to use system-assigned managed identity.
119+
120+
> [!NOTE]
121+
> Once the registered server(s) are configured to use a system-assigned managed identity, it can take up to one hour before the server uses the system-assigned managed identity to authenticate to the Storage Sync Service and file shares.
122+
123+
124+
# [PowerShell](#tab/azure-powershell)
70125
To configure the Storage Sync Service and registered servers to use system-assigned managed identities, run the following command from an elevated PowerShell window:
71126

72127
```powershell
@@ -87,15 +142,37 @@ Use the **Set-AzStorageSyncServiceIdentity** cmdlet anytime you need to configur
87142
> [!NOTE]
88143
> Once the registered server(s) are configured to use a system-assigned managed identity, it can take up to one hour before the server uses the system-assigned managed identity to authenticate to the Storage Sync Service and file shares.
89144
145+
---
90146
### How to check if the Storage Sync Service is using a system-assigned managed identity
147+
148+
# [Portal](#tab/azure-portal)
149+
150+
To check if the Storage Sync Service is using a system-assigned managed identity, perform the following steps in the portal:
151+
152+
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
153+
154+
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.
155+
156+
# [PowerShell](#tab/azure-powershell)
91157
To check if the Storage Sync Service is using a system-assigned managed identity, run the following command from an elevated PowerShell window:
92158

93159
```powershell
94160
Get-AzStorageSyncService -ResourceGroupName <string> -StorageSyncServiceName <string>
95161
```
96162
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.
97163

164+
---
98165
### How to check if a registered server is configured to use a system-assigned managed identity
166+
167+
# [Portal](#tab/azure-portal)
168+
169+
To check if a registered server is configured to use a system-assigned managed identity, perform the following steps in the portal:
170+
171+
1. Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
172+
173+
2. In the Registered Servers section, click the **Using Managed ID** tile and verify the server is listed.
174+
175+
# [PowerShell](#tab/azure-powershell)
99176
To check if a registered server is configured to use a system-assigned managed identity, run the following command from an elevated PowerShell window:
100177

101178
```powershell
@@ -106,6 +183,7 @@ Verify the **ApplicationId** property has a GUID which indicates the server is c
106183
> [!NOTE]
107184
> Once the registered server(s) are configured to use a system-assigned managed identity, it can take up to one hour before the server uses the system-assigned managed identity to authenticate to the Storage Sync Service and Azure file shares.
108185
186+
---
109187
## More information
110188
Once the Storage Sync Service and registered server(s) are configured to use a system-assigned managed identity:
111189
- New endpoints (cloud or server) that are created will use a system-assigned managed identity to authenticate to the Azure file share.

0 commit comments

Comments
 (0)