☰
Navigation :

azVirtualMachine

Use the resource azVirtualMachine to deploy an Azure Virtual Machine.

Attributes

Attribute Type Mandatory Values Default Notes
Name String Yes
ResourceGroupName String Yes
Location String Yes
AdminUsername String Yes
AdminPassword Object Yes
OSDiskName String No Default: disk-vmname-os
OSDiskSizeInGB Number Yes
Zone Array
PublisherName String Yes
Offer String Yes
Sku String Yes
Version String No
Size String Yes
LicenseType String No None (D), Windows_Server None
StorageAccountName String
EnableRemotePS Boolean No False
DisableWindowsUpdate Boolean No False
AvailabilitySetName String No
DisableWindowsUpdate Boolean No
NetworkInterface List No
Identity Object No
Disk Object No
Extension Object No
Tag Object No
Lock Object No

Disk

Please supply a disk object as a list for the virtual machine.

Attribute Type Mandatory Values Default Notes
Name String Yes
NTFSBlockSize Number Yes
Letter String Yes
Label String Yes
LUN Number Yes
Caching String No None, Readonly, ReadWrite None

Extension

Virtual machine extensions can be specified.

Attribute Type Mandatory Values Default Notes
Name String Yes
Publisher String Yes
Type String Yes
TypeHandlerVersion String Yes

Input by YAML

Object model for YAML deployment:

---
azVirtualMachine:
  # Mandatory
  - Name: 'string'
    ResourceGroupName: 'string'
    Location: 'string'
    AdminUsername: 'string'
    AdminPassword:
      Location: 'string'
      PlainText:
        Value: 'string'
      AzureVault:
        VaultName: 'string'
        SecretName: 'string'
    OSDiskSizeInGB: number
    Zone: [array]                               # Zone number(s)
    PublisherName: 'string'
    Offer: 'string'
    Sku: 'string'
    NetworkInterface:
      - Name: 'string'
    # Optional
    Size: 'string'                              # Standard_D2s_v3 (D)
    ComputerName: 'string'                      # Default: first 15 chars of name
    OSDiskName: 'string'                        # Default: disk-<name>-os
    LicenseType: 'string'                       # None (D), Windows_Server
    StorageAccountName: 'string'                # Used for boot diagnostics, diagnostics disabled if not supplied
    EnableRemotePS: boolean                     # True, False (D)
    DisableWindowsUpdate: boolean               # True, False (D)
    AvailabilitySetName: 'string'
    Disk:
      - Name: 'string'
        NTFSBlockSize: number
        Letter: 'string'
        Label: 'string'
        Lun: number
        Caching: 'string'                       # None (D), Readonly, ReadWrite
    Extension:
      - Name: 'string'
        Publisher: 'string'
        Type: 'string'
        TypeHandlerVersion: 'string'
    Identity:
      SystemIdentity: boolean                   # True, False (D)
      UserIdentity:
        - Name: 'string'
          ResourceGroupName: 'string'
    Tag: 
      'keyvalue-pairs'
    Lock:
      - Name: 'string'
        Level: 'string'                         # CanNotDelete, ReadOnly
        Notes: 'string'

Input by JSON

Object model for JSON deployment:

{
  "azVirtualMachine": [
    {
      "Name": "string",
      "AdminUsername": "string",
      "AdminPassword": {
        "Location": "string",
        "PlainText": {
          "Value": "string"
        },
        "AzureVault": {
          "VaultName": "string",
          "SecretName": "string"
        }
      },
      "OSDiskName": "string",
      "OSDiskSizeInGB": number,
      "ResourceGroupName": "string",
      "Location": "string",
      "Zone": [array],
      "PublisherName": "string",
      "Offer": "string",
      "Sku": "string",
      "Size": "string",
      "LicenseType": "string",
      "StorageAccountName": "string",
      "EnableRemotePS": boolean,
      "DisableWindowsUpdate": boolean,
      "AvailabilitySetName": "string",
      "NetworkInterface": [
        {
          "Name": "string"
        }
      ],
      "Disk": [
        {
          "Name": "string",
          "NTFSBlockSize": number,
          "Letter": "string",
          "Label": "string",
          "Lun": number,
          "Caching": "string"
        }
      ],
      "Extension": [
        {
          "Name": "string",
          "Publisher": "string",
          "Type": "string",
          "TypeHandlerVersion": "string"
        }
      ],
      "Identity": {
        "SystemIdentity": boolean,
        "UserIdentity": [
          {
            "Name": "string",
            "ResourceGroupName": "string"
          }
        ]
      },
      "Tag": {
        "key": "value"
      },
      "Lock": [
        {
          "Name": "string",
          "Level": "string",
          "Notes": "string"
        }
      ]
    }
  ]
}