Skip to content

Commit 5faa4b2

Browse files
Merge pull request #295495 from sushantjrao/break-glass-setup
Update howto-append-custom-suffix-to-interface-descriptions.md
2 parents 8f17146 + 099f1c5 commit 5faa4b2

File tree

2 files changed

+25
-17
lines changed

2 files changed

+25
-17
lines changed

articles/operator-nexus/howto-append-custom-suffix-to-interface-descriptions.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ ms.custom: template-how-to
1111

1212
# Append custom suffix to interface descriptions in Azure Operator Nexus Network Fabric
1313

14-
This guide explains how to append a user-defined suffix (`additionalDescription`) to interface descriptions in Azure Operator Nexus Network Fabric. This feature provides enhanced flexibility for operational annotations, allowing users to customize interface descriptions for specific maintenance or operational requirements.
14+
TThis guide explains how to append a user-defined suffix (`additionalDescription`) to interface descriptions in Azure Operator Nexus Network Fabric. The primary interface description is `read-only,` but the `additionalDescription` property provides enhanced flexibility for operational annotations. This approach allows users to customize interface descriptions for specific maintenance or operational requirements without altering the system-generated description.
1515

1616
## Prerequisites
1717

18-
- **Azure CLI**: Version 2.61 or higher
18+
- **Azure CLI**: Version 2.69 or higher.
19+
20+
- Install CLI extension **`managednetworkfabric`** 8.0.0 or higher.
1921

2022
## Steps to append a custom suffix
2123

@@ -37,10 +39,12 @@ az networkfabric interface show -g "example-rg" \
3739
| `-g, --resource-group` | `-g` | Name of the resource group where the network device resides. |
3840
| `--network-device-name` | N/A | Name of the Network Fabric device. |
3941
| `--resource-name` | N/A | Name of the network interface resource. |
40-
| `--query` | N/A | Filters the output to show only the specified field (e.g., `description`). |
42+
| `--query` | N/A | Filters the output to show only the specified field (for example, `description`). |
4143

4244
### 2. Append a suffix to the interface description
4345

46+
The primary interface description (for example, AR-CE2(Fab3-AR-CE2):Et1/1 to CR1-TOR1(Fab3-CP1-TOR1)-Port23) is read-only and can't be modified. However, you can append a custom suffix using the additional-description property. This updates only the additional-description field while keeping the main description unchanged.
47+
4448
To add a custom suffix, use the following command:
4549

