Share via

az networkcloud cluster baremetalmachinekeyset

  • Preview
  • 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 cluster baremetalmachinekeyset command. Learn more about extensions.

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage cluster's bare metal machine key set.

Commands

Name Description Type Status
az networkcloud cluster baremetalmachinekeyset create

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

 Extension Preview
az networkcloud cluster baremetalmachinekeyset delete

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

 Extension Preview
az networkcloud cluster baremetalmachinekeyset list

List bare metal machine key sets of the cluster.

 Extension Preview
az networkcloud cluster baremetalmachinekeyset show

Get bare metal machine key set of the provided cluster.

 Extension Preview
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 Preview
az networkcloud cluster baremetalmachinekeyset wait

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

 Extension Preview

az networkcloud cluster baremetalmachinekeyset create

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az networkcloud cluster baremetalmachinekeyset create --azure-group-id
                                                      --bare-metal-machine-key-set-name
                                                      --cluster-name
                                                      --expiration
                                                      --extended-location
                                                      --jump-hosts-allowed
                                                      --privilege-level {Standard, Superuser}
                                                      --resource-group
                                                      --user-list
                                                      [--location]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--os-group-name]
                                                      [--tags]

Examples

Create or update bare metal machine key set of cluster

az networkcloud cluster baremetalmachinekeyset create --name "bareMetalMachineKeySetName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --azure-group-id "f110271b-XXXX-4163-9b99-214d91660f0e" --expiration "2022-12-31T23:59:59.008Z" --jump-hosts-allowed "192.0.2.1" "192.0.2.5" --os-group-name "standardAccessGroup" --privilege-level "Standard" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDWtG2RiEGfXs+RK19UmovAJiIVUbT6YaYc/t5SjWU=admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName

Required Parameters

--azure-group-id

The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.

--bare-metal-machine-key-set-name --name -n

The name of the bare metal machine key set.

--cluster-name

The name of the cluster.

--expiration

The date and time after which the users in this key set will be removed from the bare metal machines.

--extended-location

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

--jump-hosts-allowed

The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--privilege-level

The access level allowed for the users in this key set.

Accepted values: Standard, Superuser
--resource-group -g

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

--user-list

The unique list of permitted users. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--location -l

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

--no-wait

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

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

The name of the group that users will be assigned to on the operating system of the machines.

--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 cluster baremetalmachinekeyset delete

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az networkcloud cluster baremetalmachinekeyset delete [--bare-metal-machine-key-set-name]
                                                      [--cluster-name]
                                                      [--ids]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--yes]

Examples

Delete bare metal machine key set of cluster

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

Optional Parameters

--bare-metal-machine-key-set-name --name -n

The name of the bare metal machine key set.

--cluster-name

The name of the cluster.

--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 cluster baremetalmachinekeyset list

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List bare metal machine key sets of the cluster.

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

Examples

List bare metal machine key sets of the cluster

az networkcloud cluster baremetalmachinekeyset list --cluster-name "clusterName" --resource-group "resourceGroupName"

Required Parameters

--cluster-name

The name of the cluster.

--resource-group -g

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

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.

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 cluster baremetalmachinekeyset show

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get bare metal machine key set of the provided cluster.

az networkcloud cluster baremetalmachinekeyset show [--bare-metal-machine-key-set-name]
                                                    [--cluster-name]
                                                    [--ids]
                                                    [--resource-group]
                                                    [--subscription]

Examples

Get bare metal machine key set of cluster

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

Optional Parameters

--bare-metal-machine-key-set-name --name -n

The name of the bare metal machine key set.

--cluster-name

The name of the cluster.

--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 cluster baremetalmachinekeyset update

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

az networkcloud cluster baremetalmachinekeyset update [--bare-metal-machine-key-set-name]
                                                      [--cluster-name]
                                                      [--expiration]
                                                      [--ids]
                                                      [--jump-hosts-allowed]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--tags]
                                                      [--user-list]

Examples

Patch bare metal machine key set of cluster

az networkcloud cluster baremetalmachinekeyset update --name "bareMetalMachineKeySetName" --expiration "2022-12-31T23:59:59.008Z" --jump-hosts-allowed "192.0.2.1" "192.0.2.5" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+/ojNZfpB3af/YDzwQCZzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName"

Optional Parameters

--bare-metal-machine-key-set-name --name -n

The name of the bare metal machine key set.

--cluster-name

The name of the cluster.

--expiration

The date and time after which the users in this key set will be removed from the bare metal machines.

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

--jump-hosts-allowed

The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. 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
--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.

--user-list

The unique list of permitted users. 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 cluster baremetalmachinekeyset wait

Preview

Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az networkcloud cluster baremetalmachinekeyset wait [--bare-metal-machine-key-set-name]
                                                    [--cluster-name]
                                                    [--created]
                                                    [--custom]
                                                    [--deleted]
                                                    [--exists]
                                                    [--ids]
                                                    [--interval]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--timeout]
                                                    [--updated]

Optional Parameters

--bare-metal-machine-key-set-name --name -n

The name of the bare metal machine key set.

--cluster-name

The name of the cluster.

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