Fork me on GitHub

Module compute

@pulumi/azure > compute

Index

compute/availabilitySet.ts compute/dataDiskAttachment.ts compute/extension.ts compute/getImage.ts compute/getManagedDisk.ts compute/getPlatformImage.ts compute/getSnapshot.ts compute/image.ts compute/managedDisk.ts compute/scaleSet.ts compute/snapshot.ts compute/virtualMachine.ts

class AvailabilitySet

Manages an availability set for virtual machines.

constructor

new AvailabilitySet(name: string, args: AvailabilitySetArgs, opts?: pulumi.CustomResourceOptions)

Create a AvailabilitySet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AvailabilitySetState): AvailabilitySet

Get an existing AvailabilitySet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property managed

public managed: pulumi.Output<boolean | undefined>;

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

property name

public name: pulumi.Output<string>;

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

property platformFaultDomainCount

public platformFaultDomainCount: pulumi.Output<number | undefined>;

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

property platformUpdateDomainCount

public platformUpdateDomainCount: pulumi.Output<number | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class DataDiskAttachment

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.

constructor

new DataDiskAttachment(name: string, args: DataDiskAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a DataDiskAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataDiskAttachmentState): DataDiskAttachment

Get an existing DataDiskAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property caching

public caching: pulumi.Output<string>;

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

property createOption

public createOption: pulumi.Output<string | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lun

public lun: pulumi.Output<number>;

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.

property managedDiskId

public managedDiskId: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualMachineId

public virtualMachineId: pulumi.Output<string>;

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

property writeAcceleratorEnabled

public writeAcceleratorEnabled: pulumi.Output<boolean | undefined>;

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.

class Extension

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.

constructor

new Extension(name: string, args: ExtensionArgs, opts?: pulumi.CustomResourceOptions)

Create a Extension resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ExtensionState): Extension

Get an existing Extension resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property autoUpgradeMinorVersion

public autoUpgradeMinorVersion: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property protectedSettings

public protectedSettings: pulumi.Output<string | undefined>;

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

property publisher

public publisher: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property settings

public settings: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<{ ... }>;

property type

public type: pulumi.Output<string>;

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

property typeHandlerVersion

public typeHandlerVersion: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualMachineName

public virtualMachineName: pulumi.Output<string>;

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

class Image

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

constructor

new Image(name: string, args: ImageArgs, opts?: pulumi.CustomResourceOptions)

Create a Image resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ImageState): Image

Get an existing Image resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dataDisks

public dataDisks: pulumi.Output<{ ... }[] | undefined>;

One or more data_disk elements as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property osDisk

public osDisk: pulumi.Output<{ ... } | undefined>;

One or more os_disk elements as defined below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property sourceVirtualMachineId

public sourceVirtualMachineId: pulumi.Output<string | undefined>;

The Virtual Machine ID from which to create the image.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ManagedDisk

Create a managed disk.

constructor

new ManagedDisk(name: string, args: ManagedDiskArgs, opts?: pulumi.CustomResourceOptions)

Create a ManagedDisk resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ManagedDiskState): ManagedDisk

Get an existing ManagedDisk resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property createOption

public createOption: pulumi.Output<string>;

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

property diskSizeGb

public diskSizeGb: pulumi.Output<number>;

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.

property encryptionSettings

public encryptionSettings: pulumi.Output<{ ... } | undefined>;

an encryption_settings block as defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property imageReferenceId

public imageReferenceId: pulumi.Output<string | undefined>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property osType

public osType: pulumi.Output<string | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property sourceResourceId

public sourceResourceId: pulumi.Output<string | undefined>;

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

property sourceUri

public sourceUri: pulumi.Output<string>;

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

property storageAccountType

public storageAccountType: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zones

public zones: pulumi.Output<string | undefined>;

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

class ScaleSet

Create 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.

constructor

new ScaleSet(name: string, args: ScaleSetArgs, opts?: pulumi.CustomResourceOptions)

Create a ScaleSet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ScaleSetState): ScaleSet

Get an existing ScaleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bootDiagnostics

public bootDiagnostics: pulumi.Output<{ ... } | undefined>;

A boot diagnostics profile block as referenced below.

property extensions

public extensions: pulumi.Output<{ ... }[] | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<{ ... }>;

property licenseType

public licenseType: pulumi.Output<string>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

Specifies the name of the image from the marketplace.

property networkProfiles

public networkProfiles: pulumi.Output<{ ... }[]>;

