Cloud.Azure.Machine

Cloud.Azure.Machine
Cloud.Azure.Machine

Request schema for provisioning of an Azure machine resource

AnyOf
This class requires at least one of the following:
undefined
undefined
JSON Example
{
    "account": "string",
    "activeDirectory": {
        "finalRelativeDN": "string",
        "relativeDN": "string",
        "securityGroup": "string"
    },
    "address": "string",
    "attachAvailabilityZone": false,
    "attachedDisks": [
        {
            "source": "string"
        }
    ],
    "automaticOSPatchUpdate": false,
    "availabilitySetName": "string",
    "bootDiagnostics": false,
    "cloudConfig": "string",
    "cloudConfigSettings": {
        "deploymentFailOnCloudConfigRuntimeError": false,
        "phoneHomeFailOnTimeout": false,
        "phoneHomeShouldWait": false,
        "phoneHomeTimeoutSeconds": 0
    },
    "constraints": [
        {
            "tag": "string"
        }
    ],
    "count": 0,
    "doNotAttachAvailabilitySet": false,
    "extensions": [
        {
            "autoUpgradeMinorVersion": false,
            "name": "string",
            "protectedSettings": {},
            "publisher": "string",
            "settings": {},
            "type": "string",
            "typeHandlerVersion": "string"
        }
    ],
    "flavor": "string",
    "flavorRef": "string",
    "ignoreActiveDirectory": "string",
    "image": "string",
    "imageRef": "string",
    "name": "string",
    "networks": [
        {
            "address": "string",
            "assignPublicIpAddress": false,
            "assignment": "string",
            "deviceIndex": 0,
            "network": "string"
        }
    ],
    "osType": "string",
    "powerState": "string",
    "project": "string",
    "providerId": "string",
    "region": "string",
    "remoteAccess": {
        "authentication": "string",
        "password": "string",
        "privateKey": "string",
        "sshKey": "string",
        "username": "string"
    },
    "resourceGroupName": "string",
    "resourceName": "string",
    "storage": {
        "bootDiskCapacityInGB": 0,
        "bootDiskName": "string",
        "constraints": [
            {
                "tag": "string"
            }
        ],
        "managedDiskType": "string",
        "maxDiskCapacityInGB": 0,
        "storageAccountName": "string"
    },
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
account
Optional

Cloud Account indicates the name of the endpoint used to provision this machine.

object
activeDirectory
Optional

Active Directory Configuration

string
address
Optional

Machine IP address, populated by discovery or provisioning.

boolean
attachAvailabilityZone
Optional

If this property is true, the machine is going to be placed on availability zone if supported by the cloud

array of object
attachedDisks
Optional

List of disks to attach to the machine.

boolean
automaticOSPatchUpdate
Optional

If this property is false, the machine needs manual effort to update OS patches

string
availabilitySetName
Optional

Name of the availability set that this machine is going to be part of.

boolean
bootDiagnostics
Optional

Boot diagnostics is a debugging feature for Azure virtual machines (VM) that allows diagnosis of VM boot failures. Boot diagnostics enables a user to observe the state of their VM as it is booting up by collecting serial log information and screenshots.

string
cloudConfig
Optional

When provisioning an instance, machine cloud-init startup instructions from user data fields. Sample cloud config instructions:

#cloud-config
repo_update: true
repo_upgrade: all
packages:
- httpd
- mariadb-server

runcmd:
- [ sh, -c, "amazon-linux-extras install -y lamp-mariadb10.2-php7.2 php7.2" ]
- systemctl start httpd
- sudo systemctl enable httpd
object
cloudConfigSettings
Optional

Specify how the provided Cloud Config should be handled

array of object
constraints
Optional

To target the correct resources, blueprint constraints are matched against infrastructure capability tags. Constraints must include the key name. Options include value, negative[!], and hard or soft requirement.

integer
count
Optional

The number of resource instances to be created.

boolean
doNotAttachAvailabilitySet
Optional

If this property is true, the machine is not going to be created within an availability set (the default value is false)

array of object
extensions
Optional

Azure VM extensions to be created and attached when provisioning this machine. There are three properties that uniquely identify the Azure Extension - "publisher", "type" and "typeHandlerVersion". For the list of available Azure extensions see: https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/features-windows#common-vm-extensions-reference and https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/features-linux#common-vm-extension-reference.

string
flavor
Optional

Azure instance type.

string
flavorRef
Optional

Provider specific flavor reference. Valid if no flavor property is provided.

string
ignoreActiveDirectory
Optional

Indicates that the machine is not added to Active Directory by a policy. It skips the Active Directory policy.

Possible values are : true, false,
string
image
Optional

Generic machine images, mapped in an environment to specific compute resource images.

string As ^\S+:\S+:\S+:\S+|/subscriptions/\S+/resourceGroups/\S+/providers/Microsoft.Compute/images/\S+$|/subscriptions/\S+/resourceGroups/\S+/providers/Microsoft.Compute/galleries/\S+/images/\S+/versions/\S+$
imageRef
Optional

Azure machine image used to create the instance.

string
name
Optional

Machine name.

array of object
networks
Optional

Networks to attach to the machine. Multiple network interfaces are allowed.

string
osType
Optional

Operating system of the machine, populated by discovery or provisioning. Values include WINDOWS and LINUX.

string
powerState
Optional

Machine power state of ON, OFF, GUEST_OFF, UNKNOWN, or SUSPEND.

Possible values are : ON, OFF, SUSPEND, GUEST_OFF,
string
project
Optional

VMware Aria Automation Assembler project under which the machine is provisioned. Indicates project ID.

string
providerId
Optional

A unique identifier of the resource in the context of the provider.

string
region
Optional

Location where the machine landed.

object
remoteAccess
Optional

Settings to remotely connect to the provisioned machine, by public/private key pair or username/password authentication.

string
resourceGroupName
Optional

Name of the resource group that holds all related resources.

string
resourceName
Optional

The actual name of the machine determined after the allocation.

object
storage
Optional

Settings for constraining to the correct storage at provisioning time.

array of object
tags
Optional

Resource categorization, in case-sensitive key names, or in key-value pairs.