az networkcloud cluster baremetalmachinekeyset
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.51.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
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 "resourceGroupNameRequired Parameters
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.
The name of the bare metal machine key set.
The name of the cluster.
The date and time after which the users in this key set will be removed from the bare metal machines.
The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
The access level allowed for the users in this key set.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The unique list of permitted users. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Optional Parameters
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
The name of the group that users will be assigned to on the operating system of the machines.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster baremetalmachinekeyset delete
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 "resourceGroupNameOptional Parameters
The name of the bare metal machine key set.
The name of the cluster.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster baremetalmachinekeyset list
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
The name of the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster baremetalmachinekeyset show
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 "resourceGroupNameOptional Parameters
The name of the bare metal machine key set.
The name of the cluster.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster baremetalmachinekeyset update
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
The name of the bare metal machine key set.
The name of the cluster.
The date and time after which the users in this key set will be removed from the bare metal machines.
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.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The unique list of permitted users. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud cluster baremetalmachinekeyset wait
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
The name of the bare metal machine key set.
The name of the cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for