A collection of network profile block as documented below.

property osProfile

public osProfile: pulumi.Output<{ ... }>;

A Virtual Machine OS Profile block as documented below.

property osProfileLinuxConfig

public osProfileLinuxConfig: pulumi.Output<{ ... }>;

A Linux config block as documented below.

property osProfileSecrets

public osProfileSecrets: pulumi.Output<{ ... }[] | undefined>;

A collection of Secret blocks as documented below.

property osProfileWindowsConfig

public osProfileWindowsConfig: pulumi.Output<{ ... } | undefined>;

A Windows config block as documented below.

property overprovision

public overprovision: pulumi.Output<boolean | undefined>;

Specifies whether the virtual machine scale set should be overprovisioned. Defaults to true.

property plan

public plan: pulumi.Output<{ ... } | undefined>;

A plan block as documented below.

property priority

public priority: pulumi.Output<string | undefined>;

Specifies the priority for the virtual machines in the scale set, defaults to Regular. Possible values are Low and Regular.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property singlePlacementGroup

public singlePlacementGroup: pulumi.Output<boolean | undefined>;

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. Defaults to true. Changing this forces a new resource to be created. See documentation for more information.

property sku

public sku: pulumi.Output<{ ... }>;

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

property storageProfileDataDisks

public storageProfileDataDisks: pulumi.Output<{ ... }[] | undefined>;

A storage profile data disk block as documented below

property storageProfileImageReference

public storageProfileImageReference: pulumi.Output<{ ... }>;

A storage profile image reference block as documented below.

property storageProfileOsDisk

public storageProfileOsDisk: pulumi.Output<{ ... }>;

A storage profile os disk block as documented below

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property upgradePolicyMode

public upgradePolicyMode: pulumi.Output<string>;

Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Manual or Automatic.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zones

public zones: pulumi.Output<string[] | undefined>;

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

class Snapshot

Manages a Disk Snapshot.

constructor

new Snapshot(name: string, args: SnapshotArgs, opts?: pulumi.CustomResourceOptions)

Create a Snapshot resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotState): Snapshot

Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property createOption

public createOption: pulumi.Output<string>;

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

property diskSizeGb

public diskSizeGb: pulumi.Output<number>;

The size of the Snapshotted Disk in GB.

property encryptionSettings

public encryptionSettings: pulumi.Output<{ ... } | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property sourceResourceId

public sourceResourceId: pulumi.Output<string | undefined>;

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

property sourceUri

public sourceUri: pulumi.Output<string | undefined>;

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

property storageAccountId

public storageAccountId: pulumi.Output<string | undefined>;

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.

property tags

public tags: pulumi.Output<{ ... }>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class VirtualMachine

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.

constructor

new VirtualMachine(name: string, args: VirtualMachineArgs, opts?: pulumi.CustomResourceOptions)

Create a VirtualMachine resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualMachineState): VirtualMachine

Get an existing VirtualMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property availabilitySetId

public availabilitySetId: pulumi.Output<string>;

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

property bootDiagnostics

public bootDiagnostics: pulumi.Output<{ ... } | undefined>;

A boot_diagnostics block.

property deleteDataDisksOnTermination

public deleteDataDisksOnTermination: pulumi.Output<boolean | undefined>;

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

property deleteOsDiskOnTermination

public deleteOsDiskOnTermination: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<{ ... }>;

A identity block.

property licenseType

public licenseType: pulumi.Output<string>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

Specifies the name of the OS Disk.

property networkInterfaceIds

public networkInterfaceIds: pulumi.Output<string[]>;

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

property osProfile

public osProfile: pulumi.Output<{ ... } | undefined>;

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

property osProfileLinuxConfig

public osProfileLinuxConfig: pulumi.Output<{ ... } | undefined>;

A os_profile_linux_config block.

property osProfileSecrets

public osProfileSecrets: pulumi.Output<{ ... }[] | undefined>;

One or more os_profile_secrets blocks.

property osProfileWindowsConfig

public osProfileWindowsConfig: pulumi.Output<{ ... } | undefined>;

A os_profile_windows_config block.

property plan

public plan: pulumi.Output<{ ... } | undefined>;

A plan block.

property primaryNetworkInterfaceId

public primaryNetworkInterfaceId: pulumi.Output<string | undefined>;

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.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property storageDataDisks

public storageDataDisks: pulumi.Output<{ ... }[]>;

One or more storage_data_disk blocks.

