Command Line Reference

Peter Taylor edited this page Sep 6, 2017 · 5 revisions
Clone this wiki locally

The Azure Building Blocks command line tool accepts the following options:

Option                                                                     Description
-V, --version Outputs the current version of the Azure Building Blocks command line.
-g, --resource-group <resource-group> Name of the default resource group all resources will be deployed to. Note that you can either specify the default resource group by using this option OR by specifying the resource group for each Azure Building Block section in your parameter file, but not both. See specify and override default subscription ID, resource group, or location for more information.
-p, --parameters-file <parameters-file> Local path to a valid parameter file. See create an Azure Building Blocks parameter file for more information.
-o, --output-file <output-file> If you want to save the JSON output of the command line tool, specify a file name with path.
-s, --subscription-id <subscription-id> The default Azure subscription ID that includes the resource group the resources will be deployed to. Note that you can either specify the default subscription ID by using this option OR by specifying the default subscription ID for each Template Building block section in your parameter file, but not both. See specify and override default subscription ID, resource group, or location for more information.
-l, --location <location> The default Azure region all resources will be deployed to. Note that you can either specify the default location by using this option OR by specifying the default location for each Template Building Block section in you parameter, but not both. See specify and override default subscription ID, resource group, or location for more information.
-d, --defaults-directory <defaults-directory> Path to directory containing default parameter values.
--json Display the JSON output of the command line tool in the console window.
--deploy Deploy the resources specfied in the parameter file using the Azure command line interface 2.0.
-t, --template-base-uri <template-base-uri> URI where the Template Building Blocks template files are stored.
-k, --sas-token <sas-token> If you are using an Azure storage account to store the Template Building Block templates, specify the shared access signature (SAS) access key for the container. See secure the files used by the Template Building Block command line tool for more information.
-c, --cloud, <cloud> If you are deploying to a registered Azure cloud, specify the name. Use the az cloud list command for a list of valid names.
-h, --help Output the list of options.