saltext.azurerm.modules.azurerm_compute_virtual_machine#

Azure Resource Manager (ARM) Compute Virtual Machine Execution Module

New in version 2.1.0.

maintainer:

<devops@eitr.tech>

configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id

  • username

  • password

if using a service principal:
  • subscription_id

  • tenant

  • client_id

  • secret

if using managed identity:
  • subscription_id

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.

Possible values: * AZURE_PUBLIC_CLOUD (default) * AZURE_CHINA_CLOUD * AZURE_US_GOV_CLOUD * AZURE_GERMAN_CLOUD

Functions

create_or_update(name, resource_group, vm_size)

New in version 2.1.0.

delete(name, resource_group[, ...])

New in version 2.1.0.

capture(name, destination_name, resource_group)

New in version 2.1.0.

get(name, resource_group, **kwargs)

New in version 2.1.0.

assess_patches(name, resource_group, **kwargs)

New in version 2.1.0.

convert_to_managed_disks(name, ...)

New in version 2.1.0.

deallocate(name, resource_group, **kwargs)

New in version 2.1.0.

generalize(name, resource_group, **kwargs)

New in version 2.1.0.

list_([resource_group])

New in version 2.1.0.

virtual_machines_list_all(**kwargs)

New in version 2.1.0.

list_by_location(location, **kwargs)

New in version 2.1.0.

list_available_sizes(name, resource_group, ...)

New in version 2.1.0.

instance_view(name, resource_group, **kwargs)

New in version 2.1.0.

perform_maintenance(name, resource_group, ...)

New in version 2.1.0.

power_off(name, resource_group, **kwargs)

New in version 2.1.0.

reapply(name, resource_group, **kwargs)

New in version 2.1.0.

reimage(name, resource_group[, temp_disk])

New in version 2.1.0.

restart(name, resource_group, **kwargs)

New in version 2.1.0.

start(name, resource_group, **kwargs)

New in version 2.1.0.

redeploy(name, resource_group, **kwargs)

New in version 2.1.0.

retrieve_boot_diagnostics_data(name, ...[, ...])

New in version 2.1.0.

simulate_eviction(name, resource_group, **kwargs)

New in version 2.1.0.