azdata app template

Applies to: Azure Data CLI (azdata)

Note

Some scenarios previously handled by the Azure Data CLI (azdata) are now managed through Azure CLI (az) extensions and Azure Arc-based workflows. There is no single 1:1 replacement for all azdata commands. The following table highlights commonly related Azure CLI alternatives where they exist.

azdata command area	Azure CLI extension / command group	Azure CLI reference
azdata arc dc *	az arcdata	Azure Arc data CLI reference
azdata arc sql mi *	az arcdata sql mi	Manage Azure SQL Managed Instance with CLI
azdata arc postgres *	az arcdata postgres	Manage PostgreSQL server with CLI
azdata migrate *	az datamigration	Migrate using CLI
azdata extension *	az extension *	Azure CLI extensions overview
azdata login	az login	az login
azdata sql shell / azdata sql query	No Azure CLI equivalent (use sqlcmd, SSMS, or other SQL tools)	sqlcmd utility SQL Server Management Studio

For new automation and management scenarios, prefer Azure CLI (az), Azure CLI extensions, and Azure Arc portal experiences.

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 app template list	Fetch supported templates.
azdata app template pull	Download supported templates.

azdata app template list

Fetch supported templates under the specified [URL] github repository.

azdata app template list [--url -u] 
                         

Examples

Fetch all templates under the default template repository location.

azdata app template list

Fetch all templates under a different repository location.

azdata app template list --url https://github.com/diffrent/templates.git

Optional Parameters

--url -u

Specify a different template repository location. Default: https://github.com/Microsoft/SQLBDC-AppDeploy.git

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 app template pull

Download supported templates under the specified [URL] github repository.

azdata app template pull [--name -n] 
                         [--url -u]  
                         
[--destination -d]

Examples

Download all templates under the default template repository location.

azdata app template pull

Download all templates under a different repository location.

azdata app template list --url https://github.com/diffrent/templates.git

Download individual template by name.

azdata app template pull --name ssis            

Optional Parameters

--name -n

Template name. For a full list off supported template names, run azdata app template list

--url -u

Specify a different template repository location. Default: https://github.com/Microsoft/SQLBDC-AppDeploy.git

--destination -d

Where to place the application skeleton template. ./templates

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.