Share via

az networkcloud cluster

Note

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

Manage cluster.

Commands

Name Description Type Status
az networkcloud cluster baremetalmachinekeyset

Manage cluster's bare metal machine key set.

 Extension GA
az networkcloud cluster baremetalmachinekeyset create

Create a new bare metal machine key set or update the existing one for the provided cluster.

 Extension GA
az networkcloud cluster baremetalmachinekeyset delete

Delete the bare metal machine key set of the provided cluster.

 Extension GA
az networkcloud cluster baremetalmachinekeyset list

List bare metal machine key sets of the cluster.

 Extension GA
az networkcloud cluster baremetalmachinekeyset show

Get bare metal machine key set of the provided cluster.

 Extension GA
az networkcloud cluster baremetalmachinekeyset update

Update properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

 Extension GA
az networkcloud cluster baremetalmachinekeyset wait

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

 Extension GA
az networkcloud cluster bmckeyset

Manage cluster's baseboard management controller key set.

 Extension GA
az networkcloud cluster bmckeyset create

Create a new baseboard management controller key set or update the existing one for the provided cluster.

 Extension GA
az networkcloud cluster bmckeyset delete

Delete the baseboard management controller key set of the provided cluster.

 Extension GA
az networkcloud cluster bmckeyset list

List baseboard management controller key sets of the cluster.

 Extension GA
az networkcloud cluster bmckeyset show

Get baseboard management controller key set of the provided cluster.

 Extension GA
az networkcloud cluster bmckeyset update

Update properties of baseboard management controller key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

 Extension GA
az networkcloud cluster bmckeyset wait

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

 Extension GA
az networkcloud cluster continue-update-version

Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

 Extension GA
az networkcloud cluster create

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

 Extension GA
az networkcloud cluster delete

Delete the provided cluster.

 Extension GA
az networkcloud cluster deploy

Deploy the cluster.

 Extension GA
az networkcloud cluster list

List clusters in the provided resource group or subscription.

 Extension GA
az networkcloud cluster metricsconfiguration

Manage cluster's metrics configuration.

 Extension GA
az networkcloud cluster metricsconfiguration create

Create the metrics configuration of the provided cluster.

 Extension GA
az networkcloud cluster metricsconfiguration delete

Delete the metrics configuration of the provided cluster.

 Extension GA
az networkcloud cluster metricsconfiguration list

List metrics configurations of the cluster.

 Extension GA
az networkcloud cluster metricsconfiguration show

Get metrics configuration of the provided cluster.

 Extension GA
az networkcloud cluster metricsconfiguration update

Update properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

 Extension GA
az networkcloud cluster metricsconfiguration wait

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

 Extension GA
az networkcloud cluster scan-runtime

Trigger the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

 Extension GA
az networkcloud cluster show

Get properties of the provided cluster.

 Extension GA
az networkcloud cluster update

Update the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

 Extension GA
az networkcloud cluster update-version

Update the version of the provided cluster to one of the available supported versions.

 Extension GA
az networkcloud cluster wait

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

 Extension GA

az networkcloud cluster continue-update-version

Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

az networkcloud cluster continue-update-version [--cluster-name --name]
                                                [--ids]
                                                [--machine-group-targeting-mode --mode {AlphaByRack}]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--resource-group]
                                                [--subscription]

Examples

Continue a paused update to the cluster version

az networkcloud cluster continue-update-version --name "clusterName" --resource-group "resourceGroupName" --machine-group-targeting-mode "AlphaByRack"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--machine-group-targeting-mode --mode

The mode by which the cluster will target the next grouping of servers to continue the update.

Property Value
Parameter group: ClusterContinueUpdateVersionParameters Arguments
Default value: AlphaByRack
Accepted values: AlphaByRack
--no-wait

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

Property Value
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>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster create

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

az networkcloud cluster create --aggregator-or-single-rack-definition
                               --cluster-name --name
                               --cluster-type {MultiRack, SingleRack}
                               --cluster-version
                               --extended-___location
                               --network-fabric-id
                               --resource-group
                               [--analytics-output-settings --ao-settings]
                               [--cluster-___location]
                               [--cluster-service-principal]
                               [--co-settings --command-output-settings]
                               [--compute-deployment-threshold]
                               [--compute-rack-definitions]
                               [--if-match]
                               [--if-none-match]
                               [--___location]
                               [--managed-resource-group-configuration --mrg]
                               [--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}]
                               [--runtime-protection]
                               [--sa-settings --secret-archive-settings]
                               [--tags]
                               [--update-strategy]
                               [--vs-settings --vulnerability-scanning-settings]

Examples

Create or update single rack cluster