property storageImageReference

public storageImageReference: pulumi.Output<{ ... }>;

A storage_image_reference block.

property storageOsDisk

public storageOsDisk: pulumi.Output<{ ... }>;

A storage_os_disk block.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the Virtual Machine.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vmSize

public vmSize: pulumi.Output<string>;

Specifies the size of the Virtual Machine.

property zones

public zones: pulumi.Output<string | undefined>;

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

function getImage

getImage(args: GetImageArgs, opts?: pulumi.InvokeOptions): Promise<GetImageResult>

Use this data source to access information about an Image.

function getManagedDisk

getManagedDisk(args: GetManagedDiskArgs, opts?: pulumi.InvokeOptions): Promise<GetManagedDiskResult>

Use this data source to access the properties of an existing Azure Managed Disk.

function getPlatformImage

getPlatformImage(args: GetPlatformImageArgs, opts?: pulumi.InvokeOptions): Promise<GetPlatformImageResult>

Use this data source to access the properties of an Azure Platform Image.

function getSnapshot

getSnapshot(args: GetSnapshotArgs, opts?: pulumi.InvokeOptions): Promise<GetSnapshotResult>

Use this data source to access the properties of a Snapshot of an Disk.

interface AvailabilitySetArgs

The set of arguments for constructing a AvailabilitySet resource.

property location

location: pulumi.Input<string>;

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

property managed

managed?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property platformFaultDomainCount

platformFaultDomainCount?: pulumi.Input<number>;

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

property platformUpdateDomainCount

platformUpdateDomainCount?: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface AvailabilitySetState

Input properties used for looking up and filtering AvailabilitySet resources.

property location

location?: pulumi.Input<string>;

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

property managed

managed?: pulumi.Input<boolean>;

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

property name

name?: pulumi.Input<string>;

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

property platformFaultDomainCount

platformFaultDomainCount?: pulumi.Input<number>;

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

property platformUpdateDomainCount

platformUpdateDomainCount?: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface DataDiskAttachmentArgs

The set of arguments for constructing a DataDiskAttachment resource.

property caching

caching: pulumi.Input<string>;

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

property createOption

createOption?: pulumi.Input<string>;

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

property lun

lun: pulumi.Input<number>;

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.

property managedDiskId

managedDiskId: pulumi.Input<string>;

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

property virtualMachineId

virtualMachineId: pulumi.Input<string>;

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

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

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.

interface DataDiskAttachmentState

Input properties used for looking up and filtering DataDiskAttachment resources.

property caching

caching?: pulumi.Input<string>;

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

property createOption

createOption?: pulumi.Input<string>;

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

property lun

lun?: pulumi.Input<number>;

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.

property managedDiskId

managedDiskId?: pulumi.Input<string>;

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

property virtualMachineId

virtualMachineId?: pulumi.Input<string>;

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

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

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.

interface ExtensionArgs

The set of arguments for constructing a Extension resource.

property autoUpgradeMinorVersion

autoUpgradeMinorVersion?: pulumi.Input<boolean>;

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

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property protectedSettings

protectedSettings?: pulumi.Input<string>;

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

property publisher

publisher: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property settings

settings?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

property type

type: pulumi.Input<string>;

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

property typeHandlerVersion

typeHandlerVersion: pulumi.Input<string>;

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

property virtualMachineName

virtualMachineName: pulumi.Input<string>;

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

interface ExtensionState

Input properties used for looking up and filtering Extension resources.

property autoUpgradeMinorVersion

autoUpgradeMinorVersion?: pulumi.Input<boolean>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property protectedSettings

protectedSettings?: pulumi.Input<string>;

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

property publisher

publisher?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property settings

settings?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

property type

type?: pulumi.Input<string>;

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

property typeHandlerVersion

typeHandlerVersion?: pulumi.Input<string>;

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

property virtualMachineName

virtualMachineName?: pulumi.Input<string>;

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

interface GetImageArgs

A collection of arguments for invoking getImage.

property name

name?: string;

The name of the Image.

property nameRegex

nameRegex?: string;

Regex pattern of the image to match.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where this Image exists.

property sortDescending

sortDescending?: boolean;

By default when matching by regex, images are sorted by name in ascending order and the first match is chosen, to sort descending, set this flag.

interface GetImageResult

A collection of values returned by getImage.

property dataDisks

dataDisks: { ... }[];

a collection of data_disk blocks as defined below.

property id

