Skip to content

Commit 4950714

Browse files
authored
Update file-sync-managed-identities.md
updating the document to reflect for directions to use portal for MI
1 parent f3217a5 commit 4950714

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,31 @@ 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+
# [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+
38+
- **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.
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.
2752
- You need to have a **Storage Sync Service** [deployed](file-sync-deployment-guide.md) with at least one **registered server**.
2853
- **Azure File Sync agent version 19.1.0.0 or later** must be installed on the registered server.
2954
- On your **storage accounts** used by Azure File Sync:
@@ -52,7 +77,13 @@ To enable a system-assigned managed identity on a registered server that has the
5277
> - 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.
5378
5479
### How to check if your registered servers have a system-assigned managed identity
80+
# [Portal](#tab/azure-portal)
81+
To check if your registered servers have a system-assigned managed identity, perform the following steps using the portal:
82+
83+
Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
5584

85+
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).
86+
# [PowerShell](#tab/azure-powershell)
5687
To check if your registered servers have a system-assigned managed identity, run the following PowerShell command:
5788

5889
```powershell
@@ -67,6 +98,34 @@ If the value for the **ActiveAuthType** property is **Certificate** and the **La
6798
> 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.
6899
69100
## Configure your Azure File Sync deployment to use system-assigned managed identities
101+
# [Portal](#tab/azure-portal)
102+
103+
To configure the Storage Sync Service and registered servers to use system-assigned managed identities, perform the following steps in the portal:
104+
105+
Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
106+
107+
Click “”Turn on Managed identity” to begin setup.
108+
109+
The following steps are performed and will take several minutes (or longer for large topologies) to complete:
110+
111+
- Enables a system-assigned managed identity for Storage Sync Service resource.
112+
113+
- Grants the Storage Sync Service system-assigned managed identity access to your Storage Accounts (Storage Account Contributor role).
114+
115+
- Grants the Storage Sync Service system-assigned managed identity access to your Azure file shares (Storage File Data Privileged Contributor role).
116+
117+
- Grants the registered server(s) system-assigned managed identity access to the Azure file shares (Storage File Data Privileged Contributor role).
118+
119+
- Configures the Storage Sync Service to use system-assigned managed identity.
120+
121+
- Configures registered server(s) to use system-assigned managed identity.
122+
123+
> [!NOTE]
124+
125+
> 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.
126+
127+
128+
# [PowerShell](#tab/azure-powershell)
70129
To configure the Storage Sync Service and registered servers to use system-assigned managed identities, run the following command from an elevated PowerShell window:
71130

72131
```powershell
@@ -88,6 +147,16 @@ Use the **Set-AzStorageSyncServiceIdentity** cmdlet anytime you need to configur
88147
> 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.
89148
90149
### How to check if the Storage Sync Service is using a system-assigned managed identity
150+
151+
# [Portal](#tab/azure-portal)
152+
153+
To check if the Storage Sync Service is using a system-assigned managed identity, perform the following steps in the portal:
154+
155+
Go to your **Storage Sync Service** in the Azure portal, expand **Settings** and select **Managed identity (preview)**.
156+
157+
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.
158+
159+
# [PowerShell](#tab/azure-powershell)
91160
To check if the Storage Sync Service is using a system-assigned managed identity, run the following command from an elevated PowerShell window:
92161

93162
```powershell
@@ -96,6 +165,16 @@ Get-AzStorageSyncService -ResourceGroupName <string> -StorageSyncServiceName <st
96165
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.
97166

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

101180
```powershell

0 commit comments

Comments
 (0)