Share via


ResourceProvisionPayload interface

Resource creation data model

Properties

baseProfile

JSON object that contains VM properties that are common across all VMs in this batch (if you want to create 100 VMs in this request, and they all have same vmSize, then include vmSize in baseProfile)

resourceCount

Number of VMs to be created

resourceOverrides

JSON array, that contains VM properties that should to be overridden for each VM in the batch (if you want to create 100 VMs, they all need a distinct computerName property, you pass computerNames for each VM in batch in this array), service will merge baseProfile with VM specific overrides and create a merged VMProfile.

resourcePrefix

if resourceOverrides doesn't contain "name", service will create name based of prefix and ResourceCount e.g. resourceprefix-0,resourceprefix-1..

Property Details

baseProfile

JSON object that contains VM properties that are common across all VMs in this batch (if you want to create 100 VMs in this request, and they all have same vmSize, then include vmSize in baseProfile)

baseProfile?: Record<string, any>

Property Value

Record<string, any>

resourceCount

Number of VMs to be created

resourceCount: number

Property Value

number

resourceOverrides

JSON array, that contains VM properties that should to be overridden for each VM in the batch (if you want to create 100 VMs, they all need a distinct computerName property, you pass computerNames for each VM in batch in this array), service will merge baseProfile with VM specific overrides and create a merged VMProfile.

resourceOverrides?: Record<string, any>[]

Property Value

Record<string, any>[]

resourcePrefix

if resourceOverrides doesn't contain "name", service will create name based of prefix and ResourceCount e.g. resourceprefix-0,resourceprefix-1..

resourcePrefix?: string

Property Value

string