compute

class pulumi_azure.compute.AvailabilitySet(resource_name, opts=None, location=None, managed=None, name=None, platform_fault_domain_count=None, platform_update_domain_count=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manages an availability set for virtual machines.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • managed (pulumi.Input[bool]) – Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is false.
  • name (pulumi.Input[str]) – Specifies the name of the availability set. Changing this forces a new resource to be created.
  • platform_fault_domain_count (pulumi.Input[float]) – Specifies the number of fault domains that are used. Defaults to 3.
  • platform_update_domain_count (pulumi.Input[float]) – Specifies the number of update domains that are used. Defaults to 5.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

managed = None

Specifies whether the availability set is managed or not. Possible values are true (to specify aligned) or false (to specify classic). Default is false.

name = None

Specifies the name of the availability set. Changing this forces a new resource to be created.

platform_fault_domain_count = None

Specifies the number of fault domains that are used. Defaults to 3.

platform_update_domain_count = None

Specifies the number of update domains that are used. Defaults to 5.

resource_group_name = None

The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.DataDiskAttachment(resource_name, opts=None, caching=None, create_option=None, lun=None, managed_disk_id=None, virtual_machine_id=None, write_accelerator_enabled=None, __name__=None, __opts__=None)

Manages attaching a Disk to a Virtual Machine.

NOTE: Data Disks can be attached either directly on the azurerm_virtual_machine resource, or using the azurerm_virtual_machine_data_disk_attachment resource - but the two cannot be used together. If both are used against the same Virtual Machine, spurious changes will occur.

Please Note: only Managed Disks are supported via this separate resource, Unmanaged Disks can be attached using the storage_data_disk block in the azurerm_virtual_machine resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • caching (pulumi.Input[str]) – Specifies the caching requirements for this Data Disk. Possible values include None, ReadOnly and ReadWrite.
  • create_option (pulumi.Input[str]) – The Create Option of the Data Disk, such as Empty or Attach. Defaults to Attach. Changing this forces a new resource to be created.
  • lun (pulumi.Input[float]) – The Logical Unit Number of the Data Disk, which needs to be unique within the Virtual Machine. Changing this forces a new resource to be created.
  • managed_disk_id (pulumi.Input[str]) – The ID of an existing Managed Disk which should be attached. Changing this forces a new resource to be created.
  • virtual_machine_id (pulumi.Input[str]) – The ID of the Virtual Machine to which the Data Disk should be attached. Changing this forces a new resource to be created.
  • write_accelerator_enabled (pulumi.Input[bool]) – Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.
caching = None

Specifies the caching requirements for this Data Disk. Possible values include None, ReadOnly and ReadWrite.

create_option = None

The Create Option of the Data Disk, such as Empty or Attach. Defaults to Attach. Changing this forces a new resource to be created.

lun = None

The Logical Unit Number of the Data Disk, which needs to be unique within the Virtual Machine. Changing this forces a new resource to be created.

managed_disk_id = None

The ID of an existing Managed Disk which should be attached. Changing this forces a new resource to be created.

virtual_machine_id = None

The ID of the Virtual Machine to which the Data Disk should be attached. Changing this forces a new resource to be created.

write_accelerator_enabled = None

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.Extension(resource_name, opts=None, auto_upgrade_minor_version=None, location=None, name=None, protected_settings=None, publisher=None, resource_group_name=None, settings=None, tags=None, type=None, type_handler_version=None, virtual_machine_name=None, __name__=None, __opts__=None)

Manages a Virtual Machine Extension to provide post deployment configuration and run automated tasks.

NOTE: Custom Script Extensions for Linux & Windows require that the commandToExecute returns a 0 exit code to be classified as successfully deployed. You can achieve this by appending exit 0 to the end of your commandToExecute.

NOTE: Custom Script Extensions require that the Azure Virtual Machine Guest Agent is running on the Virtual Machine.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • auto_upgrade_minor_version (pulumi.Input[bool]) – Specifies if the platform deploys the latest minor version update to the type_handler_version specified.
  • location (pulumi.Input[str]) – The location where the extension is created. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The name of the virtual machine extension peering. Changing this forces a new resource to be created.
  • protected_settings (pulumi.Input[str]) – The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.
  • publisher (pulumi.Input[str]) – The publisher of the extension, available publishers can be found by using the Azure CLI.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created.
  • settings (pulumi.Input[str]) – The settings passed to the extension, these are specified as a JSON object in a string.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • type (pulumi.Input[str]) – The type of extension, available types for a publisher can be found using the Azure CLI.
  • type_handler_version (pulumi.Input[str]) – Specifies the version of the extension to use, available versions can be found using the Azure CLI.
  • virtual_machine_name (pulumi.Input[str]) – The name of the virtual machine. Changing this forces a new resource to be created.
auto_upgrade_minor_version = None

Specifies if the platform deploys the latest minor version update to the type_handler_version specified.

location = None

The location where the extension is created. Changing this forces a new resource to be created.

name = None

The name of the virtual machine extension peering. Changing this forces a new resource to be created.

protected_settings = None

The protected_settings passed to the extension, like settings, these are specified as a JSON object in a string.

publisher = None

The publisher of the extension, available publishers can be found by using the Azure CLI.

resource_group_name = None

The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created.

settings = None

The settings passed to the extension, these are specified as a JSON object in a string.

tags = None

A mapping of tags to assign to the resource.

type = None

The type of extension, available types for a publisher can be found using the Azure CLI.

type_handler_version = None

Specifies the version of the extension to use, available versions can be found using the Azure CLI.

virtual_machine_name = None

The name of the virtual machine. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.GetAvailabilitySetResult(location=None, managed=None, platform_fault_domain_count=None, platform_update_domain_count=None, tags=None, id=None)

A collection of values returned by getAvailabilitySet.

location = None

The supported Azure location where the Availability Set exists.

managed = None

Whether the availability set is managed or not.

platform_fault_domain_count = None

The number of fault domains that are used.

platform_update_domain_count = None

The number of update domains that are used.

tags = None

A mapping of tags assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetImageResult(data_disks=None, location=None, os_disks=None, tags=None, id=None)

A collection of values returned by getImage.

data_disks = None

a collection of data_disk blocks as defined below.

location = None

the Azure Location where this Image exists.

os_disks = None

a os_disk block as defined below.

tags = None

a mapping of tags to assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetManagedDiskResult(create_option=None, disk_size_gb=None, os_type=None, source_resource_id=None, source_uri=None, storage_account_type=None, tags=None, zones=None, id=None)

A collection of values returned by getManagedDisk.

disk_size_gb = None

The size of the managed disk in gigabytes.

os_type = None

The operating system for managed disk. Valid values are Linux or Windows

source_resource_id = None

ID of an existing managed disk that the current resource was created from.

source_uri = None

The source URI for the managed disk

storage_account_type = None

The storage account type for the managed disk.

tags = None

A mapping of tags assigned to the resource.

zones = None

A collection containing the availability zone the managed disk is allocated in.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetPlatformImageResult(version=None, id=None)

A collection of values returned by getPlatformImage.

version = None

The latest version of the Platform Image.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetSharedImageGalleryResult(description=None, location=None, tags=None, unique_name=None, id=None)

A collection of values returned by getSharedImageGallery.

description = None

A description for the Shared Image Gallery.

tags = None

A mapping of tags which are assigned to the Shared Image Gallery.

unique_name = None

The unique name assigned to the Shared Image Gallery.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetSharedImageResult(description=None, eula=None, identifiers=None, location=None, os_type=None, privacy_statement_uri=None, release_note_uri=None, tags=None, id=None)

A collection of values returned by getSharedImage.

description = None

The description of this Shared Image.

eula = None

The End User Licence Agreement for the Shared Image.

location = None

The supported Azure location where the Shared Image Gallery exists.

os_type = None

The type of Operating System present in this Shared Image.

privacy_statement_uri = None

The URI containing the Privacy Statement for this Shared Image.

release_note_uri = None

The URI containing the Release Notes for this Shared Image.

tags = None

A mapping of tags assigned to the Shared Image.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetSharedImageVersionResult(exclude_from_latest=None, location=None, managed_image_id=None, tags=None, target_regions=None, id=None)

A collection of values returned by getSharedImageVersion.

exclude_from_latest = None

Is this Image Version excluded from the latest filter?

location = None

The supported Azure location where the Shared Image Gallery exists.

managed_image_id = None

The ID of the Managed Image which was the source of this Shared Image Version.

tags = None

A mapping of tags assigned to the Shared Image.

target_regions = None

One or more target_region blocks as documented below.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetSnapshotResult(creation_option=None, disk_size_gb=None, encryption_settings=None, os_type=None, source_resource_id=None, source_uri=None, storage_account_id=None, time_created=None, id=None)

A collection of values returned by getSnapshot.

disk_size_gb = None

The size of the Snapshotted Disk in GB.

source_resource_id = None

The reference to an existing snapshot.

source_uri = None

The URI to a Managed or Unmanaged Disk.

storage_account_id = None

The ID of an storage account.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.GetVirtualMachineResult(id=None)

A collection of values returned by getVirtualMachine.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.compute.Image(resource_name, opts=None, data_disks=None, location=None, name=None, os_disk=None, resource_group_name=None, source_virtual_machine_id=None, tags=None, __name__=None, __opts__=None)

Manage a custom virtual machine image that can be used to create virtual machines.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • data_disks (pulumi.Input[list]) – One or more data_disk elements as defined below.
  • location (pulumi.Input[str]) – Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the image. Changing this forces a new resource to be created.
  • os_disk (pulumi.Input[dict]) – One or more os_disk elements as defined below.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the image. Changing this forces a new resource to be created.
  • source_virtual_machine_id (pulumi.Input[str]) – The Virtual Machine ID from which to create the image.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
data_disks = None

One or more data_disk elements as defined below.

location = None

Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the image. Changing this forces a new resource to be created.

os_disk = None

One or more os_disk elements as defined below.

resource_group_name = None

The name of the resource group in which to create the image. Changing this forces a new resource to be created.

source_virtual_machine_id = None

The Virtual Machine ID from which to create the image.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.ManagedDisk(resource_name, opts=None, create_option=None, disk_size_gb=None, encryption_settings=None, image_reference_id=None, location=None, name=None, os_type=None, resource_group_name=None, source_resource_id=None, source_uri=None, storage_account_type=None, tags=None, zones=None, __name__=None, __opts__=None)

Manage a managed disk.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • create_option (pulumi.Input[str]) – The method to use when creating the managed disk. Possible values include:
  • disk_size_gb (pulumi.Input[float]) – Specifies the size of the managed disk to create in gigabytes. If create_option is Copy or FromImage, then the value must be equal to or greater than the source’s size.
  • encryption_settings (pulumi.Input[dict]) – an encryption_settings block as defined below.
  • image_reference_id (pulumi.Input[str]) – ID of an existing platform/marketplace disk image to copy when create_option is FromImage.
  • location (pulumi.Input[str]) – Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the managed disk. Changing this forces a new resource to be created.
  • os_type (pulumi.Input[str]) – Specify a value when the source of an Import or Copy operation targets a source that contains an operating system. Valid values are Linux or Windows
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the managed disk.
  • source_resource_id (pulumi.Input[str]) – ID of an existing managed disk to copy when create_option is Copy.
  • source_uri (pulumi.Input[str]) – URI to a valid VHD file to be used when create_option is Import.
  • storage_account_type (pulumi.Input[str]) – The type of storage to use for the managed disk. Allowable values are Standard_LRS, Premium_LRS, StandardSSD_LRS or UltraSSD_LRS.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • zones (pulumi.Input[str]) – A collection containing the availability zone to allocate the Managed Disk in.
create_option = None

The method to use when creating the managed disk. Possible values include:

disk_size_gb = None

Specifies the size of the managed disk to create in gigabytes. If create_option is Copy or FromImage, then the value must be equal to or greater than the source’s size.

encryption_settings = None

an encryption_settings block as defined below.

image_reference_id = None

ID of an existing platform/marketplace disk image to copy when create_option is FromImage.

location = None

Specified the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the managed disk. Changing this forces a new resource to be created.

os_type = None

Specify a value when the source of an Import or Copy operation targets a source that contains an operating system. Valid values are Linux or Windows

resource_group_name = None

The name of the resource group in which to create the managed disk.

source_resource_id = None

ID of an existing managed disk to copy when create_option is Copy.

source_uri = None

URI to a valid VHD file to be used when create_option is Import.

storage_account_type = None

The type of storage to use for the managed disk. Allowable values are Standard_LRS, Premium_LRS, StandardSSD_LRS or UltraSSD_LRS.

tags = None

A mapping of tags to assign to the resource.

zones = None

A collection containing the availability zone to allocate the Managed Disk in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.ScaleSet(resource_name, opts=None, automatic_os_upgrade=None, boot_diagnostics=None, eviction_policy=None, extensions=None, health_probe_id=None, identity=None, license_type=None, location=None, name=None, network_profiles=None, os_profile=None, os_profile_linux_config=None, os_profile_secrets=None, os_profile_windows_config=None, overprovision=None, plan=None, priority=None, resource_group_name=None, rolling_upgrade_policy=None, single_placement_group=None, sku=None, storage_profile_data_disks=None, storage_profile_image_reference=None, storage_profile_os_disk=None, tags=None, upgrade_policy_mode=None, zones=None, __name__=None, __opts__=None)

Manage a virtual machine scale set.

Note: All arguments including the administrator login and password will be stored in the raw state as plain-text. Read more about sensitive data in state.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • automatic_os_upgrade (pulumi.Input[bool]) – Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.
  • boot_diagnostics (pulumi.Input[dict]) – A boot diagnostics profile block as referenced below.
  • eviction_policy (pulumi.Input[str]) – Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.
  • extensions (pulumi.Input[list]) – Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.
  • health_probe_id (pulumi.Input[str]) – Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.
  • license_type (pulumi.Input[str]) – Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the image from the marketplace.
  • network_profiles (pulumi.Input[list]) – A collection of network profile block as documented below.
  • os_profile (pulumi.Input[dict]) – A Virtual Machine OS Profile block as documented below.
  • os_profile_linux_config (pulumi.Input[dict]) – A Linux config block as documented below.
  • os_profile_secrets (pulumi.Input[list]) – A collection of Secret blocks as documented below.
  • os_profile_windows_config (pulumi.Input[dict]) – A Windows config block as documented below.
  • overprovision (pulumi.Input[bool]) – Specifies whether the virtual machine scale set should be overprovisioned.
  • plan (pulumi.Input[dict]) – A plan block as documented below.
  • priority (pulumi.Input[str]) – Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.
  • rolling_upgrade_policy (pulumi.Input[dict]) – A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.
  • single_placement_group (pulumi.Input[bool]) – Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.
  • sku (pulumi.Input[dict]) – Specifies the SKU of the image used to create the virtual machines.
  • storage_profile_data_disks (pulumi.Input[list]) – A storage profile data disk block as documented below
  • storage_profile_image_reference (pulumi.Input[dict]) – A storage profile image reference block as documented below.
  • storage_profile_os_disk (pulumi.Input[dict]) – A storage profile os disk block as documented below
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • upgrade_policy_mode (pulumi.Input[str]) – Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.
  • zones (pulumi.Input[list]) – A collection of availability zones to spread the Virtual Machines over.
automatic_os_upgrade = None

Automatic OS patches can be applied by Azure to your scaleset. This is particularly useful when upgrade_policy_mode is set to Rolling. Defaults to false.

boot_diagnostics = None

A boot diagnostics profile block as referenced below.

eviction_policy = None

Specifies the eviction policy for Virtual Machines in this Scale Set. Possible values are Deallocate and Delete.

extensions = None

Can be specified multiple times to add extension profiles to the scale set. Each extension block supports the fields documented below.

health_probe_id = None

Specifies the identifier for the load balancer health probe. Required when using Rolling as your upgrade_policy_mode.

license_type = None

Specifies the Windows OS license type. If supplied, the only allowed values are Windows_Client and Windows_Server.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the image from the marketplace.

network_profiles = None

A collection of network profile block as documented below.

os_profile = None

A Virtual Machine OS Profile block as documented below.

os_profile_linux_config = None

A Linux config block as documented below.

os_profile_secrets = None

A collection of Secret blocks as documented below.

os_profile_windows_config = None

A Windows config block as documented below.

overprovision = None

Specifies whether the virtual machine scale set should be overprovisioned.

plan = None

A plan block as documented below.

priority = None

Specifies the priority for the Virtual Machines in the Scale Set. Defaults to Regular. Possible values are Low and Regular.

resource_group_name = None

The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.

rolling_upgrade_policy = None

A rolling_upgrade_policy block as defined below. This is only applicable when the upgrade_policy_mode is Rolling.

single_placement_group = None

Specifies whether the scale set is limited to a single placement group with a maximum size of 100 virtual machines. If set to false, managed disks must be used. Default is true. Changing this forces a new resource to be created. See documentation for more information.

sku = None

Specifies the SKU of the image used to create the virtual machines.

storage_profile_data_disks = None

A storage profile data disk block as documented below

storage_profile_image_reference = None

A storage profile image reference block as documented below.

storage_profile_os_disk = None

A storage profile os disk block as documented below

tags = None

A mapping of tags to assign to the resource.

upgrade_policy_mode = None

Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.

zones = None

A collection of availability zones to spread the Virtual Machines over.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.SharedImage(resource_name, opts=None, description=None, eula=None, gallery_name=None, identifier=None, location=None, name=None, os_type=None, privacy_statement_uri=None, release_note_uri=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manages a Shared Image within a Shared Image Gallery.

NOTE Shared Image Galleries are currently in Public Preview. You can find more information, including how to register for the Public Preview here.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A description of this Shared Image.
  • eula (pulumi.Input[str]) – The End User Licence Agreement for the Shared Image.
  • gallery_name (pulumi.Input[str]) – Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Shared Image. Changing this forces a new resource to be created.
  • os_type (pulumi.Input[str]) – The type of Operating System present in this Shared Image. Possible values are Linux and Windows.
  • privacy_statement_uri (pulumi.Input[str]) – The URI containing the Privacy Statement associated with this Shared Image.
  • release_note_uri (pulumi.Input[str]) – The URI containing the Release Notes associated with this Shared Image.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the Shared Image.
description = None

A description of this Shared Image.

eula = None

The End User Licence Agreement for the Shared Image.

gallery_name = None

Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.

location = None

Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Shared Image. Changing this forces a new resource to be created.

os_type = None

The type of Operating System present in this Shared Image. Possible values are Linux and Windows.

privacy_statement_uri = None

The URI containing the Privacy Statement associated with this Shared Image.

release_note_uri = None

The URI containing the Release Notes associated with this Shared Image.

resource_group_name = None

The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the Shared Image.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.SharedImageGallery(resource_name, opts=None, description=None, location=None, name=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

Manages a Shared Image Gallery.

NOTE Shared Image Galleries are currently in Public Preview. You can find more information, including how to register for the Public Preview here.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A description for this Shared Image Gallery.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Shared Image Gallery. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Shared Image Gallery. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the Shared Image Gallery.
description = None

A description for this Shared Image Gallery.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Shared Image Gallery. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Shared Image Gallery. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the Shared Image Gallery.

unique_name = None

The Unique Name for this Shared Image Gallery.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.SharedImageVersion(resource_name, opts=None, exclude_from_latest=None, gallery_name=None, image_name=None, location=None, managed_image_id=None, name=None, resource_group_name=None, tags=None, target_regions=None, __name__=None, __opts__=None)

Manages a Version of a Shared Image within a Shared Image Gallery.

NOTE Shared Image Galleries are currently in Public Preview. You can find more information, including how to register for the Public Preview here.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • exclude_from_latest (pulumi.Input[bool]) – Should this Image Version be excluded from the latest filter? If set to true this Image Version won’t be returned for the latest version. Defaults to false.
  • gallery_name (pulumi.Input[str]) – The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.
  • image_name (pulumi.Input[str]) – The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.
  • location (pulumi.Input[str]) – The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
  • managed_image_id (pulumi.Input[str]) – The ID of the Managed Image which should be used for this Shared Image Version. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A collection of tags which should be applied to this resource.
  • target_regions (pulumi.Input[list]) – One or more target_region blocks as documented below.
exclude_from_latest = None

Should this Image Version be excluded from the latest filter? If set to true this Image Version won’t be returned for the latest version. Defaults to false.

gallery_name = None

The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.

image_name = None

The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.

location = None

The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.

managed_image_id = None

The ID of the Managed Image which should be used for this Shared Image Version. Changing this forces a new resource to be created.

name = None

The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.

resource_group_name = None

The name of the Resource Group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.

tags = None

A collection of tags which should be applied to this resource.

target_regions = None

One or more target_region blocks as documented below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.Snapshot(resource_name, opts=None, create_option=None, disk_size_gb=None, encryption_settings=None, location=None, name=None, resource_group_name=None, source_resource_id=None, source_uri=None, storage_account_id=None, tags=None, __name__=None, __opts__=None)

Manages a Disk Snapshot.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • create_option (pulumi.Input[str]) – Indicates how the snapshot is to be created. Possible values are Copy or Import. Changing this forces a new resource to be created.
  • disk_size_gb (pulumi.Input[float]) – The size of the Snapshotted Disk in GB.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
  • source_resource_id (pulumi.Input[str]) – Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
  • source_uri (pulumi.Input[str]) – Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
  • storage_account_id (pulumi.Input[str]) – Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
create_option = None

Indicates how the snapshot is to be created. Possible values are Copy or Import. Changing this forces a new resource to be created.

disk_size_gb = None

The size of the Snapshotted Disk in GB.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.

source_resource_id = None

Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.

source_uri = None

Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.

storage_account_id = None

Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.compute.VirtualMachine(resource_name, opts=None, availability_set_id=None, boot_diagnostics=None, delete_data_disks_on_termination=None, delete_os_disk_on_termination=None, identity=None, license_type=None, location=None, name=None, network_interface_ids=None, os_profile=None, os_profile_linux_config=None, os_profile_secrets=None, os_profile_windows_config=None, plan=None, primary_network_interface_id=None, resource_group_name=None, storage_data_disks=None, storage_image_reference=None, storage_os_disk=None, tags=None, vm_size=None, zones=None, __name__=None, __opts__=None)

Manages a Virtual Machine.

NOTE: Data Disks can be attached either directly on the azurerm_virtual_machine resource, or using the azurerm_virtual_machine_data_disk_attachment resource - but the two cannot be used together. If both are used against the same Virtual Machine, spurious changes will occur.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • availability_set_id (pulumi.Input[str]) – The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.
  • boot_diagnostics (pulumi.Input[dict]) – A boot_diagnostics block.
  • delete_data_disks_on_termination (pulumi.Input[bool]) – Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.
  • delete_os_disk_on_termination (pulumi.Input[bool]) – Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.
  • identity (pulumi.Input[dict]) – A identity block.
  • license_type (pulumi.Input[str]) – Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.
  • location (pulumi.Input[str]) – Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.
  • name (pulumi.Input[str]) – Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.
  • network_interface_ids (pulumi.Input[list]) – A list of Network Interface ID’s which should be associated with the Virtual Machine.
  • os_profile (pulumi.Input[dict]) – An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.
  • os_profile_linux_config (pulumi.Input[dict]) – A os_profile_linux_config block.
  • os_profile_secrets (pulumi.Input[list]) – One or more os_profile_secrets blocks.
  • os_profile_windows_config (pulumi.Input[dict]) – A os_profile_windows_config block.
  • plan (pulumi.Input[dict]) – A plan block.
  • primary_network_interface_id (pulumi.Input[str]) – The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.
  • resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.
  • storage_data_disks (pulumi.Input[list]) – One or more storage_data_disk blocks.
  • storage_image_reference (pulumi.Input[dict]) – A storage_image_reference block.
  • storage_os_disk (pulumi.Input[dict]) – A storage_os_disk block.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the Virtual Machine.
  • vm_size (pulumi.Input[str]) – Specifies the size of the Virtual Machine.
  • zones (pulumi.Input[str]) – A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.
availability_set_id = None

The ID of the Availability Set in which the Virtual Machine should exist. Changing this forces a new resource to be created.

boot_diagnostics = None

A boot_diagnostics block.

delete_data_disks_on_termination = None

Should the Data Disks (either the Managed Disks / VHD Blobs) be deleted when the Virtual Machine is destroyed? Defaults to false.

delete_os_disk_on_termination = None

Should the OS Disk (either the Managed Disk / VHD Blob) be deleted when the Virtual Machine is destroyed? Defaults to false.

identity = None

A identity block.

license_type = None

Specifies the BYOL Type for this Virtual Machine. This is only applicable to Windows Virtual Machines. Possible values are Windows_Client and Windows_Server.

location = None

Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.

network_interface_ids = None

A list of Network Interface ID’s which should be associated with the Virtual Machine.

os_profile = None

An os_profile block. Required when create_option in the storage_os_disk block is set to FromImage.

os_profile_linux_config = None

A os_profile_linux_config block.

os_profile_secrets = None

One or more os_profile_secrets blocks.

os_profile_windows_config = None

A os_profile_windows_config block.

plan = None

A plan block.

primary_network_interface_id = None

The ID of the Network Interface (which must be attached to the Virtual Machine) which should be the Primary Network Interface for this Virtual Machine.

resource_group_name = None

Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.

storage_data_disks = None

One or more storage_data_disk blocks.

storage_image_reference = None

A storage_image_reference block.

storage_os_disk = None

A storage_os_disk block.

tags = None

A mapping of tags to assign to the Virtual Machine.

vm_size = None

Specifies the size of the Virtual Machine.

zones = None

A list of a single item of the Availability Zone which the Virtual Machine should be allocated in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.compute.get_availability_set(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Availability Set.

pulumi_azure.compute.get_image(name=None, name_regex=None, resource_group_name=None, sort_descending=None, opts=None)

Use this data source to access information about an existing Image.

pulumi_azure.compute.get_managed_disk(name=None, resource_group_name=None, tags=None, zones=None, opts=None)

Use this data source to access information about an existing Managed Disk.

pulumi_azure.compute.get_platform_image(location=None, offer=None, publisher=None, sku=None, opts=None)

Use this data source to access information about a Platform Image.

pulumi_azure.compute.get_shared_image(gallery_name=None, name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Shared Image within a Shared Image Gallery.

NOTE Shared Image Galleries are currently in Public Preview. You can find more information, including how to register for the Public Preview here.

Use this data source to access information about an existing Shared Image Gallery.

NOTE Shared Image Galleries are currently in Public Preview. You can find more information, including how to register for the Public Preview here.
pulumi_azure.compute.get_shared_image_version(gallery_name=None, image_name=None, name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Version of a Shared Image within a Shared Image Gallery.

NOTE Shared Image Galleries are currently in Public Preview. You can find more information, including how to register for the Public Preview here.
pulumi_azure.compute.get_snapshot(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Snapshot.

pulumi_azure.compute.get_virtual_machine(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Virtual Machine.