You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -71,11 +71,11 @@ The role assignment can be done via the Azure portal:
71
71
72
72
## Create a Cluster Manager
73
73
74
-
### Create the Cluster Manager using Azure CLI:
74
+
Use the below commands to create a Cluster Manager.
75
75
76
-
Use the `az networkcloud clustermanager create` command to create a Cluster Manager. This command creates a new Cluster Manager or updates the properties of the Cluster Manager if it exists. If you have multiple Azure subscriptions, select the appropriate subscription ID using the [az account set](/cli/azure/account#az-account-set) command.
76
+
### [Azure CLI](#tab/azure-cli)
77
77
78
-
```azurecli
78
+
```azurecli-interactive
79
79
az networkcloud clustermanager create \
80
80
--name "$CLUSTER_MANAGER_NAME" \
81
81
--location "$LOCATION" \
@@ -87,34 +87,54 @@ az networkcloud clustermanager create \
87
87
--subscription "$SUB_ID"
88
88
```
89
89
90
-
-**Arguments**
91
-
-**--name -n [Required]** - The name of the Cluster Manager.
92
-
-**--fabric-controller-id [Required]** - The resource ID of the Network Fabric Controller that is associated with the Cluster Manager.
93
-
-**--resource-group -g [Required]** - Name of resource group. You can configure the default resource group using `az configure --defaults group=<name>`.
94
-
-**--analytics-workspace-id** - The resource ID of the Log Analytics Workspace that is used for the logs collection
95
-
-**--location -l** - Location. Azure region where the Cluster Manager is created. Values from: `az account list -locations`. You can configure the default location using `az configure --defaults location="$LOCATION"`.
96
-
-**--managed-resource-group-configuration** - The configuration of the managed resource group associated with the resource.
- location: The region of the managed resource group. If not specified, the region of the
99
-
parent resource is chosen.
100
-
- name: The name for the managed resource group. If not specified, a unique name is
101
-
automatically generated.
102
-
-**wait/--no-wait** - Wait for command to complete or don't wait for the long-running operation to finish.
103
-
-**--tags** - Space-separated tags: key[=value][key[=value]...]. Use '' to clear existing tags
104
-
-**--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
105
-
-**--mi-system-assigned** - Enable System-assigned managed identity. Once added, the Identity can only be removed via the API call at this time.
106
-
-**--mi-user-assigned** - Space-separated resource IDs of the User-assigned managed identities to be added. Once added, the Identity can only be removed via the API call at this time.
107
-
108
-
### Create the Cluster Manager using Azure Resource Manager template editor:
109
-
110
-
An alternate way to create a Cluster Manager is with the ARM template editor.
111
-
112
-
In order to create the cluster this way, you need to provide a template file (clusterManager.jsonc) and a parameter file (clusterManager.parameters.jsonc).
90
+
Arguments:
91
+
-**--name -n [Required]** - The name of the Cluster Manager.
92
+
-**--fabric-controller-id [Required]** - The resource ID of the Network Fabric Controller that is associated with the Cluster Manager.
93
+
-**--resource-group -g [Required]** - Name of resource group. You can configure the default resource group using `az configure --defaults group=<name>`.
94
+
-**--analytics-workspace-id** - The resource ID of the Log Analytics Workspace that is used for the logs collection
95
+
-**--location -l** - Location. Azure region where the Cluster Manager is created. Values from: `az account list -locations`. You can configure the default location using `az configure --defaults location="$LOCATION"`.
96
+
-**--managed-resource-group-configuration** - The configuration of the managed resource group associated with the resource.
-**--mi-user-assigned** - Space-separated resource IDs of the User-assigned managed identities to be added.
107
+
-**--if-match**/**if-none-match** - Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. The ETag is returned as the resource property once the resource is created and can be used on the update operations.
-**-ResourceGroupName** - The name of the resource group.
123
+
-**-SubscriptionId** - The ID of the target subscription.
124
+
-**-FabricControllerId** - The resource ID of the fabric controller that has one to one mapping with the cluster manager.
125
+
-**-Location** - The geo-location where the resource lives.
126
+
-**-AnalyticsWorkspaceId** - The resource ID of the Log Analytics workspace that is used for the logs collection.
127
+
-**-ManagedResourceGroupConfigurationLocation** - The location of the managed resource group. If not specified, the location of the parent resource is chosen.
128
+
-**-ManagedResourceGroupConfigurationName** - The name for the managed resource group. If not specified, the unique name is automatically generated.
129
+
-**-Tag** - Hashtable of Resource tags.
130
+
131
+
### [ARM Template](#tab/template)
132
+
133
+
To create a Cluster Manager via ARM Template, you need to provide a template file (clusterManager.jsonc) and a parameter file (clusterManager.parameters.jsonc).
>To get the correct formatting, copy the raw code file. The values within the clusterManager.parameters.jsonc file are customer specific and may not be a complete list. Please update the value fields for your specific environment.
@@ -132,70 +152,140 @@ You can find examples of these two files here:
132
152
1. Make sure all Instance Details are correct.
133
153
1. Click Review + create.
134
154
155
+
---
135
156
136
157
## List/show Cluster Manager(s)
137
158
138
159
List and show commands are used to get a list of existing Cluster Managers or the properties of a specific Cluster Manager.
139
160
140
-
### List Cluster Managers in resource group
161
+
### [Azure CLI](#tab/azure-cli)
141
162
142
163
This command lists the Cluster Managers in the specified Resource group.
143
164
144
-
```azurecli
165
+
```azurecli-interactive
145
166
az networkcloud clustermanager list --resource-group "$CLUSTER_MANAGER_RG"
146
167
```
147
168
148
-
### List Cluster Managers in subscription
149
-
150
169
This command lists the Cluster Managers in the specified subscription.
151
170
152
-
```azurecli
171
+
```azurecli-interactive
153
172
az networkcloud clustermanager list --subscription "$SUB_ID"
154
173
```
155
174
156
-
### Show Cluster Manager properties
157
-
158
-
This command lists the properties of the specified Cluster Manager.
175
+
This command shows the properties of the specified Cluster Manager.
159
176
160
-
```azurecli
177
+
```azurecli-interactive
161
178
az networkcloud clustermanager show \
162
179
--name "$CLUSTER_MANAGER_NAME" \
163
180
--resource-group "$CLUSTER_MANAGER_RG" \
164
181
--subscription "$SUB_ID"
165
182
```
166
183
167
-
### List/show command arguments
184
+
### [Azure PowerShell](#tab/azure-powershell)
168
185
169
-
-**--name -n** - The name of the Cluster Manager.
170
-
-**--IDs** - One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource ID' arguments.
171
-
-**--resource-group -g** - Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
172
-
-**--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
186
+
This command lists the Cluster Managers in the specified Resource group.
This command is used to patch properties of the provided Cluster Manager, or update the tags assigned to the Cluster Manager. Properties and tag updates can be done independently.
177
209
178
-
```azurecli
210
+
### [Azure CLI](#tab/azure-cli)
211
+
212
+
This command updates the Cluster Managers in the specified Resource group.
-**--tags** - TSpace-separated tags: key[=value][key[=value] ...]. Use '' to clear existing tags.
188
-
-**--name -n** - The name of the Cluster Manager.
189
-
-**--IDs** - One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource ID' arguments.
190
-
-**--resource-group -g** - Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
191
-
-**--subscription** - Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
192
-
-**--mi-system-assigned** - Enable System-assigned managed identity. Once added, the Identity can only be removed via the API call at this time.
193
-
-**--mi-user-assigned** - Space-separated resource IDs of the User-assigned managed identities to be added. Once added, the Identity can only be removed via the API call at this time.
222
+
### [Azure PowerShell](#tab/azure-powershell)
194
223
195
-
### Update Cluster Manager Identities via APIs
224
+
```azurepowershell-interactive
225
+
$tagHash = @{
226
+
tag1 = "true"
227
+
tag2 = "false"
228
+
}
196
229
197
-
Cluster Manager managed identities can be assigned via CLI. The un-assignment of the identities can be done via API calls.
198
-
Note, `<APIVersion>` is the API version 2024-07-01 or newer.
After you successfully created the Network Fabric Controller and the Cluster Manager, the next step is to create a [Network Fabric](./howto-configure-network-fabric.md).
0 commit comments