Getting Started With Azure¶

provider¶

The name of the provider as configured in /etc/salt/cloud.providers.d/azure.conf.

image¶

The name of the image to use to create a VM. Available images can be viewed using the following command:

salt-cloud --list-images my-azure-config

size¶

The name of the size to use to create a VM. Available sizes can be viewed using the following command:

salt-cloud --list-sizes my-azure-config

location¶

The name of the location to create a VM in. Available locations can be viewed using the following command:

salt-cloud --list-locations my-azure-config

affinity_group¶

The name of the affinity group to create a VM in. Either a location or an affinity_group may be specified, but not both. See Affinity Groups below.

ssh_username¶

The user to use to log into the newly-created VM to install Salt.

ssh_password¶

The password to use to log into the newly-created VM to install Salt.

slot¶

The environment to which the hosted service is deployed. Valid values are staging or production. When set to production, the resulting URL of the new VM will be <vm_name>.cloudapp.net. When set to staging, the resulting URL will contain a generated hash instead.

media_link¶

This is the URL of the container that will store the disk that this VM uses. Currently, this container must already exist. If a VM has previously been created in the associated account, a container should already exist. In the web interface, go into the Storage area and click one of the available storage selections. Click the Containers link, and then copy the URL from the container that will be used. It generally looks like:

http://portalvhdabcdefghijklmn.blob.core.windows.net/vhds

service_name¶

The name of the service in which to create the VM. If this is not specified, then a service will be created with the same name as the VM.

virtual_network_name¶

Optional. The name of the virtual network for the VM to join. If this is not specified, then no virtual network will be joined.

subnet_name¶

Optional. The name of the subnet in the virtual network for the VM to join. Requires that a virtual_network_name is specified.

cleanup_disks¶

Default is False. When set to True, Salt Cloud will wait for the VM to be destroyed, then attempt to destroy the main disk that is associated with the VM.

cleanup_vhds¶

Default is False. Requires cleanup_disks to be set to True. When also set to True, Salt Cloud will ask Azure to delete the VHD associated with the disk that is also destroyed.

cleanup_services¶

Default is False. Requires cleanup_disks to be set to True. When also set to True, Salt Cloud will wait for the disk to be destroyed, then attempt to remove the service that is associated with the VM. Because the disk belongs to the service, the disk must be destroyed before the service can be.

create_service¶

Create a hosted service. The following options are available.

salt-cloud -f create_service my-azure name=my-service label=my-service location='West US'

show_service¶

Return details about a specific hosted service. Can also be called with get_service.

salt-cloud -f show_storage my-azure name=my-service

list_services¶

List all hosted services associates with the subscription.

salt-cloud -f list_services my-azure-config

delete_service¶

Delete a specific hosted service.

salt-cloud -f delete_service my-azure name=my-service

create_storage¶

Create a storage account. The following options are supported.

salt-cloud -f create_storage my-azure name=my-storage label=my-storage location='West US'

list_storage¶

List all storage accounts associates with the subscription.

salt-cloud -f list_storage my-azure-config

show_storage¶

Return details about a specific storage account. Can also be called with get_storage.

salt-cloud -f show_storage my-azure name=my-storage

update_storage¶

Update details concerning a storage account. Any of the options available in create_storage can be used, but the name cannot be changed.

salt-cloud -f update_storage my-azure name=my-storage label=my-storage

delete_storage¶

Delete a specific storage account.

salt-cloud -f delete_storage my-azure name=my-storage

show_storage_keys¶

Returns the primary and secondary access keys for the specified storage account.

salt-cloud -f show_storage_keys my-azure name=my-storage

regenerate_storage_keys¶

Regenerate storage account keys. Requires a key_type ("primary" or "secondary") to be specified.

salt-cloud -f regenerate_storage_keys my-azure name=my-storage key_type=primary

show_disk¶

Return details about a specific disk. Can also be called with get_disk.

salt-cloud -f show_disk my-azure name=my-disk

list_disks¶

List all disks associates with the account.

salt-cloud -f list_disks my-azure

update_disk¶

Update details for a disk. The following options are available.

salt-cloud -f update_disk my-azure name=my-disk label=my-disk

delete_disk¶

Delete a specific disk.

salt-cloud -f delete_disk my-azure name=my-disk

list_service_certificates¶

List service certificates associated with the account.

salt-cloud -f list_service_certificates my-azure

show_service_certificate¶

Show the data for a specific service certificate associated with the account. The name, thumbprint, and thumbalgorithm can be obtained from list_service_certificates. Can also be called with get_service_certificate.

salt-cloud -f show_service_certificate my-azure name=my_service_certificate \
    thumbalgorithm=sha1 thumbprint=0123456789ABCDEF

add_service_certificate¶

Add a service certificate to the account. This requires that a certificate already exists, which is then added to the account. For more information on creating the certificate itself, see:

• Create a Service Certificate for Azure

The following options are available.

salt-cloud -f add_service_certificate my-azure name=my-cert \
    data='...CERT_DATA...' certificate_format=pfx password=verybadpass

delete_service_certificate¶

Delete a service certificate from the account. The name, thumbprint, and thumbalgorithm can be obtained from list_service_certificates.

salt-cloud -f delete_service_certificate my-azure \
    name=my_service_certificate \
    thumbalgorithm=sha1 thumbprint=0123456789ABCDEF

list_management_certificates¶

List management certificates associated with the account.

salt-cloud -f list_management_certificates my-azure

show_management_certificate¶

