Share via

az networkcloud clustermanager

  • Reference

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.66.0 or higher). The extension will automatically install the first time you run an az networkcloud clustermanager command. Learn more about extensions.

Manage cluster manager.

Commands

Name Description Type Status
az networkcloud clustermanager create

Create a new cluster manager or update properties of the cluster manager if it exists.

 Extension GA
az networkcloud clustermanager delete

Delete the provided cluster manager.

 Extension GA
az networkcloud clustermanager list

List cluster managers in the provided resource group or subscription.

 Extension GA
az networkcloud clustermanager show

Get the properties of the provided cluster manager.

 Extension GA
az networkcloud clustermanager update

Update properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.

 Extension GA
az networkcloud clustermanager wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az networkcloud clustermanager create

Create a new cluster manager or update properties of the cluster manager if it exists.

az networkcloud clustermanager create --cluster-manager-name
                                      --fabric-controller-id
                                      --resource-group
                                      [--analytics-workspace-id]
                                      [--location]
                                      [--managed-resource-group-configuration]
                                      [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--mi-user-assigned]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--tags]

Examples

Create or update cluster manager

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

Create or update cluster manager with system assigned identity

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --mi-system-assigned

Create or update cluster manager with user assigned identity

az networkcloud clustermanager create --name "clusterManagerName" --location "location" --analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" --fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" --managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"

Required Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

--fabric-controller-id

The resource ID of the fabric controller that has one to one mapping with the cluster manager.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--analytics-workspace-id

The resource ID of the Log Analytics workspace that is used for the logs collection.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--managed-resource-group-configuration

The configuration of the managed resource group associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--mi-system-assigned

Enable system assigned identity.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az networkcloud clustermanager delete

Delete the provided cluster manager.

az networkcloud clustermanager delete [--cluster-manager-name]
                                      [--ids]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

Examples

Delete cluster manager

az networkcloud clustermanager delete --name "clusterManagerName" --resource-group "resourceGroupName"

Optional Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az networkcloud clustermanager list

List cluster managers in the provided resource group or subscription.

az networkcloud clustermanager list [--max-items]
                                    [--next-token]
                                    [--resource-group]

Examples

List cluster managers for subscription

az networkcloud clustermanager list

List cluster managers for resource group

az networkcloud clustermanager list --resource-group "resourceGroupName"

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az networkcloud clustermanager show

Get the properties of the provided cluster manager.

az networkcloud clustermanager show [--cluster-manager-name]
                                    [--ids]
                                    [--resource-group]
                                    [--subscription]

Examples

Get cluster manager

az networkcloud clustermanager show --name "clusterManagerName" --resource-group "resourceGroupName"

Optional Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az networkcloud clustermanager update

Update properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.

az networkcloud clustermanager update [--cluster-manager-name]
                                      [--ids]
                                      [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--mi-user-assigned]
                                      [--resource-group]
                                      [--subscription]
                                      [--tags]

Examples

Update tags for cluster manager

az networkcloud clustermanager update --name "clusterManagerName" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName"

Add system assigned identity to cluster manager

az networkcloud clustermanager update --name "clusterManagerName" --resource-group "resourceGroupName" --mi-system-assigned

Add user assigned identity to cluster manager

az networkcloud clustermanager update --name "clusterManagerName" --resource-group "resourceGroupName" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"

Optional Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--mi-system-assigned

Enable system assigned identity.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--mi-user-assigned

Space separated resource IDs to add user-assigned identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az networkcloud clustermanager wait

Place the CLI in a waiting state until a condition is met.

az networkcloud clustermanager wait [--cluster-manager-name]
                                    [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]

Optional Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.