id: string;

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

property location

location: string;

the Azure Location where this Image exists.

property osDisks

osDisks: { ... }[];

a os_disk block as defined below.

property tags

tags: { ... };

a mapping of tags to assigned to the resource.

interface GetManagedDiskArgs

A collection of arguments for invoking getManagedDisk.

property name

name: string;

Specifies the name of the Managed Disk.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group.

property tags

tags?: { ... };

property zones

zones?: string[];

interface GetManagedDiskResult

A collection of values returned by getManagedDisk.

property diskSizeGb

diskSizeGb: number;

The size of the managed disk in gigabytes.

property id

id: string;

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

property osType

osType: string;

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

property sourceResourceId

sourceResourceId: string;

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

property sourceUri

sourceUri: string;

The source URI for the managed disk

property storageAccountType

storageAccountType: string;

The storage account type for the managed disk.

property tags

tags: { ... };

A mapping of tags assigned to the resource.

property zones

zones: string[];

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

interface GetPlatformImageArgs

A collection of arguments for invoking getPlatformImage.

property location

location: string;

Specifies the Location to pull information about this Platform Image from.

property offer

offer: string;

Specifies the Offer associated with the Platform Image.

property publisher

publisher: string;

Specifies the Publisher associated with the Platform Image.

property sku

sku: string;

Specifies the SKU of the Platform Image.

interface GetPlatformImageResult

A collection of values returned by getPlatformImage.

property id

id: string;

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

property version

version: string;

The latest version of the Platform Image.

interface GetSnapshotArgs

A collection of arguments for invoking getSnapshot.

property name

name: string;

Specifies the name of the Snapshot.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the Snapshot is located in.

interface GetSnapshotResult

A collection of values returned by getSnapshot.

property creationOption

creationOption: string;

property diskSizeGb

diskSizeGb: string;

The size of the Snapshotted Disk in GB.

property encryptionSettings

encryptionSettings: { ... }[];

property id

id: string;

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

property osType

osType: string;

property sourceResourceId

sourceResourceId: string;

The reference to an existing snapshot.

property sourceUri

sourceUri: string;

The URI to a Managed or Unmanaged Disk.

property storageAccountId

storageAccountId: string;

The ID of an storage account.

property timeCreated

timeCreated: string;

interface ImageArgs

The set of arguments for constructing a Image resource.

property dataDisks

dataDisks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more data_disk elements as defined below.

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property osDisk

osDisk?: pulumi.Input<{ ... }>;

One or more os_disk elements as defined below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property sourceVirtualMachineId

sourceVirtualMachineId?: pulumi.Input<string>;

The Virtual Machine ID from which to create the image.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ImageState

Input properties used for looking up and filtering Image resources.

property dataDisks

dataDisks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more data_disk elements as defined below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property osDisk

osDisk?: pulumi.Input<{ ... }>;

One or more os_disk elements as defined below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property sourceVirtualMachineId

sourceVirtualMachineId?: pulumi.Input<string>;

The Virtual Machine ID from which to create the image.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ManagedDiskArgs

The set of arguments for constructing a ManagedDisk resource.

property createOption

createOption: pulumi.Input<string>;

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

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

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.

property encryptionSettings

encryptionSettings?: pulumi.Input<{ ... }>;

an encryption_settings block as defined below.

property imageReferenceId

imageReferenceId?: pulumi.Input<string>;

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

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property osType

osType?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property sourceResourceId

sourceResourceId?: pulumi.Input<string>;

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

property sourceUri

sourceUri?: pulumi.Input<string>;

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

property storageAccountType

storageAccountType: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<string>;

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

interface ManagedDiskState

Input properties used for looking up and filtering ManagedDisk resources.

property createOption

createOption?: pulumi.Input<string>;

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

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

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.

property encryptionSettings

encryptionSettings?: pulumi.Input<{ ... }>;

an encryption_settings block as defined below.

property imageReferenceId

imageReferenceId?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property osType

osType?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property sourceResourceId

sourceResourceId?: pulumi.Input<string>;

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

property sourceUri

sourceUri?: pulumi.Input<string>;

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

property storageAccountType

storageAccountType?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property zones

zones?: pulumi.Input<string>;

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

interface ScaleSetArgs

The set of arguments for constructing a ScaleSet resource.

property bootDiagnostics

bootDiagnostics?: pulumi.Input<{ ... }>;

A boot diagnostics profile block as referenced below.

property extensions