az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-___location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --___location "eastus" --cluster-___location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90  --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition network-rack-id="/subscriptions/subscriptionId/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/cmName/subnets/ClusterManagerSubnet" rack-sku-id="/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/VLab_Single_DellR750_8C2M_x70r3_9" rack-serial-number=b99m99r1 rack-___location='b99m99r1' availability-zone=1 storage-appliance-configuration-data="[{rackSlot:1,adminCredentials:{username:'adminuser',password:'password'},storageApplianceName:name,serialNumber:serial}]" bare-metal-machine-configuration-data="[{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:DD:E7:08',bootMacAddress:'AA:BB:CC:F8:71:2E',machineName:lab00r750wkr1,rackSlot:2,serialNumber:5HS7PK3},{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:FD:DC:76',bootMacAddress:'AA:BB:CC:F8:50:CA',machineName:lab00r750wkr8,rackSlot:11,serialNumber:9M56PK3}]" --tags key1="myvalue1" key2="myvalue2" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"

Create or update single rack cluster using json file input

az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-___location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --___location "eastus" --cluster-___location "Foo Street, 3rd Floor, row 9" --cluster-service-principal application-id="12345678-1234-1234-1234-123456789012" password="password" principal-id="00000008-0004-0004-0004-000000000012" tenant-id="80000000-4000-4000-4000-120000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90  --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --tags key1="myvalue1" key2="myvalue2

Create or update single rack cluster with user assigned identity, command output settings, and analytics output settings

az networkcloud cluster create --name "clusterName" -g "resourceGroupName" --extended-___location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --___location "eastus" --cluster-___location "Foo Street, 2nd Floor, row 9" --cluster-service-principal application-id="0000-000-0000-0000-0000-00000000" password="password" principal-id="00000000-0000-0000-0000-000000000000" tenant-id="00000000-0000-0000-0000-000000000000" --cluster-type "SingleRack" --cluster-version "3.0.0" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --network-fabric-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --tags key1="myvalue1" key2="myvalue2" --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container" --analytics-output-settings analytics-workspace-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"

Required Parameters

--aggregator-or-single-rack-definition

The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--cluster-name --name -n

The name of the cluster.

--cluster-type

The type of rack configuration for the cluster.

Property Value
Parameter group: Properties Arguments
Accepted values: MultiRack, SingleRack
--cluster-version

The current runtime version of the cluster.

Property Value
Parameter group: Properties Arguments
--extended-___location

The extended ___location of the cluster manager associated with the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: ClusterParameters Arguments
--network-fabric-id

The resource ID of the Network Fabric associated with the cluster.

Property Value
Parameter group: Properties Arguments
--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--analytics-output-settings --ao-settings

The settings for the log analytics workspace used for output of logs from this cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--cluster-___location

The customer-provided ___location information to identify where the cluster resides.

Property Value
Parameter group: Properties Arguments
--cluster-service-principal

The service principal to be used by the cluster during Arc Appliance installation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--co-settings --command-output-settings

The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--compute-deployment-threshold

The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--compute-rack-definitions

The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--___location -l

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

Property Value
Parameter group: ClusterParameters Arguments
--managed-resource-group-configuration --mrg

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

Property Value
Parameter group: Properties Arguments
--mi-system-assigned

Enable system assigned identity.

Property Value
Parameter group: Managed Identity Arguments
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.

Property Value
Parameter group: Managed Identity Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--runtime-protection

The settings for cluster runtime protection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--sa-settings --secret-archive-settings

The settings for the secret archive used to hold credentials for the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--tags

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

Property Value
Parameter group: ClusterParameters Arguments
--update-strategy

The strategy for updating the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--vs-settings --vulnerability-scanning-settings

The settings for how security vulnerability scanning is applied to the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az networkcloud cluster delete

Delete the provided cluster.

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

Examples

Delete cluster

az networkcloud cluster delete --name "clusterName" --resource-group "resourceGroupName"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--no-wait

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

Property Value
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>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster deploy

Deploy the cluster.

az networkcloud cluster deploy [--cluster-name --name]
                               [--ids]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--skip-validations-for-machines]
                               [--subscription]

Examples

Deploy cluster

az networkcloud cluster deploy --name "clusterName" --resource-group "resourceGroupName"

Deploy cluster skipping validation

az networkcloud cluster deploy --name "clusterName" --resource-group "resourceGroupName" --skip-validations-for-machines "bmmName1"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
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>.

Property Value
Parameter group: Resource Id Arguments
--skip-validations-for-machines

The names of bare metal machines in the cluster that should be skipped during environment validation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: ClusterDeployParameters Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster list

List clusters in the provided resource group or subscription.

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

Examples

List clusters for resource group

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

List clusters for subscription

az networkcloud cluster list

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az networkcloud cluster scan-runtime

Trigger the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

az networkcloud cluster scan-runtime [--cluster-name --name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--scan-activity {Scan, Skip}]
                                     [--subscription]

Examples

Execute a runtime protection scan on the cluster

az networkcloud cluster scan-runtime -n "clusterName" -g "resourceGroupName" --scan-activity "Scan"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
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>.

Property Value
Parameter group: Resource Id Arguments
--scan-activity

The choice of if the scan operation should run the scan.

Property Value
Parameter group: ClusterScanRuntimeParameters Arguments
Default value: Scan
Accepted values: Scan, Skip
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster show

Get properties of the provided cluster.

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

Examples

Get cluster

