Merge pull request #284661 from yunho-microsoft/yunho/fluidRelayRotateKeys

Add rotate key page for Azure Fluid Relay

Author: AnnaMHuff

articles/azure-fluid-relay/TOC.yml

@@ -50,6 +50,8 @@
       href: how-tos/container-recovery.md
     - name: 'How to: Use audience features in the Fluid Framework'
       href: how-tos/use-audience-in-fluid.md
+    - name: 'How to: Rotate Azure Fluid Relay access keys'
+      href: how-tos/rotate-fluid-relay-access-keys.md
 - name: Reference
   items:
     - name: Service limits

articles/azure-fluid-relay/how-tos/rotate-fluid-relay-access-keys.md

@@ -0,0 +1,101 @@
+---
+description: Learn how to rotate Azure Fluid Relay access keys.
+title: Rotate Azure Fluid Relay access keys
+ms.date: 08/13/2024
+ms.service: azure-fluid
+ms.topic: reference
+---
+
+# How to rotate Fluid Relay Server access keys
+This article provides an overview of managing access keys (tenant keys) in Azure Fluid Relay Service. Microsoft recommends that you regularly rotate your keys for better security.
+
+## Primary / Secondary keys
+Customers use the access keys to sign the access tokens that are used to access Azure Fluid Relay Services. Azure Fluid Relay uses the keys to validate the tokens.
+
+Two keys are associated with each Azure Fluid Relay Service: a primary key and secondary key. The purpose of dual keys is to let you regenerate, or roll, keys, providing continuous access to your account and data.
+
+## View your access keys
+
+### [Azure portal](#tab/azure-portal)
+To see your access keys, search for your Azure Fluid Relay Service in the Azure portal. On the left menu of Azure Fluid Relay Service page, select **Settings**. Then, select **Access Keys**. Select the **Copy** button to copy the selected key.
+
+[![Screenshot that shows the Access Keys page.](../images/rotate-tenant-keys.png)](../images/rotate-tenant-keys.png#lightbox)
+
+### [PowerShell](#tab/azure-powershell)
+To retrieve your access keys with PowerShell, you need to install [Azure Fluid Relay module](/powershell/module/az.fluidrelay) first.
+
+```azurepowershell
+Install-Module Az.FluidRelay
+```
+
+Then call the [Get-AzFluidRelayServerKey](/powershell/module/az.fluidrelay/get-azfluidrelayserverkey) command.
+
+```azurepowershell
+Get-AzFluidRelayServerKey -FluidRelayServerName <Fluid Relay Service name> -ResourceGroup <resource group> -SubscriptionId <subscription id>
+```
+
+### [Azure CLI](#tab/azure-cli)
+To retrieve your access keys with Azure CLI, you need to install [fluid-relay](/cli/azure/fluid-relay) extension first. See [instructions](/cli/azure/azure-cli-extensions-overview).
+
+Then use [az fluid-relay server list-key](/cli/azure/fluid-relay/server?view=azure-cli-latest&preserve-view=true#az-fluid-relay-server-list-key) command to list access keys.
+
+```azurecli
+az fluid-relay server list-key --resource-group <resource group> --server-name <Fluid Relay Service name>
+```
+
+---
+
+## Rotate your access keys
+Two access keys are assigned so that your Azure Fluid Relay Service does not have to be taken offline when you rotate a key. Having two keys ensures that your application maintains access to Azure Fluid Relay throughout the process. You should rotate one of two keys at one time to avoid service interruptions.
+
+The process of rotating primary and secondary keys is the same. The following steps are for primary keys.
+
+### [Azure portal](#tab/azure-portal)
+To rotate your Azure Fluid Relay primary key in the Azure portal:
+
+1. Update the access keys in your application code to use the secondary access key for the Azure Fluid Relay.
+
+2. Navigate to your Fluid Relay Service in the Azure portal.
+
+3. Under **Settings**, select **Access key**.
+
+4. To regenerate the primary access key for your Azure Fluid Relay Service, select the **Regenerate Primary Key** button above the Access Information.
+
+5. Update the primary key in your code to reference the new primary access key.
+
+### [PowerShell](#tab/azure-powershell)
+To rotate your Fluid Relay primary key with PowerShell, you need to install [Azure Fluid Relay module](/powershell/module/az.fluidrelay) first.
+
+```azurepowershell
+Install-Module Az.FluidRelay
+```
+
+Then follow steps below:
+
+1. Update the access keys in your application code to use the secondary access key for the Azure Fluid Relay.
+
+2. Call the [New-AzFluidRelayServerKey](/powershell/module/az.fluidrelay/new-azfluidrelayserverkey) command to regenerate the primary access key, as shown in the following example:
+
+
+```azurepowershell
+New-AzFluidRelayServerKey -FluidRelayServerName <Fluid Relay Service name> -ResourceGroup <resource group> -KeyName <key name>
+```
+
+3. Update the primary key in your code to reference the new primary access key.
+
+### [Azure CLI](#tab/azure-cli)
+To rotate your Fluid Relay primary key with Azure CLI, you need to install [fluid-relay](/cli/azure/fluid-relay) extension first. See [instructions](/cli/azure/azure-cli-extensions-overview).
+
+Then follow steps below:
+
+1. Update the access keys in your application code to use the secondary access key for the Azure Fluid Relay.
+
+2. Call the [az fluid-relay server regenerate-key](/cli/azure/fluid-relay/server?view=azure-cli-latest&preserve-view=true#az-fluid-relay-server-regenerate-key) command to regenerate the primary access key, as shown in the following example:
+
+```azurecli
+az fluid-relay server regenerate-key --resource-group <resource group>--server-name <Fluid Relay Service name>--key-name <key name>
+```
+
+3. Update the primary key in your code to reference the new primary access key.
+
+---