Update plugins.arm.json

Update plugins.arm.json

output the application version

help

Display help for a given command

use verbose output

more verbose with debug output

use json output

login

Log in to an Azure subscription using Active Directory. Currently, the user can login only via Microsoft organizational account

use verbose output

more verbose with debug output

use json output

user name or service principal ID, will prompt if not given

Environment to authenticate against, must support active directory

user password or service principal key, will prompt if not given

If given, log in as a service principal rather than a user

Tenant domain or ID to log into. Used for login as service principal or parnter user

do not prompt for confirmation of PII storage

logout

Log out from Azure subscription using Active Directory. Currently, the user can log out only via Microsoft organizational account

use verbose output

more verbose with debug output

use json output

Required. User name used to log out from Azure Active Directory.

portal

Open the portal in a browser

use verbose output

more verbose with debug output

use json output

the publish settings download environment

the organization's realm

account

Commands to manage your account information and publish settings

list

List the imported subscriptions

use verbose output

more verbose with debug output

use json output

show

Show details about a subscription

use verbose output

more verbose with debug output

use json output

The subscription to show

Show extra information about the subscription

set

Set the current subscription

use verbose output

more verbose with debug output

use json output

clear

Remove a subscription or environment, or clear all of the stored account and environment info

use verbose output

more verbose with debug output

use json output

Subscription name or id to remove

Environment name to remove

quiet mode, do not ask for delete confirmation

env

Commands to manage your account environment

list

List the environments

use verbose output

more verbose with debug output

use json output

show

Show an environment

use verbose output

more verbose with debug output

use json output

the environment name

add

Add an environment

use verbose output

more verbose with debug output

use json output

the environment name

the management portal URL

the Active Directory api version

the management service endpoint

the resource management endpoint

the sql server management endpoint for mobile commands

the dns suffix for sql servers

the publish settings file URL

The resource ID to obtain AD tokens for

the Active Directory common tenant name

the template gallery endpoint

the Active Directory resource ID

the Active Directory login endpoint

set

Update an environment

use verbose output

more verbose with debug output

use json output

the environment name

the management portal URL

the Active Directory login endpoint

the management service endpoint

the resource management endpoint

the dns suffix for sql servers

the Active Directory api version

The resource ID to obtain AD tokens for

the Active Directory common tenant name

the template gallery endpoint

the Active Directory resource ID

the publish settings file URL

delete

Delete an environment

use verbose output

more verbose with debug output

use json output

the environment name

config

Commands to manage your local settings

list

List config settings

use verbose output

more verbose with debug output

use json output

delete

Delete a config setting

use verbose output

more verbose with debug output

use json output

set

Update a config setting

use verbose output

more verbose with debug output

use json output

mode

Sets the cli working mode, valid names are 'arm' for resource manager and 'asm' for service management

use verbose output

more verbose with debug output

use json output

storage

Commands to manage your Storage objects

account

Commands to manage your Storage accounts

list

List storage accounts

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

show

Show a storage account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

create

Create a storage account

use verbose output

more verbose with debug output

use json output

the location

the account type(LRS/ZRS/GRS/RAGRS/PLRS)

the resource group name

the subscription id

set

Update a storage account

use verbose output

more verbose with debug output

use json output

the account type(LRS/GRS/RAGRS)

the resource group name

the subscription id

delete

Delete a storage account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

keys

Commands to manage your Storage account keys

list

List the keys for a storage account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

renew

Renew a key for a storage account from your account

use verbose output

more verbose with debug output

use json output

Update the primary key

Update the secondary key

the resource group name

the subscription id

connectionstring

Commands to show your Storage connection string

show

Show the connection string for your account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

Use http as default endpoints protocol

the blob endpoint

the queue endpoint

the table endpoint

the file endpoint

container

Commands to manage your Storage containers

list

List storage containers with wildcard

use verbose output

use json output

the storage container name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the specified storage container

use verbose output

use json output

the storage container name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

create

Create a storage container

use verbose output

use json output

the storage container name

the storage container ACL permission(Off/Blob/Container)

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage container

use verbose output

use json output

the storage container name

remove the specified Storage container without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set storage container ACL

use verbose output

use json output

the storage container name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage container

create

Generate shared access signature of storage container

[options] [container] [permissions] [expiry]

use verbose output

use json output

the storage container name

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage container

create

Create a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the container

use verbose output

use json output

the storage container name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

blob

Commands to manage your Storage blobs

list

List storage blob in the specified storage container use wildcard and blob name prefix

use verbose output

use json output

the storage container name

the blob name prefix

the shared access signature of the storage container

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the specified storage blob

use verbose output

use json output

the storage container name

the storage blob name

the shared access signature of the storage container or blob

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage blob

use verbose output

use json output

the storage container name

the storage blob name

remove the specified Storage blob without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

upload

Upload the specified file to storage blob

use verbose output

use json output

the local file path

the storage container name

the storage blob name

the storage blob type(block, page, append)

the storage blob properties for uploaded file. Properties are key=value pairs and separated with semicolon(;). Available properties are contentType, contentEncoding, contentLanguage, cacheControl

the storage blob metadata for uploaded file. Metadata are key=value pairs and separated with semicolon(;)

the maximum number of concurrent upload requests

overwrite the specified Storage blob without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

download

Download the specified storage blob

[options] [container] [blob] [destination]

use verbose output

use json output

the storage container name

the storage blob name

download destination file or directory path

check md5sum for the downloaded file

the maximum number of concurrent download requests

overwrite the destination file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

copy

Commands to manage your blob copy operations

start

Start to copy the resource to the specified storage blob which completes asynchronously

use verbose output

use json output

the shared access signature of the source storage

the source storage blob or file absolute uri

the source storage container name

the source storage blob name

the destination storage account name

the destination storage account key

the destination storage connection string

the shared access signature of the destination storage container or blob

the destination storage container name

the destination storage blob name

overwrite the destination blob without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show the copy status

use verbose output

use json output

the destination container in the blob copy start operation

the destination blob in the blob copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

stop

Stop the copy operation

use verbose output

use json output

the copy ID which is returned from blob copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signature of your Storage blob

create

Generate shared access signature of storage blob

[options] [container] [blob] [permissions] [expiry]

use verbose output

use json output

the storage container name

the storage blob name

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

share

Commands to manage your Storage file shares

create

Create a storage file share

use verbose output

use json output

the storage file share name

the storage file share quota (in GB)

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the storage file share

use verbose output

use json output

the storage file share name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set properties of the storage file share

use verbose output

use json output

the storage file share name

the storage file share quota (in GB)

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage file share

use verbose output

use json output

the storage file share name

remove the specified storage file share without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List storage shares with prefix

use verbose output

use json output

the storage share name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage file shares

create

Generate shared access signature of storage share

[options] [share] [permissions] [expiry]

use verbose output

use json output

the storage share name

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage file share

create

Create a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the share

use verbose output

use json output

the storage share name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

file

Commands to manage your Storage files

list

List storage files in the specified share under specific path

use verbose output

use json output

the storage share name

the path to be listed

the shared access signature of the storage file share

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage file

use verbose output

use json output

the storage share name

the path to the storage file

remove the specified storage file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

upload

Upload the specified local file to storage

use verbose output

use json output

the local file path

the storage share name

the path to the storage file

the maximum number of concurrent upload requests

overwrite the specified storage file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

download

Download the specified storage file

use verbose output

use json output

the storage share name

the path to the storage file

path to the destination file or directory

check md5sum for the downloaded file

overwrite the destination file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

copy

Commands to manage your file copy operations

start

Start to copy the resource to the specified storage file which completes asynchronously

use verbose output

use json output

the shared access signature of the source storage

the source storage blob or file absolute uri

the source storage share name

the source storage file path

the destination storage account name

the destination storage account key

the destination storage connection string

the shared access signature of the destination storage share or file

the destination storage share name

the destination storage file path

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show the copy status

use verbose output

use json output

the destination share in the file copy start operation

the destination file path in the file copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

stop

Stop the copy operation

use verbose output

use json output

the copy ID which is returned from file copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage file

create

Generate shared access signature of storage file

[options] [share] [path] [permissions] [expiry]

use verbose output

use json output

the storage share name

the path to the storage file

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

directory

Commands to manage your Storage file directory

create

Create a storage file directory

use verbose output

use json output

the storage file share name

the path to the storage file directory to be created

the shared access signature of the storage file share

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage file directory

use verbose output

use json output

the storage share name

the path to the storage file directory to be deleted

remove the specified storage file directory without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

queue

Commands to manage your Storage queues

create

Create a storage queue

use verbose output

use json output

the storage queue name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List storage queues with wildcard

use verbose output

use json output

the storage queue name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the storage able

use verbose output

use json output

the storage queue name

the shared access signature of the storage queue

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage queue

use verbose output

use json output

the storage queue name

remove the specified storage queue without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage queue

create

Generate shared access signature of storage queue

[options] [queue] [permissions] [expiry]

use verbose output

use json output

the storage queue name

the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process)

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage queue

create

Create a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the queue

use verbose output

use json output

the storage queue name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

logging

Commands to manage your Storage logging properties

show

Show the logging properties of the storage services

use verbose output

use json output

show logging properties for blob service

show logging properties for table service

show logging properties for queue service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set the logging properties of the storage service

use verbose output

use json output

set logging properties for blob service

set logging properties for table service

set logging properties for queue service

the version string

set logging retention in days

enable logging for read requests

disable logging for read requests

enable logging for write requests

disable logging for write requests

enable logging for delete requests

disable logging for delete requests

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

metrics

Commands to manage your Storage metrics properties

show

Show the metrics properties of the storage services

use verbose output

use json output

show metrics properties for blob service

show metrics properties for table service

show metrics properties for queue service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set the metrics properties of the storage service

use verbose output

use json output

set metrics properties for blob service

set metrics properties for table service

set metrics properties for queue service

the version string

set metrics retention in days

set hourly metrics properties

turn off hourly metrics properties

set minute metrics properties

turn off minute metrics properties

include API in metrics

exclude API from metrics

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

cors

Commands to manage your Storage CORS (Cross-Origin Resource Sharing)

set

Set the CORS rules of the storage service

use verbose output

use json output

set CORS rules for blob service

set CORS rules for table service

set CORS rules for queue service

set CORS rules for file service

the CORS rules array in json format

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show the CORS rules of the storage service

use verbose output

use json output

show CORS rules for blob service

show CORS rules for table service

show CORS rules for queue service

show CORS rules for file service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete all the CORS rules of the storage service

use verbose output

use json output

delete CORS rules for blob service

delete CORS rules for table service

delete CORS rules for queue service

delete CORS rules for file service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

table

Commands to manage your Storage tables

create

Create a storage table

use verbose output

use json output

the storage table name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List storage tables with wildcard

use verbose output

use json output

the storage table name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the storage able

use verbose output

use json output

the storage table name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage table

use verbose output

use json output

the storage table name

remove the specified storage table without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage table

create

Generate a shared access signature of storage table

[options] [table] [permissions] [expiry]

use verbose output

use json output

the storage table name

the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the inclusive starting partition key

the inclusive ending partition key

the inclusive starting row key

the inclusive ending row key

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage table

create

Create a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the table

use verbose output

use json output

the storage table name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

ad

Commands to display active directory objects

app

Commands to display active directory applications

create

Creates a new active directory application

use verbose output

more verbose with debug output

use json output

the display name for the application

the URL to the application homepage

indicates if the application will be available to other tenants

the value for the password credential associated with the application that will be valid for one year by default

the comma-delimitied URIs that identify the application

the value for the key credentials associated with the application that will be valid for one year by default

the type of the key credentials associated with the application. Acceptable values are AsymmetricX509Cert, Password and Symmetric

the usage of the key credentials associated with the application. Acceptable values are Sign and Verify

the start date after which password or key would be valid. Default value is current time

the end date till which password or key is valid. Default value is one year after current time

delete

Deletes the active directory application

use verbose output

more verbose with debug output

use json output

the object id of the application to remove

quiet mode (do not ask for delete confirmation)

group

Commands to display active directory groups

list

Get active directory groups in current subscription's tenant

use verbose output

more verbose with debug output

use json output

Provides paging support. Press 'Enter' for more information.

show

Get active directory groups

use verbose output

more verbose with debug output

use json output

the object Id of the group to return

Search by display name which starts with the provided value

member

Commands to provide an active directory sub group or member info

list

Provides an active directory sub group or member info

use verbose output

more verbose with debug output

use json output

Object id of group whose members to return.

sp

Commands to display active directory service principals

list

Get all active directory service principals in current subscription's tenant

use verbose output

more verbose with debug output

use json output

show

Get active directory service principals

use verbose output

more verbose with debug output

use json output

the name of the service principal to return

the object id of the service principal to return

search display name of the service principal starting with the provided value

create

Create active directory service principal

use verbose output

more verbose with debug output

use json output

the application Id for which service principal is created

delete

Deletes active directory service principal

use verbose output

more verbose with debug output

use json output

the object id of the service principal to delete

quiet mode (do not ask for delete confirmation)

user

Commands to display active directory users

list

Get all active directory users in current subscription's tenant

use verbose output

more verbose with debug output

use json output

Provides paging support. Press 'Enter' for more information.

show

Get an active directory user

use verbose output

more verbose with debug output

use json output

the principal name of the user to return

the object id of the user to return

search users with display name starting with the provided value

apiapp

Commands to manage ApiApps

list

List currently deployed ApiApps in a subscription or resource group

use verbose output

more verbose with debug output

use json output

the resource group name, if not given list all ApiApps in subscription

The subscription identifier

Include ApiApp package version and auth setting (call will be slower)

show

Get detailed information about a deployed ApiApp

use verbose output

more verbose with debug output

use json output

Name of the resource group containing the ApiApp

Name of the ApiApp

The subscription identifier

create

Create a new ApiApp instance

[options] [resource-group] [name] [plan]

use verbose output

more verbose with debug output

use json output

Name of the ApiApp instance

Name of the resource group

Name or Resource Id of the App Service Plan to use

Package name and version to deploy (optional)

A JSON-formatted string containing parameters

A file containing parameters in JSON format

The subscription identifier

Do not wait for the deployment to complete

package