Show the data for a specific management certificate associated with the account. The name, thumbprint, and thumbalgorithm can be obtained from list_management_certificates. Can also be called with get_management_certificate.

salt-cloud -f show_management_certificate my-azure name=my_management_certificate \
    thumbalgorithm=sha1 thumbprint=0123456789ABCDEF

add_management_certificate¶

Management certificates must have a key length of at least 2048 bits and should reside in the Personal certificate store. When the certificate is installed on the client, it should contain the private key of the certificate. To upload to the certificate to the Microsoft Azure Management Portal, you must export it as a .cer format file that does not contain the private key. For more information on creating management certificates, see the following link:

• Create and Upload a Management Certificate for Azure

The following options are available.

salt-cloud -f add_management_certificate my-azure public_key='...PUBKEY...' \
    thumbprint=0123456789ABCDEF data='...CERT_DATA...'

delete_management_certificate¶

Delete a management certificate from the account. The thumbprint can be obtained from list_management_certificates.

salt-cloud -f delete_management_certificate my-azure thumbprint=0123456789ABCDEF

list_virtual_networks¶

List input endpoints associated with the deployment.

salt-cloud -f list_virtual_networks my-azure service=myservice deployment=mydeployment

list_input_endpoints¶

List input endpoints associated with the deployment

salt-cloud -f list_input_endpoints my-azure service=myservice deployment=mydeployment

show_input_endpoint¶

Show an input endpoint associated with the deployment

salt-cloud -f show_input_endpoint my-azure service=myservice \
    deployment=mydeployment name=SSH

add_input_endpoint¶

Add an input endpoint to the deployment. Please note that there may be a delay before the changes show up. The following options are available.

salt-cloud -f add_input_endpoint my-azure service=myservice \
    deployment=mydeployment role=myrole name=HTTP local_port=80 \
    port=80 protocol=tcp enable_direct_server_return=False \
    timeout_for_tcp_idle_connection=4

update_input_endpoint¶

Updates the details for a specific input endpoint. All options from add_input_endpoint are supported.

salt-cloud -f update_input_endpoint my-azure service=myservice \
    deployment=mydeployment role=myrole name=HTTP local_port=80 \
    port=80 protocol=tcp enable_direct_server_return=False \
    timeout_for_tcp_idle_connection=4

delete_input_endpoint¶

Delete an input endpoint from the deployment. Please note that there may be a delay before the changes show up. The following items are required.

salt-cloud -f delete_input_endpoint my-azure service=myservice \
    deployment=mydeployment role=myrole name=HTTP

list_affinity_groups¶

List input endpoints associated with the account

salt-cloud -f list_affinity_groups my-azure

show_affinity_group¶

Show an affinity group associated with the account

salt-cloud -f show_affinity_group my-azure service=myservice \
    deployment=mydeployment name=SSH

create_affinity_group¶

Create a new affinity group. The following options are supported.

salt-cloud -f create_affinity_group my-azure name=my_affinity_group \
   label=my-affinity-group location='West US'

update_affinity_group¶

Update an affinity group's properties

salt-cloud -f update_affinity_group my-azure name=my_group label=my_group

delete_affinity_group¶

Delete a specific affinity group associated with the account

salt-cloud -f delete_affinity_group my-azure name=my_affinity_group

Blob Storage Configuration¶

Blob storage must be configured differently than the standard Azure configuration. Both a storage_account and a storage_key must be specified either through the Azure provider configuration (in addition to the other Azure configuration) or via the command line.

storage_account: mystorage
storage_key: ffhj334fDSGFEGDFGFDewr34fwfsFSDFwe==

Blob Functions¶

The following functions are made available through Salt Cloud for managing blog storage.

salt-cloud -f make_blob_url my-azure container=mycontainer blob=myblob

salt-cloud -f list_storage_containers my-azure

salt-cloud -f create_storage_container my-azure name=mycontainer

salt-cloud -f show_storage_container my-azure name=myservice

salt-cloud -f show_storage_container_metadata my-azure name=myservice

salt-cloud -f set_storage_container my-azure name=mycontainer \
    x_ms_meta_name_values='{"my_name": "my_value"}'

salt-cloud -f show_storage_container_acl my-azure name=myservice

salt-cloud -f set_storage_container my-azure name=mycontainer

salt-cloud -f delete_storage_container my-azure name=mycontainer

salt-cloud -f lease_storage_container my-azure name=mycontainer

salt-cloud -f list_blobs my-azure container=mycontainer

snapshots:
    Specifies that snapshots should be included in the
    enumeration. Snapshots are listed from oldest to newest in
    the response.
metadata:
    Specifies that blob metadata be returned in the response.
uncommittedblobs:
    Specifies that blobs for which blocks have been uploaded,
    but which have not been committed using Put Block List
    (REST API), be included in the response.
copy:
    Version 2012-02-12 and newer. Specifies that metadata
    related to any current or previous Copy Blob operation
    should be included in the response.

salt-cloud -f show_blob_service_properties my-azure

salt-cloud -f set_blob_service_properties my-azure

salt-cloud -f show_blob_properties my-azure container=mycontainer blob=myblob

salt-cloud -f set_blob_properties my-azure

salt-cloud -f put_blob my-azure container=base name=top.sls blob_path=/srv/salt/top.sls
salt-cloud -f put_blob my-azure container=base name=content.txt blob_content='Some content'

salt-cloud -f get_blob my-azure container=base name=top.sls local_path=/srv/salt/top.sls
salt-cloud -f get_blob my-azure container=base name=content.txt return_content=True