Share via

az networkcloud cluster baremetalmachinekeyset

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

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 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 baremetalmachinekeyset create

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 --name
                                                      --cluster-name
                                                      --expiration
                                                      --extended-location
                                                      --jump-hosts-allowed
                                                      --privilege-level {Standard, Superuser}
                                                      --resource-group
                                                      --user-list
                                                      [--if-match]
                                                      [--if-none-match]
                                                      [--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 "MicrosoftEntraGroupObjectId" --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.

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

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

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

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

Property Value
Parameter group: Properties Arguments
--privilege-level

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

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

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

--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: BareMetalMachineKeySetParameters 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
--os-group-name

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

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: BareMetalMachineKeySetParameters 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 baremetalmachinekeyset delete

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

az networkcloud cluster baremetalmachinekeyset delete [--bare-metal-machine-key-set-name --name]
                                                      [--cluster-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 bare metal machine key set of cluster

az networkcloud cluster baremetalmachinekeyset delete --name "bareMetalMachineKeySetName" --cluster-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.

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

The name of the bare metal machine key set.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

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

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

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

Get bare metal machine key set of the provided cluster.

az networkcloud cluster baremetalmachinekeyset show [--bare-metal-machine-key-set-name --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

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

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

The name of the bare metal machine key set.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

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

az networkcloud cluster baremetalmachinekeyset update [--bare-metal-machine-key-set-name --name]
                                                      [--cluster-name]
                                                      [--expiration]
                                                      [--ids]
                                                      [--if-match]
                                                      [--if-none-match]
                                                      [--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

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

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

The name of the bare metal machine key set.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--expiration

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

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.

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

Property Value
Parameter group: Properties 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
--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: BareMetalMachineKeySetUpdateParameters Arguments
--user-list

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

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

az networkcloud cluster baremetalmachinekeyset wait [--bare-metal-machine-key-set-name --name]
                                                    [--cluster-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.

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

The name of the bare metal machine key set.

Property Value
Parameter group: Resource Id Arguments
--cluster-name

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