Commands to create and publish ApiApp packages

Create an ApiApp package that can be published

use verbose output

more verbose with debug output

use json output

Directory containing source to be packaged

Directory or filename to generate

availset

Commands to manage your availablilty sets

create

Creates an availability set within a resource group

[options] <resource-group> <name> <location> [tags]

use verbose output

more verbose with debug output

use json output

the resource group name

the availability set name

the location

the semicolon separated list of tags

the subscription identifier

list

Lists the availability sets within a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription identifier

show

Gets one availability set within a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the availability set name

the number of times to recurse, to recurse indefinitely pass "full". (valid only with --json option)

the subscription identifier

delete

Deletes one availability set within a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

quiet mode, do not ask for delete confirmation

the subscription identifier

feature

Commands to manage your features

list

List all features available for your subscription

use verbose output

more verbose with debug output

use json output

the subscription identifier

show

Shows a feature

use verbose output

more verbose with debug output

use json output

the resource provider name

the feature name

the subscription identifier

register

Registers a previewed feature of a resource provider.

use verbose output

more verbose with debug output

use json output

the resource provider name

the feature name

the subscription identifier

group

Commands to manage your resource groups

create

Creates a new resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the location where we will create the group

the name of the deployment we will create (only valid when a template is used)

the name of the template in the gallery

the path to the template file in the file system

the uri to the remote template file

the content version of the template

the storage account where we will upload the template file

a JSON-formatted string containing parameters

a file containing parameters

Tags to set to the resource group. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

the subscription identifier

set

Set tags to a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

remove all existing tags

the subscription identifier

delete

Deletes a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

quiet mode (do not ask for delete confirmation)

the subscription identifier

list

Lists the resource groups for your subscription

use verbose output

more verbose with debug output

use json output

show additional resource group details such as resources, permissions etc.

Tag to use to filter to the resource group. Can only take 1 tag. In the format of "name=value". Name is required and value is optional. For example, -t tag1 or -t tag1=value1.

the subscription identifier

show

Shows a resource group for your subscription

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription identifier

log

Commands to manage resource group logs

Retrieves and shows logs for resource group operations

use verbose output

more verbose with debug output

use json output

the resource group name

returns logs for all operations (including CRUD and deployment)

returns logs for the last deployment

the name of the deployment whose logs you want to see

the subscription identifier

deployment

Commands to manage your deployment in a resource group

create

Creates a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the deployment

the name of the template in the gallery

the uri to the remote template file

the content version of the template

a file containing parameters

does not wait for the deployment to complete. Returns as soon as the deployment is created

the subscription identifier

list

Gets deployments

use verbose output

more verbose with debug output

use json output

the name of the resource group.

filter the deployments by provisioning state (valid values are Accepted, Running, Failed, and Succeeded)

subscription containing deployments to list (optional)

show

Shows a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group.

the name of the deployment (if not specified, the most recent deployment is shown)

subscription containing the deployment to display (optional)

stop

Stops a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group

quiet mode (do not ask for stop deployment confirmation)

the name of the deployment (if not specified, the currently running deployment is stopped)

the subscription identifier

delete

Deletes a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group.

the name of the deployment.

template

Commands to manage your local or gallery resource group template

list

Lists gallery resource group templates

use verbose output

more verbose with debug output

use json output

the category of the templates to list

the publisher of the templates to list

the Azure subscription to run against

show

Shows a gallery resource group template

use verbose output

more verbose with debug output

use json output

the name of template to show

the Azure subscription to run against

download

Downloads a gallery resource group template

use verbose output

more verbose with debug output

use json output

the name of the template to download

the name of the destination directory or file

quiet mode (do not prompt for overwrite if output file exists)

the Azure subscription to run against

validate

Validates a template to see whether it's using the right syntax, resource providers, resource types, etc.

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the template in the gallery

the path to the template file in the file system

the uri to the remote template file

the content version of the template

the storage account where we will upload the template file

a JSON-formatted string containing parameters

a file containing parameters

the subscription identifier

insights

Commands related to monitoring Insights (events, alert rules, autoscale settings, metrics)

logs

Retrieve operation logs for a subscription, a correlationId, a resource group, resource, or resource provider.

list

List operation logs for a subscription.

use verbose output

more verbose with debug output

use json output

The correlation id of the query.

The resource group.

The resource Id.

The resource provider.

The start time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The end time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The status.

Caller to look for when querying.

Shows the details of the events in the log.

The subscription identifier.

alerts

Retrieve alerts logs

list

List alert logs for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The status.

Caller to look for when querying.

The subscription identifier.

rule

Retrieve alerts rules

List alert rules for a resource.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the rule to query.

The target resource of the query.

The subscription identifier.

delete

Deletes an alert rule.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the rule to query.

The subscription identifier.

set

Create or set a metric alert rule.

[options] <ruleType> <ruleName> <location> <resourceGroup>

use verbose output

more verbose with debug output

use json output

The type of the rule (Event, Metric, Webtest).

Flag to disable the rule.

The subscription identifier.

The name of the rule.

The description of the rule.

The location.

The resource group.

The time window size. Expected format hh:mm:ss.

Flag to send e-mail to service owners.

The list of custom e-mail addresses.

The condition operator: GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual. Value is case insensitive.

The threshold.

The resource Id.

The metric name.

The time aggregation operator: Average, Minimum, Maximum, Total. Value is case insensitve.

The event name.

The event source.

The level for the rule.

The operation name.

The resource provider.

The status.

The substatus.

The e-mail address.

The failed location.

autoscale

Retrieve autoscale logs

list

List autoscale logs for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The status.

Caller to look for when querying.

The subscription identifier.

profile

Manages autoscale profiles

set

Create or set an autoscale profile.

[options] <profileType> <profileName> <defaultCapacity> <maximumCapacity> <minimumCapacity> <rules>

use verbose output

more verbose with debug output

use json output

The type of the profile: NoSchedule, FixedDate, Recurrent (the value case insensitive)

The name of the profile.

The default capacity of the profile.

The maximum capacity of the profile.

The minimum capacity of the profile.

The rules of the profile. A json string containing a listing of scale rules.

The start time window of a fixed date schedule.

The end time window of a fixed date schedule.

The time window timezone of a fixed date schedule.

The recurrence frequency of a recurrent schedule: None, Second, Minute, Hour, Day, Week, Month, Year (the value is case insensitive)

The list of schedule days a recurrent schedule. Values are comma-separated.

The list of schedule hours a recurrent schedule. Values are comma-separated.

The list of schedule minutes a recurrent schedule. Values are comma-separated.

The list of schedule timezone a recurrent schedule.

rule

Manages autoscale rules

set

Create or set an autoscale rule.

[options] <metricName> <metricResourceId> <conditionOperatorType> <metricStatisticType> <threshold> <timeGrain> <actionCooldown> <actionDirection> <actionType> <scaleValue>

use verbose output

more verbose with debug output

use json output

The metric name.

The resource Id.

The condition operator: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual. The value is case insensitive.

The metric statistic type: Average, Min, Max, Sum. The value is case insensitive.

The threshold.

The time grain. Expected format hh:mm:ss.

The scale action cooldown time. Expected format hh:mm:ss.

The scale action direction: None, Increase, Decrease. The value is case insensitive.

The scale action type name: ChangeSize, ChangeCount, PercentChangeCount, ExactCount. The value is case insensitive.

The scale action value.

The time aggregation operator: Average, Minimum, Maximum, Total. The value is case insensitive.

The time window size. Expected format hh:mm:ss.

setting

Manages autoscale settings

list

List autoscale settings for a resource.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the setting.

delete

Deletes an autoscale setting.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the setting.

set

Create or set an autoscale setting.

use verbose output

more verbose with debug output

use json output

Flag to disable the setting.

A list of autoscale profiles in JSON format.

The resource group.

The name of the setting.

The location.

The resource Id.

The setting spec in JSON format.

metrics

Retrieve metrics values resource

list

List metric values for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The start time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The end time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The list of metric names.

The subscription identifier.

definition

Retrieves metric definitions for a resource

List metric definitions for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The list of metric names.

The subscription identifier.

usage

Retrieve usage metrics for a resource.

list

List usage metrics for a resource.

use verbose output

more verbose with debug output

use json output

The underlying resource provider API version.

The list of metric names.

The subscription identifier.

keyvault

Commands to manage key vault instances in the Azure Key Vault service

list

Lists existing vaults

use verbose output

more verbose with debug output

use json output

lists only vaults belonging to the informed resource group

the subscription identifier

create

Creates a vault

[--vault-name] <vault-name> --resource-group <resource-group> --location <location> [options]

use verbose output

more verbose with debug output

use json output

the vault name; this is used to compute the vault's DNS name

the resource group name

Azure region in which to create the vault

SKU setting, one of: [Standard, Premium]

Tags to set on the vault. Can be multiple in the format 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

the subscription identifier

set-attributes

Changes attributes of an existing vault

use verbose output

more verbose with debug output

use json output

the vault name

changes only if vault belongs to the informed resource group; otherwise returns 'not found'

remove previously existing tags; can combined with --tags

the subscription identifier

show

Shows properties of a vault

use verbose output

more verbose with debug output

use json output

the vault name

shows only if vault belongs to the informed resource group; otherwise returns 'not found'

the subscription identifier

delete

Deletes an existing vault

use verbose output

more verbose with debug output

use json output

the vault name

deletes only if vault belongs to the informed resource group; otherwise returns 'not found'

quiet mode (do not ask for delete confirmation)

outputs the deleted vault

the subscription identifier

set-policy

Adds or modifies an access policy for a vault

use verbose output

more verbose with debug output

use json output

the vault name

a GUID that identifies the principal that will receive permissions

name of a service principal that will receive permissions

name of a user principal that will receive permissions

JSON-encoded array of strings representing key operations; each string can be one of [all, create, import, update, delete, get, list, backup, restore, sign, verify, encrypt, decrypt, wrapKey, unwrapKey]

JSON-encoded array of strings representing secret operations; each string can be one of [all, set, get, list, delete]

reserved for future use

the subscription identifier

delete-policy

Removes an access policy from a vault

use verbose output

more verbose with debug output

use json output

the vault name

a GUID that identifies the principal that will lose permissions

name of a service principal that will lose permissions

name of a user principal that will lose permissions

if informed, will set the enabledForDeployment property to false in the vault

the subscription identifier

key

Commands to manage keys in the Azure Key Vault service

list

Lists keys of a vault

use verbose output

more verbose with debug output

use json output

the vault name

list-versions

Lists key versions