az networkcloud cluster show --name "clusterName" --resource-group "resourceGroupName"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster update

Update the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

az networkcloud cluster update [--aggregator-or-single-rack-definition]
                               [--analytics-output-settings --ao-settings]
                               [--cluster-___location]
                               [--cluster-name --name]
                               [--cluster-service-principal]
                               [--co-settings --command-output-settings]
                               [--compute-deployment-threshold]
                               [--compute-rack-definitions]
                               [--ids]
                               [--if-match]
                               [--if-none-match]
                               [--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}]
                               [--resource-group]
                               [--runtime-protection]
                               [--sa-settings --secret-archive-settings]
                               [--subscription]
                               [--tags]
                               [--update-strategy]
                               [--vs-settings --vulnerability-scanning-settings]

Examples

Patch cluster ___location

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --cluster-___location "Foo Street, 3rd Floor, row 9" --tags key1="myvalue1" key2="myvalue2"

Patch cluster aggregatorOrSingleRackDefinition

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName --aggregator-or-single-rack-definition "{networkRackId:'/subscriptions/subscriptionId/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/cmName/subnets/ClusterManagerSubnet',rackSkuId:'/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/VLab_Single_DellR750_8C2M_x70r3_9',rackSerialNumber:b99m99r1,rackLocation:b99m99r1,availabilityZone:1,storageApplianceConfigurationData:[{rackSlot:1,adminCredentials:{username:'adminuser',password:'password'},storageApplianceName:name,serialNumber:serial}],bareMetalMachineConfigurationData:[{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:DD:E7:08',bootMacAddress:'AA:BB:CC:F8:71:2E',machineName:lab00r750wkr1,rackSlot:2,serialNumber:5HS7PK3},{bmcCredentials:{password:'bmcPassword',username:'root'},bmcMacAddress:'AA:BB:CC:FD:DC:76',bootMacAddress:'AA:BB:CC:F8:50:CA',machineName:lab00r750wkr8,rackSlot:11,serialNumber:9M56PK3}]}" --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --tags key1="myvalue1" key2="myvalue2"

Patch cluster aggregatorOrSingleRackDefinition using json file input

az networkcloud cluster update --name "clusterName"  --resource-group "resourceGroupName" --aggregator-or-single-rack-definition ./aggregator-or-single-rack-definition.json --compute-deployment-threshold type="PercentSuccess" grouping="PerCluster" value=90 --tags key1="myvalue1" key2="myvalue2"

Patch cluster runtime protection configuration

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --runtime-protection enforcement-level="OnDemand"

Patch Vulnerability Settings

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --vulnerability-scanning-settings container-scan="Enabled"

Patch update strategy

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --update-strategy strategy-type="Rack" threshold-type="CountSuccess" threshold-value=4 max-unavailable=4 wait-time-minutes=10

Set user assigned identity (removes system assigned if was added earlier)

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

Set system assigned identity (removes user assigned if was added earlier)

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --mi-system-assigned

Set system assigned and user assigned identities to cluster

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

Patch secret archive settings (cluster identity is set prior)

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --secret-archive-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" vault_uri="https://keyvaultname.vault.azure.net/"

Patch command output settings (cluster identity is set prior)

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --command-output-settings identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI" container-url="https://myaccount.blob.core.windows.net/mycontainer?restype=container"

Patch log analytics output settings (cluster identity is set prior)

az networkcloud cluster update --name "clusterName" --resource-group "resourceGroupName" --analytics-output-settings analytics-workspace-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" identity-type="UserAssignedIdentity" identity-resource-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userIdentity"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--aggregator-or-single-rack-definition

The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--analytics-output-settings --ao-settings

The settings for the log analytics workspace used for output of logs from this cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--cluster-___location

The customer-provided ___location information to identify where the cluster resides.

Property Value
Parameter group: Properties Arguments
--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--cluster-service-principal

The service principal to be used by the cluster during Arc Appliance installation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--co-settings --command-output-settings

The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--compute-deployment-threshold

The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--compute-rack-definitions

The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--mi-system-assigned

Enable system assigned identity.

Property Value
Parameter group: Managed Identity Arguments
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.

Property Value
Parameter group: Managed Identity Arguments
--no-wait

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

Property Value
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>.

Property Value
Parameter group: Resource Id Arguments
--runtime-protection

The settings for cluster runtime protection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--sa-settings --secret-archive-settings

The settings for the secret archive used to hold credentials for the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

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

Property Value
Parameter group: ClusterUpdateParameters Arguments
--update-strategy

The strategy for updating the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--vs-settings --vulnerability-scanning-settings

The settings for how security vulnerability scanning is applied to the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster update-version

Update the version of the provided cluster to one of the available supported versions.

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

Examples

Update cluster version

az networkcloud cluster update-version --cluster-name "clusterName" --target-cluster-version "2.0" --resource-group "resourceGroupName"

Required Parameters

--target-cluster-version

The version to be applied to the cluster during update.

Property Value
Parameter group: ClusterUpdateVersionParameters Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
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>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az networkcloud cluster wait

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name --name -n

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False