az akshybrid

Preview
Reference

Note

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

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage provisioned clusters.

Commands

Name	Description	Type	Status
az akshybrid create	Creates the provisioned cluster.	Extension	Preview
az akshybrid delete	Deletes the provisioned cluster.	Extension	Preview
az akshybrid get-credentials	Get local kubeconfig of the provisioned cluster.	Extension	Preview
az akshybrid get-upgrades	Get the upgrade versions available for the provisioned cluster.	Extension	Preview
az akshybrid get-versions	List the supported Kubernetes versions in the specified custom location.	Extension	Preview
az akshybrid nodepool	Manage nodepools in a provisioned cluster.	Extension	Preview
az akshybrid nodepool add	Adds a nodepool in the provisioned cluster.	Extension	Preview
az akshybrid nodepool delete	Deletes the nodepool in the provisioned cluster.	Extension	Preview
az akshybrid nodepool list	Lists all the nodepools in the provisioned cluster.	Extension	Preview
az akshybrid nodepool scale	Scales the nodepool in the provisioned cluster .	Extension	Preview
az akshybrid nodepool show	Gets the nodepool in the provisioned cluster.	Extension	Preview
az akshybrid notice	Output NOTICE file to user specified filepath.	Extension	Preview
az akshybrid show	Gets the provisioned cluster.	Extension	Preview
az akshybrid update	Updates the provisioned cluster.	Extension	Preview
az akshybrid upgrade	Upgrades the provisioned cluster.	Extension	Preview
az akshybrid vmsize	Manage virtual machine SKUs for akshybrid.	Extension	Preview
az akshybrid vmsize list	Lists the supported virtual machine sizes in the specified custom location.	Extension	Preview
az akshybrid vnet	Manage virtual networks for provisioned clusters.	Extension	Preview
az akshybrid vnet create	Creates the virtual network.	Extension	Preview
az akshybrid vnet delete	Deletes the virtual network.	Extension	Preview
az akshybrid vnet list	Lists the virtual networks by resource group or subscription.	Extension	Preview
az akshybrid vnet show	Gets the virtual network.	Extension	Preview

az akshybrid create

Preview

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

Creates the provisioned cluster.

az akshybrid create --custom-location
                    --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--arc-agent-auto-upgrade]
                    [--arc-agent-version]
                    [--control-plane-count]
                    [--control-plane-ip]
                    [--control-plane-vm-size]
                    [--generate-ssh-keys]
                    [--kubernetes-version]
                    [--load-balancer-count]
                    [--location]
                    [--no-ssh-key]
                    [--no-wait]
                    [--node-count]
                    [--node-vm-size]
                    [--pod-cidr]
                    [--ssh-key-value]
                    [--tags]
                    [--vnet-ids]

Examples

PutProvisionedCluster

az akshybrid create -g sample-rg --custom-location sample-cl -n sample-akshybridcluster --vnet-id vnet1

Required Parameters

--custom-location

Name or ID of the custom location to use for the provisioned cluster.

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--aad-admin-group-object-ids -i

Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.

--arc-agent-auto-upgrade

Arc Agent Auto Upgrade.

Default value: Enabled

--arc-agent-version

Arc Agent Version.

--control-plane-count

Number of control plane nodes.

--control-plane-ip

API server IP Address for the control plane.

--control-plane-vm-size

VM Size of control plane.

--generate-ssh-keys

Generate ssh key-pair if not present.

Default value: False

--kubernetes-version -k

The kubernetes version of the provisioned cluster.

--load-balancer-count

Number of load balancer nodes.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-ssh-key -x

Do not use inject any public ssh key.

Default value: False

--no-wait

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

Default value: False

--node-count -c

Number of nodes to be created in the nodepool.

--node-vm-size

VM Size of the nodes in the nodepool.

--pod-cidr

The CIDR notation IP ranges from which to assign pod IPs.

--ssh-key-value

Path to the ssh public key to be injected into the control plane.

Default value: ~\.ssh\id_rsa.pub

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--vnet-ids

ARM resource ID(s) of the VNets.

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