extensions?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property identity

identity?: pulumi.Input<{ ... }>;

property licenseType

licenseType?: pulumi.Input<string>;

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

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the image from the marketplace.

property networkProfiles

networkProfiles: pulumi.Input<pulumi.Input<{ ... }>[]>;

A collection of network profile block as documented below.

property osProfile

osProfile: pulumi.Input<{ ... }>;

A Virtual Machine OS Profile block as documented below.

property osProfileLinuxConfig

osProfileLinuxConfig?: pulumi.Input<{ ... }>;

A Linux config block as documented below.

property osProfileSecrets

osProfileSecrets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A collection of Secret blocks as documented below.

property osProfileWindowsConfig

osProfileWindowsConfig?: pulumi.Input<{ ... }>;

A Windows config block as documented below.

property overprovision

overprovision?: pulumi.Input<boolean>;

Specifies whether the virtual machine scale set should be overprovisioned. Defaults to true.

property plan

plan?: pulumi.Input<{ ... }>;

A plan block as documented below.

property priority

priority?: pulumi.Input<string>;

Specifies the priority for the virtual machines in the scale set, defaults to Regular. Possible values are Low and Regular.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property singlePlacementGroup

singlePlacementGroup?: pulumi.Input<boolean>;

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. Defaults to true. Changing this forces a new resource to be created. See documentation for more information.

property sku

sku: pulumi.Input<{ ... }>;

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

property storageProfileDataDisks

storageProfileDataDisks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A storage profile data disk block as documented below

property storageProfileImageReference

storageProfileImageReference?: pulumi.Input<{ ... }>;

A storage profile image reference block as documented below.

property storageProfileOsDisk

storageProfileOsDisk: pulumi.Input<{ ... }>;

A storage profile os disk block as documented below

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property upgradePolicyMode

upgradePolicyMode: pulumi.Input<string>;

Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Manual or Automatic.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

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

interface ScaleSetState

Input properties used for looking up and filtering ScaleSet resources.

property bootDiagnostics

bootDiagnostics?: pulumi.Input<{ ... }>;

A boot diagnostics profile block as referenced below.

property extensions

extensions?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property identity

identity?: pulumi.Input<{ ... }>;

property licenseType

licenseType?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the image from the marketplace.

property networkProfiles

networkProfiles?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A collection of network profile block as documented below.

property osProfile

osProfile?: pulumi.Input<{ ... }>;

A Virtual Machine OS Profile block as documented below.

property osProfileLinuxConfig

osProfileLinuxConfig?: pulumi.Input<{ ... }>;

A Linux config block as documented below.

property osProfileSecrets

osProfileSecrets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A collection of Secret blocks as documented below.

property osProfileWindowsConfig

osProfileWindowsConfig?: pulumi.Input<{ ... }>;

A Windows config block as documented below.

property overprovision

overprovision?: pulumi.Input<boolean>;

Specifies whether the virtual machine scale set should be overprovisioned. Defaults to true.

property plan

plan?: pulumi.Input<{ ... }>;

A plan block as documented below.

property priority

priority?: pulumi.Input<string>;

Specifies the priority for the virtual machines in the scale set, defaults to Regular. Possible values are Low and Regular.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property singlePlacementGroup

singlePlacementGroup?: pulumi.Input<boolean>;

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. Defaults to true. Changing this forces a new resource to be created. See documentation for more information.

property sku

sku?: pulumi.Input<{ ... }>;

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

property storageProfileDataDisks

storageProfileDataDisks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A storage profile data disk block as documented below

property storageProfileImageReference

storageProfileImageReference?: pulumi.Input<{ ... }>;

A storage profile image reference block as documented below.

property storageProfileOsDisk

storageProfileOsDisk?: pulumi.Input<{ ... }>;

A storage profile os disk block as documented below

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property upgradePolicyMode

upgradePolicyMode?: pulumi.Input<string>;

Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Manual or Automatic.

property zones

zones?: pulumi.Input<pulumi.Input<string>[]>;

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

interface SnapshotArgs

The set of arguments for constructing a Snapshot resource.

property createOption

createOption: pulumi.Input<string>;

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

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

The size of the Snapshotted Disk in GB.

property encryptionSettings

encryptionSettings?: pulumi.Input<{ ... }>;

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property sourceResourceId

sourceResourceId?: pulumi.Input<string>;

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

property sourceUri

sourceUri?: pulumi.Input<string>;

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

property storageAccountId

