az networkcloud cluster bmckeyset

Preview
Reference

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az networkcloud cluster bmckeyset 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 baseboard management controller key set.

Commands

Name	Description	Type	Status
az networkcloud cluster bmckeyset create	Create a new baseboard management controller key set or update the existing one for the provided cluster.	Extension	Preview
az networkcloud cluster bmckeyset delete	Delete the baseboard management controller key set of the provided cluster.	Extension	Preview
az networkcloud cluster bmckeyset list	List baseboard management controller key sets of the cluster.	Extension	Preview
az networkcloud cluster bmckeyset show	Get baseboard management controller key set of the provided cluster.	Extension	Preview
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	Preview
az networkcloud cluster bmckeyset wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az networkcloud cluster bmckeyset create

Preview

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

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

az networkcloud cluster bmckeyset create --azure-group-id
                                         --bmc-key-set-name
                                         --cluster-name
                                         --expiration
                                         --extended-location
                                         --privilege-level {Administrator, ReadOnly}
                                         --resource-group
                                         --user-list
                                         [--location]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]

Examples

Create or update baseboard management controller key set of cluster

az networkcloud cluster bmckeyset create --name "bmcKeySetName" --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" --privilege-level "Administrator" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDWtG2RiEGfXs+RK19HU/G8EdEnbTlkl8Kkb5xv6nm+ttTb9FrW/dc9RQvai24VEFJmG4Fmi6Ow/yjxq+jTDuWOSs+Lo= 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.

--bmc-key-set-name --name -n

The name of the baseboard management controller 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 baseboard management controllers.

--extended-location

The extended location of the cluster associated with the resource. 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: Administrator, ReadOnly

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

--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 bmckeyset delete

Preview

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

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

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

Examples

Delete baseboard management controller key set of cluster

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

Optional Parameters

--bmc-key-set-name --name -n

The name of the baseboard management controller 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 bmckeyset list

Preview

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

List baseboard management controller key sets of the cluster.

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

Examples

List baseboard management controller key sets of the cluster

az networkcloud cluster bmckeyset 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 bmckeyset show

Preview

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

Get baseboard management controller key set of the provided cluster.

az networkcloud cluster bmckeyset show [--bmc-key-set-name]
                                       [--cluster-name]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]

Examples

Get baseboard management controller key set of cluster

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

Optional Parameters

--bmc-key-set-name --name -n

The name of the baseboard management controller key set.

--cluster-name

The name of the cluster.

--ids

--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 bmckeyset update

Preview

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

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.

az networkcloud cluster bmckeyset update [--bmc-key-set-name]
                                         [--cluster-name]
                                         [--expiration]
                                         [--ids]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--tags]
                                         [--user-list]

Examples

Patch baseboard management controller key set of cluster

az networkcloud cluster bmckeyset update --name "bmcKeySetName" --expiration "2022-12-31T23:59:59.008Z" --user-list "[{description:'User description',azureUserName:userABC,userPrincipalName:'userABC@myorg.com',sshPublicKey:{keyData:'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDWtG2RiEGfXs+RK19HU/G8EdEnbTlkl8Kkb5xv6nm+ttTb9FrW/dc9RQvai24VEFJmG4Fmi6Ow/yjxq+jTDuWOSs+LovQpOKm9D8p05JcIOpdCPGA5S+dWIVL+a9jsQmzBbWYx= admin@vm'}}]" --tags key1="myvalue1" key2="myvalue2" --cluster-name "clusterName" --resource-group "resourceGroupName"

Optional Parameters

--bmc-key-set-name --name -n

The name of the baseboard management controller 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 baseboard management controllers.

--ids

--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 bmckeyset 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 bmckeyset wait [--bmc-key-set-name]
                                       [--cluster-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

--bmc-key-set-name --name -n

The name of the baseboard management controller 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

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

Share via

az networkcloud cluster bmckeyset

Commands

az networkcloud cluster bmckeyset create

Examples

Required Parameters

Optional Parameters

az networkcloud cluster bmckeyset delete

Examples

Optional Parameters

az networkcloud cluster bmckeyset list

Examples

Required Parameters

Optional Parameters

az networkcloud cluster bmckeyset show

Examples

Optional Parameters

az networkcloud cluster bmckeyset update

Examples

Optional Parameters

az networkcloud cluster bmckeyset wait

Optional Parameters

Additional resources