Preview

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

Deletes the provisioned cluster.

az akshybrid delete --name
                    --resource-group
                    [--no-wait]
                    [--yes]

Examples

DeleteProvisionedCluster

az akshybrid delete --name "sample-akshybridcluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False

--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 akshybrid get-credentials

Preview

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

Get local kubeconfig of the provisioned cluster.

az akshybrid get-credentials --name
                             --resource-group
                             [--admin]
                             [--context]
                             [--file]
                             [--overwrite-existing]

Examples

GetAdminCredential

az akshybrid get-credentials --name "sample-akshybridcluster" --resource-group "sample-rg" --admin

GetAADUserCredential

az akshybrid get-credentials --name "sample-akshybridcluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--admin -a

Get cluster administrator credentials.

Default value: False

--context

If specified, overwrite the default context name.

--file -f

Kubernetes configuration file to update. If not provided, updates the file '~/.kube/config'.

Default value: ~\.kube\config

--overwrite-existing

Overwrite any existing cluster entry with the same name.

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 akshybrid get-upgrades

Preview

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

Get the upgrade versions available for the provisioned cluster.

az akshybrid get-upgrades --name
                          --resource-group

Examples

Get the upgrade versions available for the Hybrid AKS provisioned cluster

az akshybrid get-upgrades --name "samplecluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

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

--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 akshybrid get-versions

Preview

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

List the supported Kubernetes versions in the specified custom location.

az akshybrid get-versions --custom-location
                          --resource-group

Examples

VMListSkus

az akshybrid get-versions -g sample-rg --custom-location sample-cl

Required Parameters

--custom-location

Name of the custom location to use for displaying the supported k8s versions.

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

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

Preview

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

Output NOTICE file to user specified filepath.

az akshybrid notice --output-filepath

Examples

GetNoticeFile

az akshybrid notice --output-filepath "./Notice"

Required Parameters

--output-filepath

Output filepath for NOTICE file.

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

Preview

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

Gets the provisioned cluster.

az akshybrid show --name
                  --resource-group

Examples

GetProvisionedCluster

az akshybrid show --name "sample-akshybridcluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

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

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

Preview

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

Updates the provisioned cluster.

az akshybrid update --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--tags]

Examples

UpdateProvisionedCluster

az akshybrid update --tags additionalProperties="sample" --name "sample-akshybridcluster" --resource-group "sample-rg"

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--aad-admin-group-object-ids -i

Comma-separated list of aad group object IDs that will be set as cluster admin on the provisioned cluster.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

Preview

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

Upgrades the provisioned cluster.

az akshybrid upgrade --name
                     --resource-group
                     [--kubernetes-version]
                     [--no-wait]
                     [--node-image-only]
                     [--yes]

Examples

UpgradeProvisionedCluster

az akshybrid upgrade --name "sample-akshybridcluster" --resource-group "sample-rg" --kubernetes-version v1.22.2

UpgradeProvisionedClusterNodeImage

az akshybrid upgrade --name "sample-akshybridcluster" --resource-group "sample-rg" --node-image-only

Required Parameters

--name -n

Name of the provisioned cluster.

--resource-group -g

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

Optional Parameters

--kubernetes-version -k

The kubernetes version of the provisioned cluster.

--no-wait

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

Default value: False

--node-image-only

Flag to upgrade only the node image.

Default value: False

--yes

Flag to disable confirmation prompts.

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 akshybrid

Commands

az akshybrid create

Examples

Required Parameters

Optional Parameters

az akshybrid delete

Examples

Required Parameters

Optional Parameters

az akshybrid get-credentials

Examples

Required Parameters

Optional Parameters

az akshybrid get-upgrades

Examples

Required Parameters

az akshybrid get-versions

Examples

Required Parameters

az akshybrid notice

Examples

Required Parameters

az akshybrid show

Examples

Required Parameters

az akshybrid update

Examples

Required Parameters

Optional Parameters

az akshybrid upgrade

Examples

Required Parameters

Optional Parameters

משאבים נוספים