setup¶

Create and manage account configuration for azurectl.

compute¶

Compute service which includes virtual machine and image management.

storage¶

Storage service which includes storage account management and disk image uploading.

azurectl setup account help¶

Configuration file setup for azurectl:

•

List configured accounts

•

Add account to config file

•

Delete account from config file

azurectl setup account region help¶

Configuration of Azure region settings in config files:

•

Add region settings to a config file

•

Change default region in a config file

azurectl compute data-disk help¶

Manage additional (non-root) disks available to virtual machines:

•

Create empty data-disks and make available to a virtual machine

•

List all data-disks attached to a virtual machine

•

Inspect metadata for a single data-disk

•

Delete a data-disk from a virtual machine

azurectl compute endpoint help¶

Manage forwarding of TCP & UDP traffic from public ports to virtual machines:

•

Create endpoints

•

List all endpoints connected to a virtual machine

•

Inspect metadata for a singe endpoint

•

Delete an endpoint from a virtual machine

azurectl compute image help¶

Azure image management:

•

Create OS images

•

Replicate and publish images (authorized publishing accounts only)

•

List registered OS images

•

Update OS images with additonal metadata

•

Delete OS images

azurectl compute request help¶

Manage asynchronous requests to the Azure API:

•

View the status of a request

•

Wait for a request to complete

azurectl compute reserved-ip help¶

Manage public IP address reservations:

•

Create reservations for public IPs

•

List reserved IPs

•

Inspect metadata for a single reservation

•

Release an IP by deleting its reservation

azurectl compute vm help¶

Manage virtual machines:

•

Create virtual machines from an OS image

•

List available regions and virtual machine types

•

Delete virtual machines

azurectl storage account help¶

Manage Azure storage accounts:

•

Create storage accounts

•

List all storage accounts in an Azure subscription

•

List all regions where storage accounts may be created

•

Inspect metadata for a single storage account

•

Update attributes of a storage account

•

Delete a storage account and all contents

azurectl storage container help¶

Manage containers within an Azure storage account:

•

Create containers

•

Create shared access signature (SAS) URLs for containers

•

List all containers in a storage account

•

Inspect metadata for a single container

•

Delete a storage container and all contents

azurectl storage disk help¶

Manage disk images in storage:

•

Upload a fixed-size virtual hard disk (VHD), or compressed VHD into blob storage as a page blob, suitable for use as an OS image

•

Delete a disk image from blob storage

azurectl storage share help¶

Manage SMB file shares in Azure storage (Azure File storage):

•

Create file shares

•

List all shares in a storage account

•

Delete a file share, including all contents

--config=file¶

Location of global config file, default is searched in:

1.

~/.config/azurectl/config

2.

~/.azurectl/config

The azurectl config file is an INI style file structured into sections. There are account and region sections which are handled by the azurectl setup account command. The minimal structure of the config file has the following mandatory sections:

[DEFAULT]
default_account = account:user
default_region = region:region_name
[region:region_name]
default_storage_account = storage_account_name
default_storage_container = storage_container_name
[account:user]
publishsettings = /path/to/publish_settings_file

--account=name¶

Account name to use for operations. By default the account referenced as default_account from the the DEFAULT section will be used. In the configuration file the account section is stored with a prefix named account:. The given value must match one of the account sections.

--region=region¶

Region name to use for operations. By default the region referenced as default_region from the DEFAULT section will be used. An azure region is the name of the geographic region to run e.g virtual instances or store VHD disk images. An example region name would be East US 2. The value for the region has to match the region names used in Microsoft Azure. In the configuration file the region section is stored with a prefix named region:. The given value must match one of the region sections.

--storage-account=name¶

Storage account name to use for operations. The account name must be part of the storage_accounts setup of the associated region in the configuration file

--storage-container=name¶

Storage container name to use for operations. The container name must be part of the storage_containers setup of the associated region in the configuration file

--output-format=format¶

Print information in specified format. Supported formats are

•

json

The default format is: json

--output-style=style¶

Print information in specified style. Supported styles are

•

color

•

standard

The default style is: standard

--debug¶

Enable debugging mode. In this mode azurectl is more verbose and provides information useful to clarify processing issues.