[--vault-name] <vault-name> [[--key-name] <key-name>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

lists only versions of this key

create

Creates a key in the vault

[--vault-name] <vault-name> [--key-name] <key-name> --destination <destination> [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the key to be created; if already exists, a new key version is generated

tells if the key is software-protected or HSM-protected; valid values: [Software, HSM]

tells if the key should be enabled; valid values: [false, true]; default is true

key expiration time, in UTC format

time before which key cannot be used, in UTC format

JSON-encoded array of strings representing key operations; each string can be one of [encrypt, decrypt, sign, verify, wrapKey, unwrapKey]

Tags to set on the key. Can be multiple in the format 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

import

Imports an existing key into a vault

[--vault-name] <vault-name> [--key-name] <key-name> ( --pem-file | --byok-file ) <file-name> [--destination <destination>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the key to be imported; if already exists, a new key version is generated

name of a PEM file containing the key to be imported; the file must not be password protected

name of a BYOK file containing the key to be imported

password of key file; if not informed and the file is encrypted, will prompt

key expiration time, in UTC format

set-attributes

Changes attributes of an existing key

[--vault-name] <vault-name> [--key-name] <key-name> [[--key-version] <key-version>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the key to be modified

the version to be modified; if ommited, modifies only the most recent

if informed, command will change the enabled state; valid values: [false, true]

if informed, command will change key expiration time; must be a date in UTC format or null

if informed, command will change time before which key cannot be used; must be a date in UTC format or null

if informed, command will change valid operations; must be JSON-encoded array of strings representing key operations; each string can be one of [encrypt, decrypt, sign, verify, wrapKey, unwrapKey]

remove previously existing tags; can combined with --tags

show

Shows properties of a vault key

use verbose output

more verbose with debug output

use json output

the vault name

the key name

the key version; if ommited, uses the most recent

delete

Deletes a key from the vault

[--vault-name] <vault-name> [--key-name] <key-name> [options]

use verbose output

more verbose with debug output

use json output

the vault name

the key name

quiet mode (do not ask for delete confirmation)

outputs the deleted key

backup

Generates a protected backup of a vault key

[--vault-name] <vault-name> [--key-name] <key-name> [--output-file] <output-file> [options]

use verbose output

more verbose with debug output

use json output

the vault name

the key name

name of the binary file that will contain backup data

restore

Restores a backed up key to a vault

[--vault-name] <vault-name> [--input-file] <input-file> [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the binary file that contains backup data

secret

Commands to manage secrets in the Azure Key Vault service

list

Lists secrets of a vault

use verbose output

more verbose with debug output

use json output

the vault name

list-versions

Lists secret versions

[--vault-name] <vault-name> [[--secret-name] <secret-name>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

lists only versions of this secret

set

Stores a secret on the vault

[--vault-name] <vault-name> [--secret-name] <secret-name> [--value] <secret-value> [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the secret to be created; if already exists, a new secret version is created

the secret value

tells if the secret should be enabled; valid values: [false, true]; default is true

expiration time of secret, in UTC format

time before which secret cannot be used, in UTC format

Tags to set on the secret. Can be multiple in the format 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

set-attributes

Changes attributes of an existing secret

[--vault-name] <vault-name> [--secret-name] <secret-name> [[--secret-version] <secret-version>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the secret to be modified

the version to be modified; if ommited, modifies only the most recent

if informed, command will change the enabled state; valid values: [false, true]

if informed, command will change secret expiration time; must be a date in UTC format or null

if informed, command will change time before which secret cannot be used; must be a date in UTC format or null

remove previously existing tags; can combined with --tags

show

Shows a vault secret

use verbose output

more verbose with debug output

use json output

the vault name

the secret name

the secret version; if ommited, uses the most recent

delete

Deletes a secret from the vault

[--vault-name] <vault-name> [--secret-name] <secret-name> [options]

use verbose output

more verbose with debug output

use json output

the vault name

the secret name

quiet mode (do not ask for delete confirmation)

outputs the deleted secret

location

Commands to get the available locations for all resource types

list

list the available locations

use verbose output

more verbose with debug output

use json output

the subscription identifier

network

Commands to manage network resources

vnet

Commands to manage virtual networks

create

Create a virtual network

[options] <resource-group> <name> <location>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the location

the comma separated list of address prefixes for this virtual network.
     For example -a 10.0.0.0/24,10.0.1.0/24.
     Default value is 10.0.0.0/8

the comma separated list of DNS servers IP addresses

the tags set on this virtual network.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set virtual network

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the comma separated list of address prefixes for this virtual network.
     For example -a 10.0.0.0/24,10.0.1.0/24.
     This list will be appended to the current list of address prefixes.
     The address prefixes in this list should not overlap between them.
     The address prefixes in this list should not overlap with existing address prefixes in the vnet.

the comma separated list of DNS servers IP addresses.
     This list will be appended to the current list of DNS server IP addresses.

the tags set on this virtual network.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional. For example, -t "tag1=value1;tag2".
     Existing tag values will be replaced by the values specified.

remove all existing tags

the subscription identifier

list

Get all virtual networks

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a virtual network

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the subscription identifier

delete

Delete a virtual network

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

quiet mode, do not ask for delete confirmation

the subscription identifier

subnet

Commands to manage virtual network subnets

create

Create virtual network subnet

[options] <resource-group> <vnet-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the name of the subnet

the address prefix

the network security group identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkSecurityGroups/<nsg-name>

the network security group name

the route table identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/routeTables/<route-table-name>

the route table name

the subscription identifier

set

Set a virtual network subnet

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the name of the subnet

the address prefix

the network security group name

the route table name

the subscription identifier

list

Get all virtual network subnets

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the subscription identifier

show

Get a virtual network subnet

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the name of the subnet

the subscription identifier

delete

Delete a subnet of a virtual network

[options] <resource-group> <vnet-name> <subnet-name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the subnet name

the subscription identifier

lb

Commands to manage load balancers

create

Create a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the location

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional. For example, -t "tag1=value1;tag2"

the subscription identifier

list

Get all load balancers

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

probe

Commands to manage probes of a load balancer

create

Add a probe to the load balancer

[options] <resource-group> <lb-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the probe

the probe protocol

the probe port

the probe path

the probe interval in seconds

the number of probes

the subscription identifier

set

Set a probe of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the probe

the new name of the probe

the new value for probe protocol

the new value for probe port

the new value for probe path

the new value for probe interval in seconds

the new value for number of probes

the subscription identifier

list

Get all probes in a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a probe from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the probe name

the subscription identifier

frontend-ip

Commands to manage frontend ip configurations of a load balancer

create

Add a frontend ip configuration to the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the frontend ip configuration

the private ip address

the public ip identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public ip name.
     This public ip must exist in the same resource group as the lb.
     Please use public-ip-id if that is not the case.

the subnet id.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/VirtualNetworks/<vnet-name>/subnets/<subnet-name>

the subnet name

the virtual network name.
     This virtual network must exist in the same resource group as the lb.
     Please use subnet-id if that is not the case.

the subscription identifier

set

Set a frontend ip configuration of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the private ip address

the subnet name

the subscription identifier

list

Get all frontend ip configurations in the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a frontend ip configuration from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

quiet mode, do not ask for delete confirmation

the subscription identifier

address-pool

Commands to manage backend address pools of a load balancer

create

Add an address pool to the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the backend address pool

the subscription identifier

list

Get all address pools in the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete an address pool from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the backend address pool

the subscription identifier

rule

Commands to manage load balancer rules

create

Add a load balancing rule to a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the rule

the rule protocol

the frontend port

the backend port

enable floating point ip

the idle timeout specified in minutes

the name of the probe defined in the same load balancer

the name of the frontend ip configuration in the same load balancer

name of the backend address pool defined in the same load balancer

the subscription identifier

set

Set a load balancing rule of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the rule

new rule name

the rule protocol

the frontend port

the backend port

enable floating point ip

the idle timeout specified in minutes

the subscription identifier

list

Get all load balancing rules of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a load balancing rule from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the rule

the subscription identifier

inbound-nat-rule

Commands to manage load balancer inbound NAT rules

create

Add a load balancing inbound NAT rule to the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the inbound NAT rule

the rule protocol [tcp,udp]

the frontend port [0-65535]

the backend port [0-65535]

enable floating point ip [true,false]

the name of the frontend ip configuration

the subscription identifier

set

Set a load balancing inbound NAT rule of load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the inbound NAT rule

the rule protocol [tcp,udp]

the frontend port [0-65535]

the backend port [0-65535]

enable floating point ip [true,false]

the subscription identifier

list

Get all load balancing inbound NAT rules of load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a load balancing inbound NAT rule from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the inbound NAT rule

quiet mode, do not ask for delete confirmation

the subscription identifier

public-ip

Commands to manage public ip addresses

create

Create a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public ip

the location

the domain name label.
     This set DNS to <domain-name-label>.<location>.cloudapp.azure.com

the allocation method [Static][Dynamic]

the idle timeout specified in minutes

the reverse fqdn

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public ip

the allocation method [Static][Dynamic]

the idle timeout specified in minutes

the reverse fqdn

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     Existing tag values will be replaced by the values specified.
     For example, -t "tag1=value1;tag2"

remove all existing tags

the subscription identifier

list

Get all public ips

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public IP

the subscription identifier

delete

Delete a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public IP

the subscription identifier

nic

Commands to manage network interfaces

create

Create a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the location

the network security group identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkSecurityGroups/<nsg-name>

the network security group name.
     This network security group must exist in the same resource group as the nic.
     Please use network-security-group-id if that is not the case.

the public IP identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public IP name.
     This public ip must exist in the same resource group as the nic.
     Please use public-ip-id if that is not the case.

the private IP address

the subnet identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>

the subnet name

the vnet name under which subnet-name exists

the comma separated list of load balancer address pool identifiers
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/loadbalancers/<lb-name>/backendAddressPools/<address-pool-name>

the comma separated list of load balancer inbound NAT rule identifiers
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/loadbalancers/<lb-name>/inboundNatRules/<nat-rule-name>

the internal DNS name label

the ip forwarding, valid values are [true, false]

the comma seperated list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the private IP address

the subnet name

the internal DNS name label

remove all existing tags

the subscription identifier

list

Get all network interfaces

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

delete

Delete a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

address-pool

Commands to manage backend address pools of the network interface

add

Add a backend address pool to a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

-i, --lb-address-pool-id  <lb-address-pool-id>

the load balancer address pool identifier
   e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/loadbalancers/<lb-name>/backendAddressPools/<address-pool-name>

the load balancer name.
   This load balancer must exists in the same resource group as the NIC.
   Please use --lb-address-pool-id if that is not the case.
   This parameter will be ignored if --lb-address-pool-id is specified

the name of the address pool that exists in the load balancer identified by --lb-name
   This parameter will be ignored if --lb-address-pool-id is specified

the subscription identifier

remove

Remove a backend address pool from a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the load balancer name.
   This load balancer must exist in the same resource group as the NIC.
   Please use --lb-address-pool-id if that is not the case.
   This parameter will be ignored if --lb-address-pool-id is specified

the subscription identifier

inbound-nat-rule

Commands to manage inbound rules of the network interface

add

Add an inbound NAT rule to a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the inbound NAT rule identifier.
   e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/loadbalancers/<lb-name>/inboundNatRules/<nat-rule-name>

the load balancer name.
   This load balancer must exists in the same resource group as the NIC.
   Please use --inbound-nat-rule-id if that is not the case.
   This parameter will be ignored if --inbound-nat-rule-id is specified

the name of the NAT rule that exists in the load balancer identified by --lb-name

the subscription identifier

remove

Remove an inbound NAT rule from a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

nsg

Commands to manage network security groups

create

Create a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the location

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

remove all existing tags

the subscription identifier

list

Get all network security groups

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the subscription identifier

delete

Delete a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

quiet mode, do not ask for delete confirmation

the subscription identifier

rule

Commands to manage network security group rules

create

Create a network security group rule

[options] <resource-group> <nsg-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the description

the protocol [Tcp,Udp,*]

the source address prefix

the source port range [0-65535]

the destination address prefix

the destination port range [0-65535]

the access mode [Allow,Deny]

the priority [100-4096]

the direction [Inbound,Outbound]

the subscription identifier

set

Set a network security group rule

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the description

the protocol [Tcp,Udp,*]

the source address prefix

the source port range [0-65535]

the destination address prefix

the destination port range [0-65535]

the access mode [Allow,Deny]

the priority [100-4096]

the direction [Inbound,Outbound]

the subscription identifier

list

Get all rules in a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the subscription identifier

show

Get a rule in a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the subscription identifier

delete

Delete a rule in a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the subscription identifier

dns-zone

Commands to manage DNS zone

create

Create a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

set

Set a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

remove all existing tags

the subscription identifier

list

Get all DNS zones

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone
   You can specify "*" (in quotes) for this parameter

the subscription identifier

delete

Delete a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

dns-record-set

Commands to manage record sets in DNS zone

create

Create a DNS zone record set

[options] <resource-group> <dns-zone-name> <name> <type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the relative name of the record set within the DNS zone

the type of the record set.
     Valid values are [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT, PTR]

time to live specified in seconds

the tags set on this virtual network.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a DNS zone record set

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

time to live specified in seconds

the tags set on this virtual network.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     Existing tag values will be replaced by the values specified.
     For example, -t "tag1=value1;tag2"

remove all existing tags

the subscription identifier

list

Get all record sets in a DNS zone

[options] <resource-group> <dns-zone-name> [type]

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the type of the record set.
     If specified only record sets of this type will be listed.
     Valid values are [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT, PTR]

the subscription identifier

show

Get a record set in a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

delete

Delete a record set from a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

add-record

Add a record in a record set under a DNS zone

[options] <resource-group> <dns-zone-name> <record-set-name> <type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the name of the record set

the type of the record set.
     If specified only record sets of this type will be listed.
     Valid values are [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT, PTR]

The record type A

the IPv4 address attribute

Record type AAAA

the IPv6 address attribute

Record type CNAME

the canonical name (target)

Record type NS

the domain name attribute

Record type MX

preference attribute

exchange attribute

Record type SRV

the priority attribute

the weight attribute

the port

the target attribute

Record type TXT

the text attribute

Record type SOA

the email attribute

the expire time specified in seconds

the serial number

the host name attribute

the minimum time to live specified in seconds

the refresh time specified in seconds

the retry time specified in seconds

Record type PTR

ptr domain name

the subscription identifier

delete-record

Delete a record from a record set under a DNS zone

[options] <resource-group> <dns-zone> <record-set-name> <type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the name of the record set

preference attribute

exchange attribute

Record type SRV

the priority attribute

the weight attribute

the port

the target attribute

Record type TXT

the text attribute

Record type PTR

ptr domain name

quiet mode, do not ask for delete confirmation

the subscription identifier

traffic-manager

Commands to manage Traffic Manager

profile

Commands to manage Traffic Manager profile

create

Create a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

the profile status, valid values are
     [Enabled, Disabled], default is Enabled

the traffic routing method for the profile,
     valid values are [Performance, Weighted, Priority]

relative DNS name of the profile e.g. .trafficmanager.net

time to live in specified in seconds

the source address prefix, valid values are [http, https]

the monitoring port

the monitoring path

the tags set on this profile. Can be
     multiple, in the format of 'name=value'.
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

time to live specified in seconds

the monitoring port

the monitoring path

the tags set on this profile. Can be
     multiple, in the format of 'name=value'.
     Name is required and value is optional.
     Existing tag values will be replaced by the values specified.
     For example, -t "tag1=value1;tag2"

remove all existing tags

the subscription identifier

list

Get all Traffic Manager profiles

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

the subscription identifier

delete

Delete a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

the subscription identifier

is-dns-available

Checks whether the specified DNS prefix is available for creating a Traffic Manager profile

network traffic-manager profile is-dns-available

use verbose output

more verbose with debug output

use json output

the name of the resource group

the relative DNS name to check for availability

the subscription identifier

endpoint

Commands to manage Traffic Manager endpoints

network traffic-manager profile endpoint

create

Create an endpoint in Traffic Manager profile

network traffic-manager profile endpoint create

[options] <resource-group> <profile-name> <name> <endpoint-location>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the profile name

the name of the endpoint

the location of the endpoint

the endpoint type, valid values are:
       [externalEndpoint] externalEndpoint represents endpoint
       for a service with FQDN external to Azure
       e.g. foobar.contoso.com

the domain name target of the endpoint,
       e.g. foobar.contoso.com

the endpoint status, valid values are:
       [Enabled,Disabled] Default is Enabled

the endpoint weight used in the load balancing algorithm

the endpoint priority used in the load balancing algorithm,
       valid range is [1, 1000]

the subscription identifier

set

Set an endpoint in a Traffic Manager profile

network traffic-manager profile endpoint set

[options] <resource-group> <profile-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the profile name

the name of the endpoint

the subscription identifier

delete

Delete an endpoint from a Traffic Manager profile

network traffic-manager profile endpoint delete

use verbose output

more verbose with debug output

use json output

the name of the resource group

the profile name

the name of the endpoint

quiet mode, do not ask for delete confirmation

the subscription identifier

route-table

Commands to manage Route Table

create

Create a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the location, this must be same as the location of the virtual network containing the subnet(s) on which this Route Table needs to be applied

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional. For example, -t "tag1=value1;tag2"

the subscription identifier

show

Get a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the subscription identifier

list

Get all Route Tables

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

delete

Delete a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the subscription identifier

route

Commands to manage Route Table routes

create

Create route in a Route Table

[options] <resource-group> <route-table-name> <name> <address-prefix> <next-hop-type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the route address prefix e.g. 0.0.0.0/0

the route next hop type, valid values are:
       [VirtualAppliance,VirtualNetworkGateway,VNETLocal,Internet,Null]

the route next hop ip addresses, this parameter is valid
       only for next hop type VirtualAppliance

the subscription identifier

set

Set route in a Route Table

[options] <resource-group> <route-table-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the route address prefix e.g. 0.0.0.0/0

the route next hop ip addresses, this parameter is valid
       only for next hop type VirualAppliance

the subscription identifier

list

List all routes in a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the subscription identifier

show

Show details about route in a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the subscription identifier

delete

Delete route from a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the subscription identifier

provider

Commands to manage resource provider registrations

list

List currently registered providers in ARM

use verbose output

more verbose with debug output

use json output

Subscription to list providers for

show

Show details about the requested provider namespace

use verbose output

more verbose with debug output

use json output

the provider namespace to show

subscription to show provider for

register

Register namespace provider with the subscription

use verbose output

more verbose with debug output

use json output

the provider namespace to register

Subscription to register

unregister

Un-register namespace provider with the subscription

use verbose output

more verbose with debug output

use json output

the provider namespace to register

Subscription to register

resource

Commands to manage your resources

create

Creates a resource in a resource group

[options] <resource-group> <name> <resource-type> <location> <api-version>

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the location where we will create the resource

the resource type

the API version of the resource provider

the name of the parent resource (if needed), in path/path/path format

a JSON-formatted string containing properties

Tags to set to the resource group. Can be mutliple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

the subscription identifier

set

Updates a resource in a resource group without any templates or parameters

[options] <resource-group> <name> <resource-type> <properties> <api-version>

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the resource type

Tags to set to the resource. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

remove all existing tags

the subscription identifier

list

Lists the resources

use verbose output

more verbose with debug output

use json output

the resource group name

the resource type

show details such as permissions, etc.

the subscription identifier

show

Gets one resource within a resource group or subscription

[options] <resource-group> <name> <resource-type> <api-version>

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the resource type

the subscription identifier

delete

Deletes a resource in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the resource type

quiet mode (do not ask for delete confirmation)

the subscription identifier

role

Commands to manage your Azure roles

list

Get all available role definitions

use verbose output

more verbose with debug output

use json output

If given, display only the custom roles instead of all role definitions

the subscription identifier

show

Get an available role definition

use verbose output

more verbose with debug output

use json output

the role definition name

the subscription identifier

create

create a new role definition

use verbose output

more verbose with debug output

use json output

File name containing a single role definition.

A JSON-formatted string containing the role definition. For e.g. {"Name": "Test Role","Description": "Test role","Actions": ["Microsoft.Support/*/read"],"Notactions": [],"AssignableScopes": ["/subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f"]}

The subscription identifier

set

update an existing role definition

use verbose output

more verbose with debug output

use json output

A JSON-formatted string containing the role definition. For e.g. {"Name": "Test Role","Description": "Test role","Actions": ["Microsoft.Support/*/read"],"Notactions": [],"AssignableScopes": ["/subscriptions/5004a9fd-d58e-48dc-aeb2-4a4aec58606f"]}

The subscription identifier

assignment

Commands to manage your role assignment

create

create a new role assignment

[options] [objectId] [upn] [mail] [spn] [role] [scope] [resource-group] [resource-type] [resource-name]

use verbose output

more verbose with debug output

use json output

Object id of an active directory user, group or service principal.

User principal name.

Mail of a user or group.

Service Principal Name.

Role to assign the principals with.

Scope of the role assignment.

Resource group to assign the role to.

Type of the resource to assign the role to.

Name of the resource to assign the role to.

Parent resource of the resource to assign the role to, if there is any.

Subscription id or name of where the role assignment will be created.

list

Get role assignment at a given scope

use verbose output

more verbose with debug output

use json output

User principal name.

Mail of a user or group.

Service Principal Name.

Role the principals was assigned to

Scope of the role assignment.

Resource group to role was assigned to.

Type of the resource the role was assign to

The resource the role was assigned to.

Parent resource of the resource the role was assigned to, if there is any.

Subscription id or name of where the role assignment is from.

delete

delete a role assignment

use verbose output

more verbose with debug output

use json output

Object id of an active directory user, group or service principal

User principal name.

Mail of a user or group.

Service Principal Name.

Role to remove from the principals.

Scope of the role assignment.

Resource group to role was assigned to.

The resource the role was assigned to.

If specified, won't prompt before delete.

Subscription id or name of where the role assignment will be removed.

tag

Commands to manage your resource manager tags

create

add a tag

use verbose output

more verbose with debug output

use json output

Name of the tag. If the tag name doesn't exist, create the tag name; Otherwise, add the value to the existing tag name.

Value of the tag. If specified, add the tag value to the tag name; Otherwise, keep the tag values unchanged.

The subscription identifier.

delete

Remove an entire tag or a tag value

use verbose output

more verbose with debug output

use json output

Name of the tag to remove.

Value of the tag to remove. If not specified, remove the entire tag. If specified, only remove the tag value.

If not specified, will prompt for confirmation. If specified, won't prompt.

The subscription identifier.

list

Lists the tag information

use verbose output

more verbose with debug output

use json output

Show tag values information as well.

The subscription identifier.

show

Get a tag

use verbose output

more verbose with debug output

use json output

The tag name.

The subscription identifier.

usage

Command to view your aggregated Azure usage data

list

List the usage aggregates for a provided time range

use verbose output

more verbose with debug output

use json output

The start of the time range to retrieve data for.

The end of the time range to retrieve data for.

Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour.

When set to true (default), the aggregates are broken down into the instance metadata which is more granular.

Retrieved from previous calls, this is the bookmark used for progress when the responses are paged.

the subscription identifier

vm

Commands to manage your virtual machines

create

Create a virtual machine in a resource group

[options] <resource-group> <name> <location> <os-type>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the NIC identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkInterfaces/<nic-name>

the NIC name
     If this is an existing NIC then it must exists under the current resource group identified by resource-group
     A new NIC will be created if no NIC exists with name nic-name in the current resource group
     To create new NIC - subnet-id or vnet-name, vnet-address-prefix, subnet-name and vnet-subnet-address-prefix are required
     Please use nic-id to refer an existing NIC in a different resource group
     The parameter nic-name will be ignored when nic-id is specified

the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary.

the list of NIC names separated by comma. In case of specifying multiple nics first one will be set as primary.These NICs must exists in the same resource group as the VM. Please use nic-ids if that not the case. This parameter will be ignored if --nic-ids is specified

the location

the operating system Type, valid values are Windows, Linux

the image name [image-name and image-urn parameters are mutually exclusive]

the image URN in the form publisherName:offer:skus:version [image-urn and image-name parameters are mutually exclusive]

the user name
      This parameter is valid for a VM created from an image (image-name, image-urn) and ignored when VM is based on an existing disk

the password
      This parameter is valid for a VM created from an image (image-name, image-ur) and ignored when VM is based on existing disk

path to public key PEM file or SSH Public key file for SSH authentication
     This parameter is valid only when os-type is "Linux"

Auto generate SSH keys, will be ignored if --ssh-publickey-file is specified. This parameter is valid only when os-type is "Linux"

the virtual machine size [Standard_A1]

the public ip identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public ip name
     If this is an existing public IP then it must exists under the current resource group identified by resource-group
     A new public IP will be created if no public IP exists with name public-ip-name in the current resource group
     Please use public-ip-id to refer an existing public IP in a different resource group
     The parameter public-ip-name will be ignored when public-ip-id is specified

the public ip domain name
     This sets the DNS to <publicip-domain-name>.<location>.cloudapp.azure.com
     This parameter will be used only when creating new public IP

the public ip allocation method, valid values are "Dynamic"
     This parameter will be used only when creating new public IP

the public ip idle timeout specified in minutes
     This parameter will be used only when creating new public IP

the subnet identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>

the virtual network name
     If this is an existing vnet then it must exists under the current resource group identified by resource-group
     If this is an existing vnet then vnet-subnet-name is required
          If no subnet exists with name vnet-subnet-name then a new subnet will be created
          To create new subnet - vnet-subnet-address-prefix is required
     A new vnet will be created if no vnet exists with name vnet-name in the current resource group
     To create new vnet - vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix are required
     Please use subnet-id to refer an existing subnet under a vnet in a different resource group
     vnet-name, vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix will be ignored when subnet-id is specified

the virtual network address prefix in IPv4/CIDR format

the virtual network subnet name

the virtual network subnet address prefix in IPv4/CIDR format

the availability set name

the storage account name

the storage account container name [vhds]

name or url of the OS disk Vhd
     If this parameter is specified along with --image-name or --image-urn parameter then OS disk created from the image will be stored in this vhd
     If this parameter is specified without --image-name or --image-urn parameter then this vhd must exists and will be used as OS Disk

data disk caching, valid values are None, ReadOnly, ReadWrite

name or url of the data disk Vhd

data disk size in GB

Will use existing VHD if specified. Don't specify this param if you are creating data disk from a new VHD.

CustomData file

the subscription identifier

Tags to set to the virtual machine. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, --tags tag1=value1;tag2

quick-create

Create a virtual machine with default resources in a resource group

[options] <resource-group> <name> <location> <os-type> <image-urn> <admin-username> <admin-password>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the location

the operating system Type, valid values are Windows, Linux

the image URN in the form "publisherName:offer:skus:version"

the user name

the password

the subscription identifier

list

Get all virtual machines in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription identifier

show

Get a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the number of times to recurse, to recurse indefinitely pass "full". (valid only with --json option)

the subscription identifier

delete

Delete a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

quiet mode, do not ask for delete confirmation

the subscription identifier

stop

Shutdown a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

restart

Restart a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

start

Start a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

deallocate

Shutdown a virtual machine in a resource group and release the compute resources

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

sizes

Get all available virtual machine sizes

use verbose output

more verbose with debug output

use json output

the location name, use this to get the list of VM sizes available in a location

the virtual machine name, use this to get the list of VM sizes available for a specific VM

the resource group name, required when --vm-name is specified

the subscription identifier

capture

Capture a VM in a resource group as an OS Image or VM Image

[options] <resource-group> <name> <vhd-name-prefix>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

Captured virtual hard disk's name prefix

the storage account container name [vhds]

In case of conflict overwrite the target virtual hard disk if set to true.

Name of the file that will contain a template that can be used to create similar VMs.

the subscription id

generalize

Set the state of a VM in a resource group to Generalized.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

get-instance-view

Get instance view of a VM in a resource group.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

reset-access

Enables you to reset Remote Desktop Access or SSH settings on a Virtual Machine and to reset the password for the account that has administrator or sudo authority.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the user name

the password

path to public key PEM file for SSH authentication (valid only when os-type is "Linux")

Reset the SSH configuration to default

Version of VM Access extension [1.1]

password expiration

Remove a user account with specified name

the subscription identifier

set

Update a VM in a resource group.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary.

the virtual machine size

Tags to set to the resource group. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

Remove all tags

the subscription identifier

list-usage

Get usage of compute resources.

use verbose output

more verbose with debug output

use json output

the location

the subscription identifier

disk

Commands to manage your Virtual Machine data disks

attach-new

Attach a new data-disk to a VM in a resource group

[options] <resource-group> <vm-name> <size-in-gb> [vhd-name]

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the disk size in GB

the name for the new VHD

the caching behaviour of disk [None, ReadOnly, ReadWrite]

the storage account name

zero based logical unit number of the data disk

the subscription id

detach

Detach a data-disk attached to a VM in a resource group

[options] <resource-group> <vm-name> <lun>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the data disk lun

the subscription id

attach

[options] <resource-group> <vm-name> [vhd-url]

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the URL of existing VHD

the subscription id

list

Get all data disks of a VM in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription id

extension

Commands to manage VM resource extensions

set

Enable/disable resource extensions for a VM in a resource group

[options] <resource-group> <vm-name> <name> <publisher-name> <version>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the extension name

the publisher name

the extension version

extension's reference name

public configuration text

public configuration file path

private configuration text

private configuration file path

uninstall extension

Tags to set to the resource group. Can be mutliple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

quiet mode, do not ask for uninstall confirmation

the subscription id

get

Get extensions installed on a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription id

docker

Commands to manage your Docker Virtual Machine

create

Create a Docker virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the virtual machine name

Port to use for docker [2376]

Directory containing docker certs [~/.docker/]

Version of Docker Azure extension [0.6]

Docker server certificate's CN. Can be set if you are using --tlsverify option for Docker connections. Default value is [*]

the NIC identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkInterfaces/<nic-name>

the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary.

the location

the operating system Type, valid values are Windows, Linux

the image name [image-name and image-urn parameters are mutually exclusive]

the image URN in the form publisherName:offer:skus:version [image-urn and image-name parameters are mutually exclusive]

the user name
      This parameter is valid for a VM created from an image (image-name, image-urn) and ignored when VM is based on disk (os-disk-*)

the password
      This parameter is valid for a VM created from an image (image-name, image-urn) and ignored when VM is based on disk (os-disk-*)

path to public key PEM file or SSH Public key file for SSH authentication
     This parameter is valid only when os-type is "Linux"

Auto generate SSH keys, --ssh-publickey-file will be ignored. This parameter is valid only when os-type is "Linux"

the virtual machine size [Standard_A1]

the public ip identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public ip domain name
     This sets the DNS to <publicip-domain-name>.<location>.cloudapp.azure.com
     This parameter will be used only when creating new public IP

the public ip allocation method, valid values are "Dynamic"
     This parameter will be used only when creating new public IP

the public ip idle timeout specified in minutes
     This parameter will be used only when creating new public IP

the subnet identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>

the virtual network name
     If this is an existing vnet then it must exists under the current resource group identified by resource-group
     If this is an existing vnet then vnet-subnet-name is required
          If no subnet exists with name vnet-subnet-name then a new subnet will be created
          To create new subnet vnet-subnet-address-prefix is required
     A new vnet will be created if no vnet exists with name vnet-name in the current resource group
     To create new vnet, vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix are required
     Please use subnet-id to refer an existing subnet under a vnet in a different resource group
     vnet-name, vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix will be ignored when subnet-id is specified

the virtual network address prefix in IPv4/CIDR format

the virtual network subnet name

the virtual network subnet address prefix in IPv4/CIDR format

the availability set name

the storage account name

the storage account container name [vhds]

data disk caching, valid values are None, ReadOnly, ReadWrite

name or url of the data disk Vhd

data disk size in GB

Will use existing VHD if specified. Don't specify this param if you are creating data disk from a new VHD.

CustomData file

the subscription identifier

image

Commands to manage VM images

list-publishers

Lists virtual machines image publishers

use verbose output

more verbose with debug output

use json output

the location

the subscription identifier

list-offers

Lists virtual machines image offers by a publisher

use verbose output

more verbose with debug output

use json output

the location

the publisher name

the subscription identifier

list-skus

Lists virtual machines image skus for a specific offer from a publisher

[options] <location> <publisher> <offer>

use verbose output

more verbose with debug output

use json output

the location

the publisher name

the offer

the subscription identifier

list

Lists the virtual machines images

[options] <location> <publisher> [offer] [sku]

use verbose output

more verbose with debug output

use json output

the location

the publisher name

the offer

the sku

the subscription identifier

webapp

Commands to manage your Azure webapps

create

create a web app

[options] [resource-group] [name] [location] [plan]

use verbose output

more verbose with debug output

use json output

Name of the resource group

the name of the webapp to create

the name of the slot

the geographic region to create the webapp

the name of the app service plan eg: Default1.

the subscription identifier

stop

Stop a web app

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to stop

the name of the slot

the subscription id

start

Start a web app

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to start

the name of the slot

the subscription id

restart

Stop and then start a web app

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to restart

the name of the slot

the subscription id

delete

Delete a webapp

use verbose output

more verbose with debug output

use json output

Name of the resource group

the name of the webapp to delete

the name of the slot to be deleted

quiet mode, do not ask for delete confirmation

the subscription identifier

list

List your webapps

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get an available webapp

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to show

the name of the slot to show

the subscription identifier

output the application version

help

Display help for a given command

use verbose output

more verbose with debug output

use json output

login

Log in to an Azure subscription using Active Directory. Currently, the user can login only via Microsoft organizational account

use verbose output

more verbose with debug output

use json output

user name or service principal ID, will prompt if not given

Environment to authenticate against, must support active directory

user password or service principal key, will prompt if not given

If given, log in as a service principal rather than a user

Tenant domain or ID to log into. Used for login as service principal or parnter user

do not prompt for confirmation of PII storage

logout

Log out from Azure subscription using Active Directory. Currently, the user can log out only via Microsoft organizational account

use verbose output

more verbose with debug output

use json output

Required. User name used to log out from Azure Active Directory.

portal

Open the portal in a browser

use verbose output

more verbose with debug output

use json output

the publish settings download environment

the organization's realm

account

Commands to manage your account information and publish settings

list

List the imported subscriptions

use verbose output

more verbose with debug output

use json output

show

Show details about a subscription

use verbose output

more verbose with debug output

use json output

The subscription to show

Show extra information about the subscription

set

Set the current subscription

use verbose output

more verbose with debug output

use json output

clear

Remove a subscription or environment, or clear all of the stored account and environment info

use verbose output

more verbose with debug output

use json output

Subscription name or id to remove

Environment name to remove

env

Commands to manage your account environment

list

List the environments

use verbose output

more verbose with debug output

use json output

show

Show an environment

use verbose output

more verbose with debug output

use json output

the environment name

add

Add an environment

use verbose output

more verbose with debug output

use json output

the environment name

the management portal URL

the Active Directory api version

the management service endpoint

the resource management endpoint

the sql server management endpoint for mobile commands

the dns suffix for sql servers

the publish settings file URL

The resource ID to obtain AD tokens for

the Active Directory common tenant name

the template gallery endpoint

the Active Directory resource ID

the Active Directory login endpoint

set

Update an environment

use verbose output

more verbose with debug output

use json output

the environment name

the management portal URL

the Active Directory login endpoint

the management service endpoint

the resource management endpoint

the dns suffix for sql servers

the Active Directory api version

The resource ID to obtain AD tokens for

the Active Directory common tenant name

the template gallery endpoint

the Active Directory resource ID

the publish settings file URL

delete

Delete an environment

use verbose output

more verbose with debug output

use json output

the environment name

config

Commands to manage your local settings

list

List config settings

use verbose output

more verbose with debug output

use json output

delete

Delete a config setting

use verbose output

more verbose with debug output

use json output

set

Update a config setting

use verbose output

more verbose with debug output

use json output

mode

Sets the cli working mode, valid names are 'arm' for resource manager and 'asm' for service management

use verbose output

more verbose with debug output

use json output

storage

Commands to manage your Storage objects

account

Commands to manage your Storage accounts

list

List storage accounts

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

show

Show a storage account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

create

Create a storage account

use verbose output

more verbose with debug output

use json output

the location

the account type(LRS/ZRS/GRS/RAGRS/PLRS)

the resource group name

the subscription id

set

Update a storage account

use verbose output

more verbose with debug output

use json output

the account type(LRS/GRS/RAGRS)

the resource group name

the subscription id

delete

Delete a storage account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

quiet mode, do not ask for delete confirmation

keys

Commands to manage your Storage account keys

list

List the keys for a storage account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

renew

Renew a key for a storage account from your account

use verbose output

more verbose with debug output

use json output

Update the primary key

Update the secondary key

the resource group name

the subscription id

connectionstring

Commands to show your Storage connection string

show

Show the connection string for your account

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription id

Use http as default endpoints protocol

the blob endpoint

the queue endpoint

the table endpoint

the file endpoint

container

Commands to manage your Storage containers

list

List storage containers with wildcard

use verbose output

use json output

the storage container name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the specified storage container

use verbose output

use json output

the storage container name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

create

Create a storage container

use verbose output

use json output

the storage container name

the storage container ACL permission(Off/Blob/Container)

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage container

use verbose output

use json output

the storage container name

remove the specified Storage container without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set storage container ACL

use verbose output

use json output

the storage container name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage container

create

Generate shared access signature of storage container

[options] [container] [permissions] [expiry]

use verbose output

use json output

the storage container name

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage container

create

Create a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the container

use verbose output

use json output

the storage container name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the container

use verbose output

use json output

the storage container name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

blob

Commands to manage your Storage blobs

list

List storage blob in the specified storage container use wildcard and blob name prefix

use verbose output

use json output

the storage container name

the blob name prefix

the shared access signature of the storage container

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the specified storage blob

use verbose output

use json output

the storage container name

the storage blob name

the shared access signature of the storage container or blob

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage blob

use verbose output

use json output

the storage container name

the storage blob name

remove the specified Storage blob without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

upload

Upload the specified file to storage blob

use verbose output

use json output

the local file path

the storage container name

the storage blob name

the storage blob type(block, page, append)

the storage blob metadata for uploaded file. Metadata are key=value pairs and separated with semicolon(;)

the maximum number of concurrent upload requests

overwrite the specified Storage blob without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

download

Download the specified storage blob

[options] [container] [blob] [destination]

use verbose output

use json output

the storage container name

the storage blob name

download destination file or directory path

check md5sum for the downloaded file

the maximum number of concurrent download requests

overwrite the destination file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

copy

Commands to manage your blob copy operations

start

Start to copy the resource to the specified storage blob which completes asynchronously

use verbose output

use json output

the shared access signature of the source storage

the source storage blob or file absolute uri

the source storage container name

the source storage blob name

the destination storage account name

the destination storage account key

the destination storage connection string

the shared access signature of the destination storage container or blob

the destination storage container name

the destination storage blob name

overwrite the destination blob without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show the copy status

use verbose output

use json output

the destination container in the blob copy start operation

the destination blob in the blob copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

stop

Stop the copy operation

use verbose output

use json output

the copy ID which is returned from blob copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signature of your Storage blob

create

Generate shared access signature of storage blob

[options] [container] [blob] [permissions] [expiry]

use verbose output

use json output

the storage container name

the storage blob name

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

share

Commands to manage your Storage file shares

create

Create a storage file share

use verbose output

use json output

the storage file share name

the storage file share quota (in GB)

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the storage file share

use verbose output

use json output

the storage file share name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set properties of the storage file share

use verbose output

use json output

the storage file share name

the storage file share quota (in GB)

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage file share

use verbose output

use json output

the storage file share name

remove the specified storage file share without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List storage shares with prefix

use verbose output

use json output

the storage share name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage file shares

create

Generate shared access signature of storage share

[options] [share] [permissions] [expiry]

use verbose output

use json output

the storage share name

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage file share

create

Create a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the share

use verbose output

use json output

the storage share name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the share

use verbose output

use json output

the storage share name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

file

Commands to manage your Storage files

list

List storage files in the specified share under specific path

use verbose output

use json output

the storage share name

the path to be listed

the shared access signature of the storage file share

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage file

use verbose output

use json output

the storage share name

the path to the storage file

remove the specified storage file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

upload

Upload the specified local file to storage

use verbose output

use json output

the local file path

the storage share name

the path to the storage file

the maximum number of concurrent upload requests

overwrite the specified storage file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

download

Download the specified storage file

use verbose output

use json output

the storage share name

the path to the storage file

path to the destination file or directory

check md5sum for the downloaded file

overwrite the destination file without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

copy

Commands to manage your file copy operations

start

Start to copy the resource to the specified storage file which completes asynchronously

use verbose output

use json output

the shared access signature of the source storage

the source storage blob or file absolute uri

the source storage share name

the source storage file path

the destination storage account name

the destination storage account key

the destination storage connection string

the shared access signature of the destination storage share or file

the destination storage share name

the destination storage file path

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show the copy status

use verbose output

use json output

the destination share in the file copy start operation

the destination file path in the file copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

stop

Stop the copy operation

use verbose output

use json output

the copy ID which is returned from file copy start operation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage file

create

Generate shared access signature of storage file

[options] [share] [path] [permissions] [expiry]

use verbose output

use json output

the storage share name

the path to the storage file

the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

directory

Commands to manage your Storage file directory

create

Create a storage file directory

use verbose output

use json output

the storage file share name

the path to the storage file directory to be created

the shared access signature of the storage file share

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage file directory

use verbose output

use json output

the storage share name

the path to the storage file directory to be deleted

remove the specified storage file directory without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

queue

Commands to manage your Storage queues

create

Create a storage queue

use verbose output

use json output

the storage queue name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List storage queues with wildcard

use verbose output

use json output

the storage queue name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the storage able

use verbose output

use json output

the storage queue name

the shared access signature of the storage queue

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage queue

use verbose output

use json output

the storage queue name

remove the specified storage queue without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage queue

create

Generate shared access signature of storage queue

[options] [queue] [permissions] [expiry]

use verbose output

use json output

the storage queue name

the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process)

the UTC time at which the SAS expires

the stored access policy identifier

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage queue

create

Create a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the queue

use verbose output

use json output

the storage queue name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the queue

use verbose output

use json output

the storage queue name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

logging

Commands to manage your Storage logging properties

show

Show the logging properties of the storage services

use verbose output

use json output

show logging properties for blob service

show logging properties for table service

show logging properties for queue service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set the logging properties of the storage service

use verbose output

use json output

set logging properties for blob service

set logging properties for table service

set logging properties for queue service

the version string

set logging retention in days

enable logging for read requests

disable logging for read requests

enable logging for write requests

disable logging for write requests

enable logging for delete requests

disable logging for delete requests

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

metrics

Commands to manage your Storage metrics properties

show

Show the metrics properties of the storage services

use verbose output

use json output

show metrics properties for blob service

show metrics properties for table service

show metrics properties for queue service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set the metrics properties of the storage service

use verbose output

use json output

set metrics properties for blob service

set metrics properties for table service

set metrics properties for queue service

the version string

set metrics retention in days

set hourly metrics properties

turn off hourly metrics properties

set minute metrics properties

turn off minute metrics properties

include API in metrics

exclude API from metrics

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

cors

Commands to manage your Storage CORS (Cross-Origin Resource Sharing)

set

Set the CORS rules of the storage service

use verbose output

use json output

set CORS rules for blob service

set CORS rules for table service

set CORS rules for queue service

set CORS rules for file service

the CORS rules array in json format

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show the CORS rules of the storage service

use verbose output

use json output

show CORS rules for blob service

show CORS rules for table service

show CORS rules for queue service

show CORS rules for file service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete all the CORS rules of the storage service

use verbose output

use json output

delete CORS rules for blob service

delete CORS rules for table service

delete CORS rules for queue service

delete CORS rules for file service

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

table

Commands to manage your Storage tables

create

Create a storage table

use verbose output

use json output

the storage table name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List storage tables with wildcard

use verbose output

use json output

the storage table name prefix

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show details of the storage able

use verbose output

use json output

the storage table name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete the specified storage table

use verbose output

use json output

the storage table name

remove the specified storage table without confirmation

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

sas

Commands to manage shared access signatures of your Storage table

create

Generate a shared access signature of storage table

[options] [table] [permissions] [expiry]

use verbose output

use json output

the storage table name

the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete)

the UTC time at which the SAS becomes valid

the UTC time at which the SAS expires

the stored access policy identifier

the inclusive starting partition key

the inclusive ending partition key

the inclusive starting row key

the inclusive ending row key

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

policy

Commands to manage stored access policies of your Storage table

create

Create a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the UTC time at which the policy becomes valid

the UTC time at which the policy expires

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

show

Show a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

list

List stored access policies on the table

use verbose output

use json output

the storage table name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

set

Set a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting

the UTC time at which the policy expires and passing two spaces means to remove the existing setting

the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete) and passing two spaces means to remove the existing setting

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

delete

Delete a stored access policy on the table

use verbose output

use json output

the storage table name

the policy name

the storage account name

the storage account key

the storage connection string

run storage command in debug mode

ad

Commands to display active directory objects

app

Commands to display active directory applications

create

Creates a new active directory application

use verbose output

more verbose with debug output

use json output

the display name for the application

the URL to the application homepage

indicates if the application will be available to other tenants

the value for the password credential associated with the application that will be valid for one year by default

the comma-delimitied URIs that identify the application

the value for the key credentials associated with the application that will be valid for one year by default

the type of the key credentials associated with the application. Acceptable values are AsymmetricX509Cert, Password and Symmetric

the usage of the key credentials associated with the application. Acceptable values are Sign and Verify

the start date after which password or key would be valid. Default value is current time

the end date till which password or key is valid. Default value is one year after current time

delete

Deletes the active directory application

use verbose output

more verbose with debug output

use json output

the object id of the application to remove

quiet mode (do not ask for delete confirmation)

group

Commands to display active directory groups

list

Get active directory groups in current subscription's tenant

use verbose output

more verbose with debug output

use json output

Provides paging support. Press 'Enter' for more information.

show

Get active directory groups

use verbose output

more verbose with debug output

use json output

the object Id of the group to return

Search by display name which starts with the provided value

member

Commands to provide an active directory sub group or member info

list

Provides an active directory sub group or member info

use verbose output

more verbose with debug output

use json output

Object id of group whose members to return.

sp

Commands to display active directory service principals

list

Get all active directory service principals in current subscription's tenant

use verbose output

more verbose with debug output

use json output

show

Get active directory service principals

use verbose output

more verbose with debug output

use json output

the name of the service principal to return

the object id of the service principal to return

search display name of the service principal starting with the provided value

create

Create active directory service principal

use verbose output

more verbose with debug output

use json output

the application Id for which service principal is created

delete

Deletes active directory service principal

use verbose output

more verbose with debug output

use json output

the object id of the service principal to delete

quiet mode (do not ask for delete confirmation)

user

Commands to display active directory users

list

Get all active directory users in current subscription's tenant

use verbose output

more verbose with debug output

use json output

Provides paging support. Press 'Enter' for more information.

show

Get an active directory user

use verbose output

more verbose with debug output

use json output

the principal name of the user to return

the object id of the user to return

search users with display name starting with the provided value

apiapp

Commands to manage ApiApps

list

List currently deployed ApiApps in a subscription or resource group

use verbose output

more verbose with debug output

use json output

the resource group name, if not given list all ApiApps in subscription

The subscription identifier

Include ApiApp package version and auth setting (call will be slower)

show

Get detailed information about a deployed ApiApp

use verbose output

more verbose with debug output

use json output

Name of the resource group containing the ApiApp

Name of the ApiApp

The subscription identifier

create

Create a new ApiApp instance

[options] [resource-group] [name] [plan]

use verbose output

more verbose with debug output

use json output

Name of the ApiApp instance

Name of the resource group

Name or Resource Id of the App Service Plan to use

Package name and version to deploy (optional)

A JSON-formatted string containing parameters

A file containing parameters in JSON format

The subscription identifier

Do not wait for the deployment to complete

package

Commands to create and publish ApiApp packages

Create an ApiApp package that can be published

use verbose output

more verbose with debug output

use json output

Directory containing source to be packaged

Directory or filename to generate

availset

Commands to manage your availablilty sets

create

Creates an availability set within a resource group

[options] <resource-group> <name> <location> [tags]

use verbose output

more verbose with debug output

use json output

the resource group name

the availability set name

the location

the semicolon separated list of tags

the subscription identifier

list

Lists the availability sets within a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription identifier

show

Gets one availability set within a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the availability set name

the number of times to recurse, to recurse indefinitely pass "full". (valid only with --json option)

the subscription identifier

delete

Deletes one availability set within a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

quiet mode, do not ask for delete confirmation

the subscription identifier

feature

Commands to manage your features

list

List all features available for your subscription

use verbose output

more verbose with debug output

use json output

the subscription identifier

show

Shows a feature

use verbose output

more verbose with debug output

use json output

the resource provider name

the feature name

the subscription identifier

register

Registers a previewed feature of a resource provider.

use verbose output

more verbose with debug output

use json output

the resource provider name

the feature name

the subscription identifier

group

Commands to manage your resource groups

create

Creates a new resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the location where we will create the group

the name of the deployment we will create (only valid when a template is used)

the name of the template in the gallery

the path to the template file in the file system

the uri to the remote template file

the content version of the template

the storage account where we will upload the template file

a JSON-formatted string containing parameters

a file containing parameters

Tags to set to the resource group. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

the subscription identifier

set

Set tags to a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

remove all existing tags

the subscription identifier

delete

Deletes a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

quiet mode (do not ask for delete confirmation)

the subscription identifier

list

Lists the resource groups for your subscription

use verbose output

more verbose with debug output

use json output

show additional resource group details such as resources, permissions etc.

the subscription identifier

show

Shows a resource group for your subscription

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription identifier

log

Commands to manage resource group logs

Retrieves and shows logs for resource group operations

use verbose output

more verbose with debug output

use json output

the resource group name

returns logs for all operations (including CRUD and deployment)

returns logs for the last deployment

the name of the deployment whose logs you want to see

the subscription identifier

deployment

Commands to manage your deployment in a resource group

create

Creates a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the deployment

the name of the template in the gallery

the uri to the remote template file

the content version of the template

a file containing parameters

does not wait for the deployment to complete. Returns as soon as the deployment is created

the subscription identifier

list

Gets deployments

use verbose output

more verbose with debug output

use json output

the name of the resource group.

filter the deployments by provisioning state (valid values are Accepted, Running, Failed, and Succeeded)

subscription containing deployments to list (optional)

show

Shows a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group.

the name of the deployment (if not specified, the most recent deployment is shown)

subscription containing the deployment to display (optional)

stop

Stops a deployment

use verbose output

more verbose with debug output

use json output

the name of the resource group

quiet mode (do not ask for stop deployment confirmation)

the name of the deployment (if not specified, the currently running deployment is stopped)

the subscription identifier

template

Commands to manage your local or gallery resource group template

list

Lists gallery resource group templates

use verbose output

more verbose with debug output

use json output

the category of the templates to list

the publisher of the templates to list

the Azure subscription to run against

show

Shows a gallery resource group template

use verbose output

more verbose with debug output

use json output

the name of template to show

the Azure subscription to run against

download

Downloads a gallery resource group template

use verbose output

more verbose with debug output

use json output

the name of the template to download

the name of the destination directory or file

quiet mode (do not prompt for overwrite if output file exists)

the Azure subscription to run against

validate

Validates a template to see whether it's using the right syntax, resource providers, resource types, etc.

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the template in the gallery

the path to the template file in the file system

the uri to the remote template file

the content version of the template

the storage account where we will upload the template file

a JSON-formatted string containing parameters

a file containing parameters

the subscription identifier

insights

Commands related to monitoring Insights (events, alert rules, autoscale settings, metrics)

logs

Retrieve operation logs for a subscription, a correlationId, a resource group, resource, or resource provider.

list

List operation logs for a subscription.

use verbose output

more verbose with debug output

use json output

The correlation id of the query.

The resource group.

The resource Id.

The resource provider.

The start time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The end time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The status.

Caller to look for when querying.

Shows the details of the events in the log.

The subscription identifier.

alerts

Retrieve alerts logs

list

List alert logs for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The status.

Caller to look for when querying.

The subscription identifier.

rule

Retrieve alerts rules

List alert rules for a resource.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the rule to query.

The target resource of the query.

The subscription identifier.

delete

Deletes an alert rule.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the rule to query.

The subscription identifier.

set

Create or set a metric alert rule.

[options] <ruleType> <ruleName> <location> <resourceGroup>

use verbose output

more verbose with debug output

use json output

The type of the rule (Event, Metric, Webtest).

Flag to disable the rule.

The subscription identifier.

The name of the rule.

The description of the rule.

The location.

The resource group.

The time window size. Expected format hh:mm:ss.

Flag to send e-mail to service owners.

The list of custom e-mail addresses.

The condition operator: GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual. Value is case insensitive.

The threshold.

The resource Id.

The metric name.

The time aggregation operator: Average, Minimum, Maximum, Total. Value is case insensitve.

The event name.

The event source.

The level for the rule.

The operation name.

The resource provider.

The status.

The substatus.

The e-mail address.

The failed location.

autoscale

Retrieve autoscale logs

list

List autoscale logs for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The status.

Caller to look for when querying.

The subscription identifier.

profile

Manages autoscale profiles

set

Create or set an autoscale profile.

[options] <profileType> <profileName> <defaultCapacity> <maximumCapacity> <minimumCapacity> <rules>

use verbose output

more verbose with debug output

use json output

The type of the profile: NoSchedule, FixedDate, Recurrent (the value case insensitive)

The name of the profile.

The default capacity of the profile.

The maximum capacity of the profile.

The minimum capacity of the profile.

The rules of the profile. A json string containing a listing of scale rules.

The start time window of a fixed date schedule.

The end time window of a fixed date schedule.

The time window timezone of a fixed date schedule.

The recurrence frequency of a recurrent schedule: None, Second, Minute, Hour, Day, Week, Month, Year (the value is case insensitive)

The list of schedule days a recurrent schedule. Values are comma-separated.

The list of schedule hours a recurrent schedule. Values are comma-separated.

The list of schedule minutes a recurrent schedule. Values are comma-separated.

The list of schedule timezone a recurrent schedule.

rule

Manages autoscale rules

set

Create or set an autoscale rule.

[options] <metricName> <metricResourceId> <conditionOperatorType> <metricStatisticType> <threshold> <timeGrain> <actionCooldown> <actionDirection> <actionType> <scaleValue>

use verbose output

more verbose with debug output

use json output

The metric name.

The resource Id.

The condition operator: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual. The value is case insensitive.

The metric statistic type: Average, Min, Max, Sum. The value is case insensitive.

The threshold.

The time grain. Expected format hh:mm:ss.

The scale action cooldown time. Expected format hh:mm:ss.

The scale action direction: None, Increase, Decrease. The value is case insensitive.

The scale action type name: ChangeSize, ChangeCount, PercentChangeCount, ExactCount. The value is case insensitive.

The scale action value.

The time aggregation operator: Average, Minimum, Maximum, Total. The value is case insensitive.

The time window size. Expected format hh:mm:ss.

setting

Manages autoscale settings

list

List autoscale settings for a resource.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the setting.

delete

Deletes an autoscale setting.

use verbose output

more verbose with debug output

use json output

The resource group.

The name of the setting.

set

Create or set an autoscale setting.

use verbose output

more verbose with debug output

use json output

Flag to disable the setting.

A list of autoscale profiles in JSON format.

The resource group.

The name of the setting.

The location.

The resource Id.

The setting spec in JSON format.

metrics

Retrieve metrics values resource

list

List metric values for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The start time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The end time of the query. In ISO format with explicit indication of timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500

The list of metric names.

The subscription identifier.

definition

Retrieves metric definitions for a resource

List metric definitions for a resource.

use verbose output

more verbose with debug output

use json output

The resource Id.

The list of metric names.

The subscription identifier.

usage

Retrieve usage metrics for a resource.

list

List usage metrics for a resource.

use verbose output

more verbose with debug output

use json output

The underlying resource provider API version.

The list of metric names.

The subscription identifier.

keyvault

Commands to manage key vault instances in the Azure Key Vault service

list

Lists existing vaults

use verbose output

more verbose with debug output

use json output

lists only vaults belonging to the informed resource group

the subscription identifier

create

Creates a vault

[--vault-name] <vault-name> --resource-group <resource-group> --location <location> [options]

use verbose output

more verbose with debug output

use json output

the vault name; this is used to compute the vault's DNS name

the resource group name

Azure region in which to create the vault

SKU setting, one of: [Standard, Premium]

Tags to set on the vault. Can be multiple in the format 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

the subscription identifier

set-attributes

Changes attributes of an existing vault

use verbose output

more verbose with debug output

use json output

the vault name

changes only if vault belongs to the informed resource group; otherwise returns 'not found'

remove previously existing tags; can combined with --tags

the subscription identifier

show

Shows properties of a vault

use verbose output

more verbose with debug output

use json output

the vault name

shows only if vault belongs to the informed resource group; otherwise returns 'not found'

the subscription identifier

delete

Deletes an existing vault

use verbose output

more verbose with debug output

use json output

the vault name

deletes only if vault belongs to the informed resource group; otherwise returns 'not found'

quiet mode (do not ask for delete confirmation)

outputs the deleted vault

the subscription identifier

set-policy

Adds or modifies an access policy for a vault

use verbose output

more verbose with debug output

use json output

the vault name

a GUID that identifies the principal that will receive permissions

name of a service principal that will receive permissions

name of a user principal that will receive permissions

JSON-encoded array of strings representing secret operations; each string can be one of [all, set, get, list, delete]

reserved for future use

the subscription identifier

delete-policy

Removes an access policy from a vault

use verbose output

more verbose with debug output

use json output

the vault name

a GUID that identifies the principal that will lose permissions

name of a service principal that will lose permissions

name of a user principal that will lose permissions

if informed, will set the enabledForDeployment property to false in the vault

the subscription identifier

key

Commands to manage keys in the Azure Key Vault service

list

Lists keys of a vault

use verbose output

more verbose with debug output

use json output

the vault name

list-versions

Lists key versions

[--vault-name] <vault-name> [[--key-name] <key-name>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

lists only versions of this key

create

Creates a key in the vault

[--vault-name] <vault-name> [--key-name] <key-name> --destination <destination> [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the key to be created; if already exists, a new key version is generated

tells if the key is software-protected or HSM-protected; valid values: [Software, HSM]

tells if the key should be enabled; valid values: [false, true]; default is true

key expiration time, in UTC format

time before which key cannot be used, in UTC format

JSON-encoded array of strings representing key operations; each string can be one of [encrypt, decrypt, sign, verify, wrapKey, unwrapKey]

Tags to set on the key. Can be multiple in the format 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

import

Imports an existing key into a vault

[--vault-name] <vault-name> [--key-name] <key-name> ( --pem-file | --byok-file ) <file-name> [--destination <destination>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the key to be imported; if already exists, a new key version is generated

name of a PEM file containing the key to be imported; the file must not be password protected

name of a BYOK file containing the key to be imported

password of key file; if not informed and the file is encrypted, will prompt

key expiration time, in UTC format

set-attributes

Changes attributes of an existing key

[--vault-name] <vault-name> [--key-name] <key-name> [[--key-version] <key-version>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the key to be modified

the version to be modified; if ommited, modifies only the most recent

if informed, command will change the enabled state; valid values: [false, true]

if informed, command will change key expiration time; must be a date in UTC format or null

if informed, command will change time before which key cannot be used; must be a date in UTC format or null

remove previously existing tags; can combined with --tags

show

Shows properties of a vault key

use verbose output

more verbose with debug output

use json output

the vault name

the key name

the key version; if ommited, uses the most recent

delete

Deletes a key from the vault

[--vault-name] <vault-name> [--key-name] <key-name> [options]

use verbose output

more verbose with debug output

use json output

the vault name

the key name

quiet mode (do not ask for delete confirmation)

outputs the deleted key

backup

Generates a protected backup of a vault key

[--vault-name] <vault-name> [--key-name] <key-name> [--output-file] <output-file> [options]

use verbose output

more verbose with debug output

use json output

the vault name

the key name

name of the binary file that will contain backup data

restore

Restores a backed up key to a vault

[--vault-name] <vault-name> [--input-file] <input-file> [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the binary file that contains backup data

secret

Commands to manage secrets in the Azure Key Vault service

list

Lists secrets of a vault

use verbose output

more verbose with debug output

use json output

the vault name

list-versions

Lists secret versions

[--vault-name] <vault-name> [[--secret-name] <secret-name>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

lists only versions of this secret

set

Stores a secret on the vault

[--vault-name] <vault-name> [--secret-name] <secret-name> [--value] <secret-value> [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the secret to be created; if already exists, a new secret version is created

the secret value

tells if the secret should be enabled; valid values: [false, true]; default is true

expiration time of secret, in UTC format

time before which secret cannot be used, in UTC format

Tags to set on the secret. Can be multiple in the format 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

set-attributes

Changes attributes of an existing secret

[--vault-name] <vault-name> [--secret-name] <secret-name> [[--secret-version] <secret-version>] [options]

use verbose output

more verbose with debug output

use json output

the vault name

name of the secret to be modified

the version to be modified; if ommited, modifies only the most recent

if informed, command will change the enabled state; valid values: [false, true]

if informed, command will change secret expiration time; must be a date in UTC format or null

if informed, command will change time before which secret cannot be used; must be a date in UTC format or null

remove previously existing tags; can combined with --tags

show

Shows a vault secret

use verbose output

more verbose with debug output

use json output

the vault name

the secret name

the secret version; if ommited, uses the most recent

delete

Deletes a secret from the vault

[--vault-name] <vault-name> [--secret-name] <secret-name> [options]

use verbose output

more verbose with debug output

use json output

the vault name

the secret name

quiet mode (do not ask for delete confirmation)

outputs the deleted secret

location

Commands to get the available locations for all resource types

list

list the available locations

use verbose output

more verbose with debug output

use json output

the subscription identifier

network

Commands to manage network resources

vnet

Commands to manage virtual networks

create

Create a virtual network

[options] <resource-group> <name> <location>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the location

the comma separated list of address prefixes for this virtual network.
     For example -a 10.0.0.0/24,10.0.1.0/24.
     Default value is 10.0.0.0/8

the comma separated list of DNS servers IP addresses

the tags set on this virtual network.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set virtual network

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the comma separated list of DNS servers IP addresses.
     This list will be appended to the current list of DNS server IP addresses.

remove all existing tags

the subscription identifier

list

Get all virtual networks

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a virtual network

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the subscription identifier

delete

Delete a virtual network

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

quiet mode, do not ask for delete confirmation

the subscription identifier

subnet

Commands to manage virtual network subnets

create

Create virtual network subnet

[options] <resource-group> <vnet-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the name of the subnet

the address prefix

the network security group identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkSecurityGroups/<nsg-name>

the network security group name

the route table identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/routeTables/<route-table-name>

the route table name

the subscription identifier

set

Set a virtual network subnet

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the name of the subnet

the address prefix

the network security group name

the route table name

the subscription identifier

list

Get all virtual network subnets

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the subscription identifier

show

Get a virtual network subnet

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the name of the subnet

the subscription identifier

delete

Delete a subnet of a virtual network

[options] <resource-group> <vnet-name> <subnet-name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the virtual network

the subnet name

the subscription identifier

lb

Commands to manage load balancers

create

Create a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the location

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional. For example, -t "tag1=value1;tag2"

the subscription identifier

list

Get all load balancers

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

probe

Commands to manage probes of a load balancer

create

Add a probe to the load balancer

[options] <resource-group> <lb-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the probe

the probe protocol

the probe port

the probe path

the probe interval in seconds

the number of probes

the subscription identifier

set

Set a probe of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the probe

the new name of the probe

the new value for probe protocol

the new value for probe port

the new value for probe path

the new value for probe interval in seconds

the new value for number of probes

the subscription identifier

list

Get all probes in a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a probe from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the probe name

the subscription identifier

frontend-ip

Commands to manage frontend ip configurations of a load balancer

create

Add a frontend ip configuration to the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the frontend ip configuration

the private ip address

the public ip identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public ip name.
     This public ip must exist in the same resource group as the lb.
     Please use public-ip-id if that is not the case.

the subnet id.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/VirtualNetworks/<vnet-name>/subnets/<subnet-name>

the subnet name

the virtual network name.
     This virtual network must exist in the same resource group as the lb.
     Please use subnet-id if that is not the case.

the subscription identifier

set

Set a frontend ip configuration of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the private ip address

the subnet name

the subscription identifier

list

Get all frontend ip configurations in the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a frontend ip configuration from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

quiet mode, do not ask for delete confirmation

the subscription identifier

address-pool

Commands to manage backend address pools of a load balancer

create

Add an address pool to the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the backend address pool

the subscription identifier

list

Get all address pools in the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete an address pool from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the backend address pool

the subscription identifier

rule

Commands to manage load balancer rules

create

Add a load balancing rule to a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the rule

the rule protocol

the frontend port

the backend port

enable floating point ip

the idle timeout specified in minutes

the name of the probe defined in the same load balancer

the name of the frontend ip configuration in the same load balancer

name of the backend address pool defined in the same load balancer

the subscription identifier

set

Set a load balancing rule of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the rule

new rule name

the rule protocol

the frontend port

the backend port

enable floating point ip

the idle timeout specified in minutes

the subscription identifier

list

Get all load balancing rules of a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a load balancing rule from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the rule

the subscription identifier

inbound-nat-rule

Commands to manage load balancer inbound NAT rules

create

Add a load balancing inbound NAT rule to the load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the inbound NAT rule

the rule protocol [tcp,udp]

the frontend port [0-65535]

the backend port [0-65535]

enable floating point ip [true,false]

the name of the frontend ip configuration

the subscription identifier

set

Set a load balancing inbound NAT rule of load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the inbound NAT rule

the rule protocol [tcp,udp]

the frontend port [0-65535]

the backend port [0-65535]

enable floating point ip [true,false]

the subscription identifier

list

Get all load balancing inbound NAT rules of load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the subscription identifier

delete

Delete a load balancing inbound NAT rule from a load balancer

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the load balancer

the name of the inbound NAT rule

quiet mode, do not ask for delete confirmation

the subscription identifier

public-ip

Commands to manage public ip addresses

create

Create a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public ip

the location

the domain name label.
     This set DNS to <domain-name-label>.<location>.cloudapp.azure.com

the allocation method [Static][Dynamic]

the idle timeout specified in minutes

the reverse fqdn

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public ip

the allocation method [Static][Dynamic]

the idle timeout specified in minutes

the reverse fqdn

remove all existing tags

the subscription identifier

list

Get all public ips

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public IP

the subscription identifier

delete

Delete a public ip

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the public IP

the subscription identifier

nic

Commands to manage network interfaces

create

Create a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the location

the network security group identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkSecurityGroups/<nsg-name>

the network security group name.
     This network security group must exist in the same resource group as the nic.
     Please use network-security-group-id if that is not the case.

the public IP identifier.
     e.g. /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public IP name.
     This public ip must exist in the same resource group as the nic.
     Please use public-ip-id if that is not the case.

the private IP address

the subnet name

the vnet name under which subnet-name exists

the internal DNS name label

the ip forwarding, valid values are [true, false]

the comma seperated list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the private IP address

the subnet name

the internal DNS name label

remove all existing tags

the subscription identifier

list

Get all network interfaces

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

delete

Delete a network interface

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

address-pool

Commands to manage backend address pools of the network interface

add

Add a backend address pool to a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the name of the address pool that exists in the load balancer identified by --lb-name
   This parameter will be ignored if --lb-address-pool-id is specified

the subscription identifier

remove

Remove a backend address pool from a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

inbound-nat-rule

Commands to manage inbound rules of the network interface

add

Add an inbound NAT rule to a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the name of the NAT rule that exists in the load balancer identified by --lb-name

the subscription identifier

remove

Remove an inbound NAT rule from a NIC

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network interface

the subscription identifier

nsg

Commands to manage network security groups

create

Create a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the location

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

remove all existing tags

the subscription identifier

list

Get all network security groups

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the subscription identifier

delete

Delete a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

quiet mode, do not ask for delete confirmation

the subscription identifier

rule

Commands to manage network security group rules

create

Create a network security group rule

[options] <resource-group> <nsg-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the description

the protocol [Tcp,Udp,*]

the source address prefix

the source port range [0-65535]

the destination address prefix

the destination port range [0-65535]

the access mode [Allow,Deny]

the priority [100-4096]

the direction [Inbound,Outbound]

the subscription identifier

set

Set a network security group rule

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the description

the protocol [Tcp,Udp,*]

the source address prefix

the source port range [0-65535]

the destination address prefix

the destination port range [0-65535]

the access mode [Allow,Deny]

the priority [100-4096]

the direction [Inbound,Outbound]

the subscription identifier

list

Get all rules in a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the subscription identifier

show

Get a rule in a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the subscription identifier

delete

Delete a rule in a network security group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the network security group

the name of the rule

the subscription identifier

dns-zone

Commands to manage DNS zone

create

Create a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

set

Set a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

remove all existing tags

the subscription identifier

list

Get all DNS zones

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone
   You can specify "*" (in quotes) for this parameter

the subscription identifier

delete

Delete a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

dns-record-set

Commands to manage record sets in DNS zone

create

Create a DNS zone record set

[options] <resource-group> <dns-zone-name> <name> <type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the relative name of the record set within the DNS zone

the type of the record set.
     Valid values are [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT, PTR]

time to live specified in seconds

the tags set on this virtual network.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a DNS zone record set

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

time to live specified in seconds

remove all existing tags

the subscription identifier

list

Get all record sets in a DNS zone

[options] <resource-group> <dns-zone-name> [type]

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the type of the record set.
     If specified only record sets of this type will be listed.
     Valid values are [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT, PTR]

the subscription identifier

show

Get a record set in a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

delete

Delete a record set from a DNS zone

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the subscription identifier

add-record

Add a record in a record set under a DNS zone

[options] <resource-group> <dns-zone-name> <record-set-name> <type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the name of the record set

the type of the record set.
     If specified only record sets of this type will be listed.
     Valid values are [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT, PTR]

The record type A

the IPv4 address attribute

Record type AAAA

the IPv6 address attribute

Record type CNAME

the canonical name (target)

Record type NS

the domain name attribute

Record type MX

preference attribute

exchange attribute

Record type SRV

the priority attribute

the weight attribute

the port

the target attribute

Record type TXT

the text attribute

Record type SOA

the email attribute

the expire time specified in seconds

the serial number

the host name attribute

the minimum time to live specified in seconds

the refresh time specified in seconds

the retry time specified in seconds

Record type PTR

ptr domain name

the subscription identifier

delete-record

Delete a record from a record set under a DNS zone

[options] <resource-group> <dns-zone> <record-set-name> <type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the DNS zone

the name of the record set

preference attribute

exchange attribute

Record type SRV

the priority attribute

the weight attribute

the port

the target attribute

Record type TXT

the text attribute

Record type PTR

ptr domain name

quiet mode, do not ask for delete confirmation

the subscription identifier

traffic-manager

Commands to manage Traffic Manager

profile

Commands to manage Traffic Manager profile

create

Create a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

the profile status, valid values are
     [Enabled, Disabled], default is Enabled

the traffic routing method for the profile,
     valid values are [Performance, Weighted, Priority]

relative DNS name of the profile e.g. .trafficmanager.net

time to live in specified in seconds

the source address prefix, valid values are [http, https]

the monitoring port

the monitoring path

the tags set on this profile. Can be
     multiple, in the format of 'name=value'.
     Name is required and value is optional.
     For example, -t "tag1=value1;tag2"

the subscription identifier

set

Set a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

time to live specified in seconds

the monitoring port

the monitoring path

remove all existing tags

the subscription identifier

list

Get all Traffic Manager profiles

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

the subscription identifier

delete

Delete a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the profile

the subscription identifier

is-dns-available

Checks whether the specified DNS prefix is available for creating a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the relative DNS name to check for availability

the subscription identifier

endpoint

Commands to manage Traffic Manager endpoints

create

Create an endpoint in Traffic Manager profile

[options] <resource-group> <profile-name> <name> <endpoint-location>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the profile name

the name of the endpoint

the location of the endpoint

the endpoint type, valid values are:
       [externalEndpoint] externalEndpoint represents endpoint
       for a service with FQDN external to Azure
       e.g. foobar.contoso.com

the domain name target of the endpoint,
       e.g. foobar.contoso.com

the endpoint status, valid values are:
       [Enabled,Disabled] Default is Enabled

the endpoint weight used in the load balancing algorithm

the endpoint priority used in the load balancing algorithm,
       valid range is [1, 1000]

the subscription identifier

set

Set an endpoint in a Traffic Manager profile

[options] <resource-group> <profile-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the profile name

the name of the endpoint

the subscription identifier

delete

Delete an endpoint from a Traffic Manager profile

use verbose output

more verbose with debug output

use json output

the name of the resource group

the profile name

the name of the endpoint

quiet mode, do not ask for delete confirmation

the subscription identifier

route-table

Commands to manage Route Table

create

Create a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the location, this must be same as the location of the virtual network containing the subnet(s) on which this Route Table needs to be applied

the list of tags.
     Can be multiple. In the format of "name=value".
     Name is required and value is optional. For example, -t "tag1=value1;tag2"

the subscription identifier

show

Get a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the subscription identifier

list

Get all Route Tables

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

delete

Delete a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the subscription identifier

route

Commands to manage Route Table routes

create

Create route in a Route Table

[options] <resource-group> <route-table-name> <name> <address-prefix> <next-hop-type>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the route address prefix e.g. 0.0.0.0/0

the route next hop type, valid values are:
       [VirtualAppliance,VirtualNetworkGateway,VNETLocal,Internet,Null]

the route next hop ip addresses, this parameter is valid
       only for next hop type VirtualAppliance

the subscription identifier

set

Set route in a Route Table

[options] <resource-group> <route-table-name> <name>

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the route address prefix e.g. 0.0.0.0/0

the route next hop ip addresses, this parameter is valid
       only for next hop type VirualAppliance

the subscription identifier

list

List all routes in a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the subscription identifier

show

Show details about route in a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the subscription identifier

delete

Delete route from a Route Table

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the Route Table

the name of the route

the subscription identifier

provider

Commands to manage resource provider registrations

list

List currently registered providers in ARM

use verbose output

more verbose with debug output

use json output

Subscription to list providers for

show

Show details about the requested provider namespace

use verbose output

more verbose with debug output

use json output

the provider namespace to show

subscription to show provider for

register

Register namespace provider with the subscription

use verbose output

more verbose with debug output

use json output

the provider namespace to register

Subscription to register

unregister

Un-register namespace provider with the subscription

use verbose output

more verbose with debug output

use json output

the provider namespace to register

Subscription to register

resource

Commands to manage your resources

create

Creates a resource in a resource group

[options] <resource-group> <name> <resource-type> <location> <api-version>

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the location where we will create the resource

the resource type

the API version of the resource provider

the name of the parent resource (if needed), in path/path/path format

a JSON-formatted string containing properties

Tags to set to the resource group. Can be mutliple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

the subscription identifier

set

Updates a resource in a resource group without any templates or parameters

[options] <resource-group> <name> <resource-type> <properties> <api-version>

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the resource type

Tags to set to the resource. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

remove all existing tags

the subscription identifier

list

Lists the resources

use verbose output

more verbose with debug output

use json output

the resource group name

the resource type

show details such as permissions, etc.

the subscription identifier

show

Gets one resource within a resource group or subscription

[options] <resource-group> <name> <resource-type> <api-version>

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the resource type

the subscription identifier

delete

Deletes a resource in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the resource name

the resource type

quiet mode (do not ask for delete confirmation)

the subscription identifier

role

Commands to manage your Azure roles

list

Get all available role definitions

use verbose output

more verbose with debug output

use json output

If given, display only the custom roles instead of all role definitions

the subscription identifier

show

Get an available role definition

use verbose output

more verbose with debug output

use json output

the role definition name

the subscription identifier

create

create a new role definition

use verbose output

more verbose with debug output

use json output

File name containing a single role definition.

The subscription identifier

set

update an existing role definition

use verbose output

more verbose with debug output

use json output

The subscription identifier

assignment

Commands to manage your role assignment

create

create a new role assignment

[options] [objectId] [upn] [mail] [spn] [role] [scope] [resource-group] [resource-type] [resource-name]

use verbose output

more verbose with debug output

use json output

Object id of an active directory user, group or service principal.

User principal name.

Mail of a user or group.

Service Principal Name.

Role to assign the principals with.

Scope of the role assignment.

Resource group to assign the role to.

Type of the resource to assign the role to.

Name of the resource to assign the role to.

Parent resource of the resource to assign the role to, if there is any.

Subscription id or name of where the role assignment will be created.

list

Get role assignment at a given scope

use verbose output

more verbose with debug output

use json output

User principal name.

Mail of a user or group.

Service Principal Name.

Role the principals was assigned to

Scope of the role assignment.

Resource group to role was assigned to.

Type of the resource the role was assign to

The resource the role was assigned to.

Parent resource of the resource the role was assigned to, if there is any.

Subscription id or name of where the role assignment is from.

delete

delete a role assignment

use verbose output

more verbose with debug output

use json output

Object id of an active directory user, group or service principal

User principal name.

Mail of a user or group.

Service Principal Name.

Role to remove from the principals.

Scope of the role assignment.

Resource group to role was assigned to.

The resource the role was assigned to.

If specified, won't prompt before delete.

Subscription id or name of where the role assignment will be removed.

tag

Commands to manage your resource manager tags

create

add a tag

use verbose output

more verbose with debug output

use json output

Name of the tag. If the tag name doesn't exist, create the tag name; Otherwise, add the value to the existing tag name.

Value of the tag. If specified, add the tag value to the tag name; Otherwise, keep the tag values unchanged.

The subscription identifier.

delete

Remove an entire tag or a tag value

use verbose output

more verbose with debug output

use json output

Name of the tag to remove.

Value of the tag to remove. If not specified, remove the entire tag. If specified, only remove the tag value.

If not specified, will prompt for confirmation. If specified, won't prompt.

The subscription identifier.

list

Lists the tag information

use verbose output

more verbose with debug output

use json output

Show tag values information as well.

The subscription identifier.

show

Get a tag

use verbose output

more verbose with debug output

use json output

The tag name.

The subscription identifier.

usage

Command to view your aggregated Azure usage data

list

List the usage aggregates for a provided time range

use verbose output

more verbose with debug output

use json output

The start of the time range to retrieve data for.

The end of the time range to retrieve data for.

Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour.

When set to true (default), the aggregates are broken down into the instance metadata which is more granular.

Retrieved from previous calls, this is the bookmark used for progress when the responses are paged.

the subscription identifier

vm

Commands to manage your virtual machines

create

Create a virtual machine in a resource group

[options] <resource-group> <name> <location> <os-type>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the NIC identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkInterfaces/<nic-name>

the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary.

the location

the operating system Type, valid values are Windows, Linux

the image name [image-name and image-urn parameters are mutually exclusive]

the image URN in the form publisherName:offer:skus:version [image-urn and image-name parameters are mutually exclusive]

the user name
      This parameter is valid for a VM created from an image (image-name, image-urn) and ignored when VM is based on an existing disk

the password
      This parameter is valid for a VM created from an image (image-name, image-ur) and ignored when VM is based on existing disk

path to public key PEM file or SSH Public key file for SSH authentication
     This parameter is valid only when os-type is "Linux"

Auto generate SSH keys, will be ignored if --ssh-publickey-file is specified. This parameter is valid only when os-type is "Linux"

the virtual machine size [Standard_A1]

the public ip identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public ip domain name
     This sets the DNS to <publicip-domain-name>.<location>.cloudapp.azure.com
     This parameter will be used only when creating new public IP

the public ip allocation method, valid values are "Dynamic"
     This parameter will be used only when creating new public IP

the public ip idle timeout specified in minutes
     This parameter will be used only when creating new public IP

the subnet identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>

the virtual network address prefix in IPv4/CIDR format

the virtual network subnet name

the virtual network subnet address prefix in IPv4/CIDR format

the availability set name

the storage account name

the storage account container name [vhds]

data disk caching, valid values are None, ReadOnly, ReadWrite

name or url of the data disk Vhd

data disk size in GB

Will use existing VHD if specified. Don't specify this param if you are creating data disk from a new VHD.

CustomData file

the subscription identifier

Tags to set to the virtual machine. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, --tags tag1=value1;tag2

quick-create

Create a virtual machine with default resources in a resource group

[options] <resource-group> <name> <location> <os-type> <image-urn> <admin-username> <admin-password>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the location

the operating system Type, valid values are Windows, Linux

the image URN in the form "publisherName:offer:skus:version"

the user name

the password

the subscription identifier

list

Get all virtual machines in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the subscription identifier

show

Get a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the number of times to recurse, to recurse indefinitely pass "full". (valid only with --json option)

the subscription identifier

delete

Delete a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

quiet mode, do not ask for delete confirmation

the subscription identifier

stop

Shutdown a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

restart

Restart a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

start

Start a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

deallocate

Shutdown a virtual machine in a resource group and release the compute resources

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

sizes

Get all available virtual machine sizes

use verbose output

more verbose with debug output

use json output

the location name, use this to get the list of VM sizes available in a location

the virtual machine name, use this to get the list of VM sizes available for a specific VM

the resource group name, required when --vm-name is specified

the subscription identifier

capture

Capture a VM in a resource group as an OS Image or VM Image

[options] <resource-group> <name> <vhd-name-prefix>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

Captured virtual hard disk's name prefix

the storage account container name [vhds]

In case of conflict overwrite the target virtual hard disk if set to true.

Name of the file that will contain a template that can be used to create similar VMs.

the subscription id

generalize

Set the state of a VM in a resource group to Generalized.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

get-instance-view

Get instance view of a VM in a resource group.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription identifier

reset-access

Enables you to reset Remote Desktop Access or SSH settings on a Virtual Machine and to reset the password for the account that has administrator or sudo authority.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the user name

the password

path to public key PEM file for SSH authentication (valid only when os-type is "Linux")

Reset the SSH configuration to default

Version of VM Access extension [1.1]

password expiration

Remove a user account with specified name

the subscription identifier

set

Update a VM in a resource group.

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary.

the virtual machine size

Tags to set to the resource group. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

Remove all tags

the subscription identifier

list-usage

Get usage of compute resources.

use verbose output

more verbose with debug output

use json output

the location

the subscription identifier

disk

Commands to manage your Virtual Machine data disks

attach-new

Attach a new data-disk to a VM in a resource group

[options] <resource-group> <vm-name> <size-in-gb> [vhd-name]

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the disk size in GB

the name for the new VHD

the caching behaviour of disk [None, ReadOnly, ReadWrite]

the storage account name

zero based logical unit number of the data disk

the subscription id

detach

Detach a data-disk attached to a VM in a resource group

[options] <resource-group> <vm-name> <lun>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the data disk lun

the subscription id

attach

[options] <resource-group> <vm-name> [vhd-url]

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the URL of existing VHD

the subscription id

list

Get all data disks of a VM in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription id

extension

Commands to manage VM resource extensions

set

Enable/disable resource extensions for a VM in a resource group

[options] <resource-group> <vm-name> <name> <publisher-name> <version>

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the extension name

the publisher name

the extension version

extension's reference name

public configuration text

public configuration file path

private configuration text

private configuration file path

uninstall extension

Tags to set to the resource group. Can be mutliple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2

quiet mode, do not ask for uninstall confirmation

the subscription id

get

Get extensions installed on a virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the resource group name

the virtual machine name

the subscription id

docker

Commands to manage your Docker Virtual Machine

create

Create a Docker virtual machine in a resource group

use verbose output

more verbose with debug output

use json output

the name of the resource group

the virtual machine name

Port to use for docker [2376]

Directory containing docker certs [~/.docker/]

Version of Docker Azure extension [0.6]

Docker server certificate's CN. Can be set if you are using --tlsverify option for Docker connections. Default value is [*]

the NIC identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/networkInterfaces/<nic-name>

the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary.

the location

the operating system Type, valid values are Windows, Linux

the image name [image-name and image-urn parameters are mutually exclusive]

the image URN in the form publisherName:offer:skus:version [image-urn and image-name parameters are mutually exclusive]

the user name
      This parameter is valid for a VM created from an image (image-name, image-urn) and ignored when VM is based on disk (os-disk-*)

the password
      This parameter is valid for a VM created from an image (image-name, image-urn) and ignored when VM is based on disk (os-disk-*)

path to public key PEM file or SSH Public key file for SSH authentication
     This parameter is valid only when os-type is "Linux"

Auto generate SSH keys, --ssh-publickey-file will be ignored. This parameter is valid only when os-type is "Linux"

the virtual machine size [Standard_A1]

the public ip identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/publicIPAddresses/<public-ip-name>

the public ip domain name
     This sets the DNS to <publicip-domain-name>.<location>.cloudapp.azure.com
     This parameter will be used only when creating new public IP

the public ip allocation method, valid values are "Dynamic"
     This parameter will be used only when creating new public IP

the public ip idle timeout specified in minutes
     This parameter will be used only when creating new public IP

the subnet identifier
     e.g. /subscriptions/<subscriptipn-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/<subnet-name>

the virtual network address prefix in IPv4/CIDR format

the virtual network subnet name

the virtual network subnet address prefix in IPv4/CIDR format

the availability set name

the storage account name

the storage account container name [vhds]

data disk caching, valid values are None, ReadOnly, ReadWrite

name or url of the data disk Vhd

data disk size in GB

Will use existing VHD if specified. Don't specify this param if you are creating data disk from a new VHD.

CustomData file

the subscription identifier

image

Commands to manage VM images

list-publishers

Lists virtual machines image publishers

use verbose output

more verbose with debug output

use json output

the location

the subscription identifier

list-offers

Lists virtual machines image offers by a publisher

use verbose output

more verbose with debug output

use json output

the location

the publisher name

the subscription identifier

list-skus

Lists virtual machines image skus for a specific offer from a publisher

[options] <location> <publisher> <offer>

use verbose output

more verbose with debug output

use json output

the location

the publisher name

the offer

the subscription identifier

list

Lists the virtual machines images

[options] <location> <publisher> [offer] [sku]

use verbose output

more verbose with debug output

use json output

the location

the publisher name

the offer

the sku

the subscription identifier

webapp

Commands to manage your Azure webapps

create

create a web app

[options] [resource-group] [name] [location] [plan]

use verbose output

more verbose with debug output

use json output

Name of the resource group

the name of the webapp to create

the name of the slot

the geographic region to create the webapp

the name of the app service plan eg: Default1.

the subscription identifier

stop

Stop a web app

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to stop

the name of the slot

the subscription id

start

Start a web app

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to start

the name of the slot

the subscription id

restart

Stop and then start a web app

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to restart

the name of the slot

the subscription id

delete

Delete a webapp

use verbose output

more verbose with debug output

use json output

Name of the resource group

the name of the webapp to delete

the name of the slot to be deleted

quiet mode, do not ask for delete confirmation

the subscription identifier

list

List your webapps

use verbose output

more verbose with debug output

use json output

the name of the resource group

the subscription identifier

show

Get an available webapp

use verbose output

more verbose with debug output

use json output

the name of the resource group

the name of the webapp to show

the name of the slot to show

the subscription identifier