Skip to content

Commit 568d6f3

Browse files
authored
Update file-sync-managed-identities.md
1 parent 7f45c19 commit 568d6f3

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ When you enable this configuration, the system-assigned managed identities will
1919
- Registered server authentication to Azure file share
2020
- Registered server authentication to Storage Sync Service
2121

22-
To learn more about the benefits of using managed identities, see Managed identities for Azure resources.
22+
To learn more about the benefits of using managed identities, see [Managed identities for Azure resources](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview).
2323

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 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
32-
- 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 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.
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)
32+
- **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.
3434
- To install the latest the latest Az.StorageSync PowerShell module, run the following command from an elevated PowerShell window:
3535

3636
```powershell
@@ -41,8 +41,8 @@ To configure your Azure File Sync deployment to utilize system-assigned managed
4141
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 access the Azure File Sync service and Azure file shares.
4242
4343
To enable a system-assigned managed identity on a registered server that has the Azure File Sync v19 agent installed, perform the following steps:
44-
- 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
45-
- 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 (VMs).
44+
- 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](https://learn.microsoft.com/azure/azure-arc/servers/overview).
45+
- 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](https://learn.microsoft.com/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).
4646
4747
> [!NOTES]
4848
> - At least one registered server must have a system-assigned managed identity before you can configure the Storage Sync Service to use a system-assigned identity.
@@ -56,20 +56,20 @@ To check if your registered servers have a system-assigned managed identity, run
5656
Get-AzStorageSyncServer -ResourceGroupName <string> -StorageSyncServiceName <string>
5757
```
5858

59-
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.
59+
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.
6060

61-
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.
61+
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.
6262

6363
> [!NOTE]
64-
> Once a server is configured to use the system-assigned managed identity by following the steps in the section below, the LatestApplicationId property is longer used (will be empty), the ActiveAuthType property value will be changed to ManagedIdentity and the ApplicationId property will have the GUID for the system-assigned managed identity.
64+
> Once a server is configured to use the system-assigned managed identity by following the steps in the section below, the **LatestApplicationId** property is longer used (will be empty), the **ActiveAuthType** property value will be changed to **ManagedIdentity** and the **ApplicationId** property will have the GUID for the system-assigned managed identity.
6565
6666
## Configure your Azure File Sync deployment to use system-assigned managed identities
6767
To configure the Storage Sync Service and registered servers to use a system-assigned managed identities, run the following command from an elevated PowerShell window:
6868

6969
```powershell
7070
Set-AzStorageSyncServiceIdentity -ResourceGroupName <string> -StorageSyncServiceName <string> -Verbose
7171
```
72-
The Set-AzStorageSyncServiceIdentity cmdlet performs the following steps for you and will take several minutes (or longer for large topologies) to complete:
72+
The **Set-AzStorageSyncServiceIdentity** cmdlet performs the following steps for you and will take several minutes (or longer for large topologies) to complete:
7373
- Validates at least one registered server has a system assigned managed identity.
7474
- The cmdlet will stop at this step if there are no registered servers with a system-assigned managed identity.
7575
- Enables a system-assigned managed identity for Storage Sync Service resource.
@@ -90,15 +90,15 @@ To check if the Storage Sync Service is using a system-assigned managed identity
9090
```powershell
9191
Get-AzStorageSyncService -ResourceGroupName <string> -StorageSyncServiceName <string>
9292
```
93-
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.
93+
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.
9494

9595
### How to check if a registered server is configured to use a system-assigned managed identity
9696
To check if a registered server is configured to use a system-assigned managed identity, run the following command from an elevated PowerShell window:
9797

9898
```powershell
9999
Get-AzStorageSyncServer -ResourceGroupName <string> -StorageSyncServiceName <string>
100100
```
101-
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.
101+
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.
102102

103103
> [!NOTE]
104104
> 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.

0 commit comments

Comments
 (0)