storageAccountId?: pulumi.Input<string>;

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.

property tags

tags?: pulumi.Input<{ ... }>;

interface SnapshotState

Input properties used for looking up and filtering Snapshot resources.

property createOption

createOption?: pulumi.Input<string>;

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

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

The size of the Snapshotted Disk in GB.

property encryptionSettings

encryptionSettings?: pulumi.Input<{ ... }>;

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property sourceResourceId

sourceResourceId?: pulumi.Input<string>;

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

property sourceUri

sourceUri?: pulumi.Input<string>;

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

property storageAccountId

storageAccountId?: pulumi.Input<string>;

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.

property tags

tags?: pulumi.Input<{ ... }>;

interface VirtualMachineArgs

The set of arguments for constructing a VirtualMachine resource.

property availabilitySetId

availabilitySetId?: pulumi.Input<string>;

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

property bootDiagnostics

bootDiagnostics?: pulumi.Input<{ ... }>;

A boot_diagnostics block.

property deleteDataDisksOnTermination

deleteDataDisksOnTermination?: pulumi.Input<boolean>;

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

property deleteOsDiskOnTermination

deleteOsDiskOnTermination?: pulumi.Input<boolean>;

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

property identity

identity?: pulumi.Input<{ ... }>;

A identity block.

property licenseType

licenseType?: pulumi.Input<string>;

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

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the OS Disk.

property networkInterfaceIds

networkInterfaceIds: pulumi.Input<pulumi.Input<string>[]>;

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

property osProfile

osProfile?: pulumi.Input<{ ... }>;

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

property osProfileLinuxConfig

osProfileLinuxConfig?: pulumi.Input<{ ... }>;

A os_profile_linux_config block.

property osProfileSecrets

osProfileSecrets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more os_profile_secrets blocks.

property osProfileWindowsConfig

osProfileWindowsConfig?: pulumi.Input<{ ... }>;

A os_profile_windows_config block.

property plan

plan?: pulumi.Input<{ ... }>;

A plan block.

property primaryNetworkInterfaceId

primaryNetworkInterfaceId?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property storageDataDisks

storageDataDisks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more storage_data_disk blocks.

property storageImageReference

storageImageReference?: pulumi.Input<{ ... }>;

A storage_image_reference block.

property storageOsDisk

storageOsDisk: pulumi.Input<{ ... }>;

A storage_os_disk block.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the Virtual Machine.

property vmSize

vmSize: pulumi.Input<string>;

Specifies the size of the Virtual Machine.

property zones

zones?: pulumi.Input<string>;

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

interface VirtualMachineState

Input properties used for looking up and filtering VirtualMachine resources.

property availabilitySetId

availabilitySetId?: pulumi.Input<string>;

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

property bootDiagnostics

bootDiagnostics?: pulumi.Input<{ ... }>;

A boot_diagnostics block.

property deleteDataDisksOnTermination

deleteDataDisksOnTermination?: pulumi.Input<boolean>;

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

property deleteOsDiskOnTermination

deleteOsDiskOnTermination?: pulumi.Input<boolean>;

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

property identity

identity?: pulumi.Input<{ ... }>;

A identity block.

property licenseType

licenseType?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the OS Disk.

property networkInterfaceIds

networkInterfaceIds?: pulumi.Input<pulumi.Input<string>[]>;

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

property osProfile

osProfile?: pulumi.Input<{ ... }>;

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

property osProfileLinuxConfig

osProfileLinuxConfig?: pulumi.Input<{ ... }>;

A os_profile_linux_config block.

property osProfileSecrets

osProfileSecrets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more os_profile_secrets blocks.

property osProfileWindowsConfig

osProfileWindowsConfig?: pulumi.Input<{ ... }>;

A os_profile_windows_config block.

property plan

plan?: pulumi.Input<{ ... }>;

A plan block.

property primaryNetworkInterfaceId

primaryNetworkInterfaceId?: pulumi.Input<string>;

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.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property storageDataDisks

storageDataDisks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more storage_data_disk blocks.

property storageImageReference

storageImageReference?: pulumi.Input<{ ... }>;

A storage_image_reference block.

property storageOsDisk

storageOsDisk?: pulumi.Input<{ ... }>;

A storage_os_disk block.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the Virtual Machine.

property vmSize

vmSize?: pulumi.Input<string>;

Specifies the size of the Virtual Machine.

property zones

zones?: pulumi.Input<string>;

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