Share via

az hdinsight-on-aks cluster library

  • Preview
  • Reference

Note

This reference is part of the hdinsightonaks extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az hdinsight-on-aks cluster library command. Learn more about extensions.

Command group 'az hdinsight-on-aks cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage the library of the cluster.

Commands

Name Description Type Status
az hdinsight-on-aks cluster library list

List all libraries of HDInsight on AKS cluster.

 Extension Preview
az hdinsight-on-aks cluster library manage

Library management operations on HDInsight on AKS cluster.

 Extension Preview

az hdinsight-on-aks cluster library list

Preview

Command group 'az hdinsight-on-aks cluster library' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all libraries of HDInsight on AKS cluster.

az hdinsight-on-aks cluster library list --category {custom, predefined}
                                         --cluster-name
                                         --cluster-pool-name
                                         --resource-group
                                         [--max-items]
                                         [--next-token]

Examples

List all custom libraries on the cluster.

az hdinsight-on-aks cluster library list --cluster-name {clustername} -g {resourcesGroup} --cluster-pool-name {clusterpoolname} --debug --category custom

List all predefined libraries on the cluster.

az hdinsight-on-aks cluster library list --cluster-name {clustername} -g {resourcesGroup} --cluster-pool-name {clusterpoolname} --debug --category predefined

Required Parameters

--category

The system query option to filter libraries returned in the response. Allowed value is 'custom' or 'predefined'.

Accepted values: custom, predefined
--cluster-name

The name of the HDInsight cluster.

--cluster-pool-name

The name of the cluster pool.

--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 hdinsight-on-aks cluster library manage

Preview

Command group 'az hdinsight-on-aks cluster library' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Library management operations on HDInsight on AKS cluster.

az hdinsight-on-aks cluster library manage --action {Install, Uninstall}
                                           --libraries
                                           [--cluster-name]
                                           [--cluster-pool-name]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]

Examples

Install maven library 'azure-resourcemanager-hdinsight-containers' to the cluster.

az hdinsight-on-aks cluster library manage --cluster-name {clustername} -g {resourcesGroup} --cluster-pool-name {clusterpoolname} --action install --libraries '[{maven:{group-id:com.azure.resourcemanager,name:azure-resourcemanager-hdinsight-containers,version:1.0.0-beta.2}}]'

Uninstall library 'azure-resourcemanager-hdinsight-containers' from the cluster.

az hdinsight-on-aks cluster library manage --cluster-name {clustername} -g {resourcesGroup} --cluster-pool-name {clusterpoolname} --action uninstall --libraries '[{maven:{group-id:com.azure.resourcemanager,name:azure-resourcemanager-hdinsight-containers,version:1.0.0-beta.2}}]'

Install pypi library 'Pandas' to the cluster.

az hdinsight-on-aks cluster library manage --cluster-name {clustername} -g {resourcesGroup} --cluster-pool-name {clusterpoolname} --action install --libraries '[{pypi:{name:pandas}}]'

Required Parameters

--action

The library management action.

Accepted values: Install, Uninstall
--libraries

The libraries to be installed/updated/uninstalled. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--cluster-name

The name of the HDInsight cluster.

--cluster-pool-name

The name of the cluster pool.

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

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.