azdata extension
Applies to:
Azure Data CLI (azdata
)
The following article provides reference for the sql commands in the azdata tool. For more information about other azdata commands, see azdata reference
Commands
Command | Description |
---|---|
azdata extension add | Add an extension. |
azdata extension remove | Remove an extension. |
azdata extension list | List all installed extensions. |
azdata extension add
Add an extension.
azdata extension add --source -s
[--index]
[--pip-proxy]
[--pip-extra-index-urls]
[--yes -y]
Examples
Add extension from URL.
azdata extension add --source https://contoso.com/some_ext-0.0.1-py2.py3-none-any.whl
Add extension from local disk.
azdata extension add --source ~/some_ext-0.0.1-py2.py3-none-any.whl
Add extension from local disk and use pip proxy for dependencies.
azdata extension add --source ~/some_ext-0.0.1-py2.py3-none-any.whl --pip-proxy https://user:pass@proxy.server:8080
Required Parameters
--source -s
Path to a extension wheel on disk or URL to an extension
Optional Parameters
--index
Base URL of the Python Package Index (default https://pypi.org/simple). This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.
--pip-proxy
Proxy for pip to use for extension dependencies in the form of [user:passwd@]proxy.server:port
--pip-extra-index-urls
Space-separated list of extra URLs of package indexes to use. This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format.
--yes -y
Do not prompt for confirmation.
Global Arguments
--debug
Increase logging verbosity to show all debug logs.
--help -h
Show this help message and exit.
--output -o
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query -q
JMESPath query string. See http://jmespath.org/ for more information and examples.
--verbose
Increase logging verbosity. Use --debug for full debug logs.
azdata extension remove
Remove an extension.
azdata extension remove --name -n
[--yes -y]
Examples
Remove an extension.
azdata extension remove --name some-ext
Required Parameters
--name -n
Name of the extension
Optional Parameters
--yes -y
Do not prompt for confirmation.
Global Arguments
--debug
Increase logging verbosity to show all debug logs.
--help -h
Show this help message and exit.
--output -o
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query -q
JMESPath query string. See http://jmespath.org/ for more information and examples.
--verbose
Increase logging verbosity. Use --debug for full debug logs.
azdata extension list
List all installed extensions.
azdata extension list
Examples
List extensions.
azdata extension list
Global Arguments
--debug
Increase logging verbosity to show all debug logs.
--help -h
Show this help message and exit.
--output -o
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
--query -q
JMESPath query string. See http://jmespath.org/ for more information and examples.
--verbose
Increase logging verbosity. Use --debug for full debug logs.
Next steps
For more information about other azdata commands, see azdata reference.
For more information about how to install the azdata tool, see Install azdata.