table of contents
| AZURECTL(1) | AZURECTL(1) |
NAME¶
azurectl - Command Line Interface to manage Microsoft Azure
Operating System Images are the basis of virtual machines, and are backed by a fixed virtual hard disk (VHD) image in blob storage.
SYNOPSIS¶
azurectl compute image create --name=imagename --blob-name=blobname
-
[--label=label] [--wait]
azurectl compute image replicate --name=imagename --regions=regionlist --offer=offer --sku=sku --image-version=version
-
[--wait] [--quiet]
azurectl compute image list
azurectl compute image replication-status --name=imagename
azurectl compute image show --name=imagename
azurectl compute image update --name=imagename
-
[--description=description] [--eula=eula] [--image-family=image_family] [--icon-uri=icon_uri] [--label=label] [--language=language] [--privacy-uri=privacy_uri] [--published-date=date] [--small-icon-uri=small_icon_uri]
azurectl compute image publish --name=imagename
-
[--private] [--msdn] [--wait]
azurectl compute image delete --name=imagename
-
[--wait]
azurectl compute image unreplicate --name=imagename
DESCRIPTION¶
create¶
Register operating system image from a VHD disk stored in a Microsoft Azure blob storage container. Before creating an image, the VHD must be uploaded to storage as a page blob. See the azurectl storage disk upload command.
delete¶
Deregister an operating system image. By default, the backing VHD file will be kept in storage, but With the --delete-disk option, the file will be deleted from the storage as well.
list¶
List registered images and their attributes
show¶
List information about a single image
publish¶
Publicly share an already replicated VM image. This operation is only for publishers. You have to be registered as image publisher with Microsoft Azure to be able to call this.
replicate¶
Replicate a VM image to multiple target locations. This operation is only for publishers. You have to be registered as image publisher with Microsoft Azure to be able to call this. If the region name all is provided, azurectl will replicate to all regions that are valid for your subscription.
replication-status¶
Show a list of regions a specified image is replicated to, and the completion percentage of the replication operation to each region. When all regions show 100% replication progress, the image is completely replicated.
unreplicate¶
Unreplicate a VM image from all regions. Like replication, this operation is only for publishers.
update¶
Update OS image metadata. Every image in the storage repository contains a set of metadata information describing the image more detailed. The azurectl compute image list command prints this information for every image in the repository matching the account setup. With the update command some of the elements can be changed. Please be aware, publisher data like eula, image-family or published-date can only be changed with an account registered as image publisher with Microsoft Azure.
OPTIONS¶
--blob-name¶
Specify the base filename of the disk image (VHD) as it is stored on the blob storage.
--delete-disk¶
When deleting an image, forces the deletion of the backing VHD file from storage as well. Without specifying this option with azurectl compute image delete, the blob will remain in storage.
--description¶
A long-format text description of the image.
--eula¶
An URL where an end-user may read the text of the images end user license agreement.
--icon-uri¶
The location to a 100x100px image file referenced by one of the following capabilities:
- •
- The name of the image file local to the Azure gallery.
- •
- The URL of the image to use as a large icon in the Azure gallery list.
--image-family¶
An arbitrary classification of the image, in order to categorize versions of an image in the Azure gallery; this is replaced by a combination of offer and sku in the Azure marketplace.
--image-version¶
Publisher meta data, specifies the semantic version of the image. For details on the format see: http://semver.org. Example: 1.0.0
--label¶
Specify a custom label for the operating system image when calling create If no label is specified the label is equal to the given name.
--language¶
The language the OS image is configured with. We recommend the standard country code format, e.g en_US.
--msdn¶
When publising an image this option limits the scope of the shared image to the Microsoft Developer Network.
--name¶
Specify the VM name in an image creation or replication process
--offer¶
Publisher meta data, specifies the name of the offer.
--privacy-uri¶
An URL where an end-user may read the privacy policy that governs information.
--private¶
When publising an image this option limits the scope of the shared image to be account private.
--published-date¶
The date an appliance is published, in the format yyyy-mm-dd.
--quiet¶
Suppress progress information during long-running processes, such as when running azurectl compute storage replicate with the --wait option.
--regions¶
Specify a comma separated list of region names
--sku¶
Publisher meta data, specifies the name of the sku
--small-icon-uri¶
The location to a 45x45px image file referenced by one of the following capabilities:
- •
- The name of the image file local to the Azure gallery.
- •
- The URL of the image to use as a small icon in the Azure gallery list.
--wait¶
wait for the request to change its status to succeeded. On replication delay the completion of azurectl execution until the replication task has been completed in the Azure framework.
| AZURECTL User Manuals |