4650
```Azure CLI

articles/operator-nexus/howto-configure-bring-your-own-storage-network-fabric.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ This guide provides step-by-step instructions for configuring Network Fabric (NN
1717

1818
Before proceeding, ensure you have:
1919

20-
- Azure CLI Installed - Install or update the Azure CLI (Download).
20+
- Azure CLI Installed - Install or update the Azure CLI version Version 2.69 or higher.
21+
22+
- CLI Extension: Install the `managednetworkfabric` extension, version 8.0.0 or higher.
2123

2224
- Necessary Permissions - Ensure you have Contributor or Owner role on the storage account and permissions to assign RBAC roles.
2325

@@ -27,41 +29,41 @@ Before proceeding, ensure you have:
2729

2830
- NNF Resource Provider Registration - Ensure Microsoft.ManagedNetworkFabric is registered in your subscription.
2931

30-
## Create user-assigned managed identity (UAMI)
32+
## Step 1: Create user-assigned managed identity (UAMI)
3133

3234
Create the UAMI(s) required for accessing the necessary resources.
3335

3436
For more information on creating managed identities, refer to [Manage user-assigned managed identities](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp)
3537

36-
## Configure the storage account
38+
## Step 2: Configure the storage account
3739

38-
### Create or identify a storage account
40+
### 2.1 Create or identify a storage account
3941

4042
Create a new storage account or use an existing one. Refer to [Create an Azure storage account](../storage/common/storage-account-create.md).
4143

42-
### Assign the required role
44+
### 2.2 Assign the required role
4345

4446
Assign the **Storage Blob Data Contributor** role to the users and UAMI needing access to the **runRO** and **cable validation command output**.
4547

4648
For role assignment details, see [Assign an Azure role for access to blob data](../storage/blobs/assign-azure-role-data-access.md).
4749

48-
### 2.3 Restrict storage account access
50+
### 2.3 Restrict storage account access (Optional)
4951

5052
To limit access, configure Storage Firewalls and Virtual Networks:
5153

5254
- Add all required users' IP addresses to the **Virtual Networks** and/or **Firewall** lists.
5355

5456
- Follow instructions from [Configure Azure Storage firewalls and virtual networks](../storage/common/storage-network-security.md).
5557

56-
### Enable Trusted Services
58+
### 2.4 Enable Trusted Services
5759

5860
Ensure the option **Allow Azure services on the trusted services list to access this storage account** under **Exceptions** is selected.
5961

60-
## Assign permissions to UAMI for Nexus Network Fabric Resource Provider
62+
## Step3: Assign permissions to UAMI for Nexus Network Fabric Resource Provider
6163

6264
When using UAMI to access a storage account, the NNF platform requires provisioning access. Specifically, the permission **Microsoft.ManagedIdentity/userAssignedIdentities/assign/action** must be granted to the UAMI for the **Managed Network Fabric RP** in Microsoft Entra ID.
6365

64-
### Assign the Managed Identity Operator Role
66+
### 3.1 Assign the Managed Identity Operator Role
6567

6668
1. Open the **Azure Portal** and locate the **User-Assigned Identity**.
6769

@@ -76,13 +78,13 @@ When using UAMI to access a storage account, the NNF platform requires provision
7678
6. Click **Review and assign**.
7779

7880
> [!Note]
79-
> When using a User-Assigned Managed Identity (UAMI) to access a Storage account, it is essential to provision access to that identity for the NNF platform. Specifically, the Microsoft.ManagedIdentity/userAssignedIdentities/assign/action permission needs to be added to the User-assigned identity for the Managed Network Fabric RP Microsoft Entra ID. This permission ensures that the UAMI can be properly assigned and utilized within the NNF platform. It is a known limitation of the platform that this specific permission assignment is required. However, this limitation will be addressed in a future release (NNF 9.0).
81+
> When using a User-Assigned Managed Identity (UAMI) to access a Storage account, it is essential to provision access to that identity for the NNF platform. Specifically, the Microsoft.ManagedIdentity/userAssignedIdentities/assign/action permission needs to be added to the User-assigned identity for the Managed Network Fabric RP Microsoft Entra ID. This permission ensures that the UAMI can be properly assigned and utilized within the NNF platform. It is a known limitation of the platform that this specific permission assignment is required. However, this limitation will be addressed in a future release.
8082
81-
## Update Cluster with UAMI and Storage Account configuration
83+
## Step 4: Update Cluster with UAMI and Storage Account configuration
8284

8385
When creating or updating an NNF instance, both the User-Assigned Managed Identity and Storage Account must be supplied together.
8486

85-
### Storage account configuration format
87+
### 4.1 Storage account configuration format
8688

8789
Use the `--storage-account-configuration` parameter to define the storage location for command outputs:
8890

@@ -96,7 +98,9 @@ Use the `--storage-account-configuration` parameter to define the storage locati
9698
}
9799
```
98100

99-
## Create a new Fabric instance
101+
## Step 5: Attaching your own storage account Fabric instance
102+
103+
### Attaching storage account during the creation of Fabric instance
100104

101105
Use the following command to create a new Fabric instance with BYO storage:
102106

@@ -108,7 +112,7 @@ az networkfabric fabric create --resource-name <fabricname> \
108112
--mi-user-assigned "/subscriptions/<uamisubscriptionid>/resourceGroups/<uamiresourcegroupname>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<uaminame>"
109113
```
110114

111-
## Update an existing Fabric instance
115+
### Updating storage account during the creation of Fabric instance
112116

113117
For existing deployments, update the Fabric with the required parameters:
114118

0 commit comments

Comments
 (0)