Azure (ARM) Compute Execution Module
New in version 2019.2.0.
new
azure >= 2.0.0
azure-common >= 1.1.8
azure-mgmt >= 1.0.0
azure-mgmt-compute >= 1.0.0
azure-mgmt-network >= 1.7.1
azure-mgmt-resource >= 1.1.0
azure-mgmt-storage >= 1.0.0
azure-mgmt-web >= 0.32.0
azure-storage >= 0.34.3
msrestazure >= 0.4.21
linux
This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function in order to work properly.
Required provider parameters:
subscription_id
username
password
subscription_id
tenant
client_id
secret
Optional provider parameters:
AZURE_PUBLIC_CLOUD
(default)
AZURE_CHINA_CLOUD
AZURE_US_GOV_CLOUD
AZURE_GERMAN_CLOUD
salt.modules.azurearm_compute.
availability_set_create_or_update
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Create or update an availability set.
name -- The availability set to create.
resource_group -- The resource group name assigned to the availability set.
CLI Example:
salt-call azurearm_compute.availability_set_create_or_update testset testgroup
salt.modules.azurearm_compute.
availability_set_delete
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Delete an availability set.
name -- The availability set to delete.
resource_group -- The resource group name assigned to the availability set.
CLI Example:
salt-call azurearm_compute.availability_set_delete testset testgroup
salt.modules.azurearm_compute.
availability_set_get
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Get a dictionary representing an availability set's properties.
name -- The availability set to get.
resource_group -- The resource group name assigned to the availability set.
CLI Example:
salt-call azurearm_compute.availability_set_get testset testgroup
salt.modules.azurearm_compute.
availability_sets_list
(resource_group, **kwargs)¶New in version 2019.2.0.
List all availability sets within a resource group.
resource_group -- The resource group name to list availability sets within.
CLI Example:
salt-call azurearm_compute.availability_sets_list testgroup
salt.modules.azurearm_compute.
availability_sets_list_available_sizes
(name, resource_group, **kwargs)¶New in version 2019.2.0.
List all available virtual machine sizes that can be used to to create a new virtual machine in an existing availability set.
name -- The availability set name to list available virtual machine sizes within.
resource_group -- The resource group name to list available availability set sizes within.
CLI Example:
salt-call azurearm_compute.availability_sets_list_available_sizes testset testgroup
salt.modules.azurearm_compute.
virtual_machine_capture
(name, destination_name, resource_group, prefix='capture-', overwrite=False, **kwargs)¶New in version 2019.2.0.
Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
name -- The name of the virtual machine.
destination_name -- The destination container name.
resource_group -- The resource group name assigned to the virtual machine.
prefix -- (Default: 'capture-') The captured virtual hard disk's name prefix.
overwrite -- (Default: False) Overwrite the destination disk in case of conflict.
CLI Example:
salt-call azurearm_compute.virtual_machine_capture testvm testcontainer testgroup
salt.modules.azurearm_compute.
virtual_machine_convert_to_managed_disks
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
name -- The name of the virtual machine to convert.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_convert_to_managed_disks testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_deallocate
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Power off a virtual machine and deallocate compute resources.
name -- The name of the virtual machine to deallocate.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_deallocate testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_generalize
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Set the state of a virtual machine to 'generalized'.
name -- The name of the virtual machine.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_generalize testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_get
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Retrieves information about the model view or the instance view of a virtual machine.
name -- The name of the virtual machine.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_get testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_power_off
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Power off (stop) a virtual machine.
name -- The name of the virtual machine to stop.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_power_off testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_redeploy
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Redeploy a virtual machine.
name -- The name of the virtual machine to redeploy.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_redeploy testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_restart
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Restart a virtual machine.
name -- The name of the virtual machine to restart.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_restart testvm testgroup
salt.modules.azurearm_compute.
virtual_machine_start
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Power on (start) a virtual machine.
name -- The name of the virtual machine to start.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machine_start testvm testgroup
salt.modules.azurearm_compute.
virtual_machines_list
(resource_group, **kwargs)¶New in version 2019.2.0.
List all virtual machines within a resource group.
resource_group -- The resource group name to list virtual machines within.
CLI Example:
salt-call azurearm_compute.virtual_machines_list testgroup
salt.modules.azurearm_compute.
virtual_machines_list_all
(**kwargs)¶New in version 2019.2.0.
List all virtual machines within a subscription.
CLI Example:
salt-call azurearm_compute.virtual_machines_list_all
salt.modules.azurearm_compute.
virtual_machines_list_available_sizes
(name, resource_group, **kwargs)¶New in version 2019.2.0.
Lists all available virtual machine sizes to which the specified virtual machine can be resized.
name -- The name of the virtual machine.
resource_group -- The resource group name assigned to the virtual machine.
CLI Example:
salt-call azurearm_compute.virtual_machines_list_available_sizes testvm testgroup