Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The locations/bulkCreateCustom resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/locations/bulkCreateCustom resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/locations/bulkCreateCustom@2026-08-06-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
capacity: int
capacityType: 'string'
computeProfile: {
computeApiVersion: 'string'
extensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
protectedSettings: {
{customized property}: any(...)
}
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: {
{customized property}: any(...)
}
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
]
virtualMachineProfile: {
additionalCapabilities: {
hibernationEnabled: bool
ultraSSDEnabled: bool
}
applicationProfile: {
galleryApplications: [
{
configurationReference: 'string'
enableAutomaticUpgrade: bool
order: int
packageReferenceId: 'string'
tags: 'string'
treatFailureAsDeploymentFailure: bool
}
]
}
capacityReservation: {
capacityReservationGroup: {
id: 'string'
}
}
diagnosticsProfile: {
bootDiagnostics: {
enabled: bool
storageUri: 'string'
}
}
extensionsTimeBudget: 'string'
hardwareProfile: {
vmSize: 'string'
vmSizeProperties: {
vCpusAvailable: int
vCpusPerCore: int
}
}
licenseType: 'string'
networkProfile: {
networkApiVersion: 'string'
networkInterfaceConfigurations: [
{
name: 'string'
properties: {
auxiliaryMode: 'string'
auxiliarySku: 'string'
deleteOption: 'string'
disableTcpStateTracking: bool
dnsSettings: {
dnsServers: [
'string'
]
}
dscpConfiguration: {
id: 'string'
}
enableAcceleratedNetworking: bool
enableFpga: bool
enableIPForwarding: bool
ipConfigurations: [
{
name: 'string'
properties: {
applicationGatewayBackendAddressPools: [
{
id: 'string'
}
]
applicationSecurityGroups: [
{
id: 'string'
}
]
loadBalancerBackendAddressPools: [
{
id: 'string'
}
]
primary: bool
privateIPAddressVersion: 'string'
publicIPAddressConfiguration: {
name: 'string'
properties: {
deleteOption: 'string'
dnsSettings: {
domainNameLabel: 'string'
domainNameLabelScope: 'string'
}
idleTimeoutInMinutes: int
ipTags: [
{
ipTagType: 'string'
tag: 'string'
}
]
publicIPAddressVersion: 'string'
publicIPAllocationMethod: 'string'
publicIPPrefix: {
id: 'string'
}
}
sku: {
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
subnet: {
id: 'string'
}
}
}
]
networkSecurityGroup: {
id: 'string'
}
primary: bool
}
tags: {
{customized property}: 'string'
}
}
]
networkInterfaces: [
{
id: 'string'
properties: {
deleteOption: 'string'
primary: bool
}
}
]
}
osProfile: {
adminPassword: 'string'
adminUsername: 'string'
allowExtensionOperations: bool
computerName: 'string'
customData: 'string'
linuxConfiguration: {
disablePasswordAuthentication: bool
enableVMAgentPlatformUpdates: bool
patchSettings: {
assessmentMode: 'string'
automaticByPlatformSettings: {
bypassPlatformSafetyChecksOnUserSchedule: bool
rebootSetting: 'string'
}
patchMode: 'string'
}
provisionVMAgent: bool
ssh: {
publicKeys: [
{
keyData: 'string'
path: 'string'
}
]
}
}
requireGuestProvisionSignal: bool
secrets: [
{
sourceVault: {
id: 'string'
}
vaultCertificates: [
{
certificateStore: 'string'
certificateUrl: 'string'
}
]
}
]
windowsConfiguration: {
additionalUnattendContent: [
{
componentName: 'Microsoft-Windows-Shell-Setup'
content: 'string'
passName: 'OobeSystem'
settingName: 'string'
}
]
enableAutomaticUpdates: bool
patchSettings: {
assessmentMode: 'string'
automaticByPlatformSettings: {
bypassPlatformSafetyChecksOnUserSchedule: bool
rebootSetting: 'string'
}
enableHotpatching: bool
patchMode: 'string'
}
provisionVMAgent: bool
timeZone: 'string'
winRM: {
listeners: [
{
certificateUrl: 'string'
protocol: 'string'
}
]
}
}
}
scheduledEventsPolicy: {
allInstancesDown: {
automaticallyApprove: bool
}
scheduledEventsAdditionalPublishingTargets: {
eventGridAndResourceGraph: {
enable: bool
scheduledEventsApiVersion: 'string'
}
}
userInitiatedReboot: {
automaticallyApprove: bool
}
userInitiatedRedeploy: {
automaticallyApprove: bool
}
}
scheduledEventsProfile: {
osImageNotificationProfile: {
enable: bool
notBeforeTimeout: 'string'
}
terminateNotificationProfile: {
enable: bool
notBeforeTimeout: 'string'
}
}
securityProfile: {
encryptionAtHost: bool
encryptionIdentity: {
userAssignedIdentityResourceId: 'string'
}
proxyAgentSettings: {
addProxyAgentExtension: bool
enabled: bool
imds: {
inVMAccessControlProfileReferenceId: 'string'
mode: 'string'
}
keyIncarnationId: int
mode: 'string'
wireServer: {
inVMAccessControlProfileReferenceId: 'string'
mode: 'string'
}
}
securityType: 'string'
uefiSettings: {
secureBootEnabled: bool
vTpmEnabled: bool
}
}
storageProfile: {
dataDisks: [
{
caching: 'string'
createOption: 'string'
deleteOption: 'string'
detachOption: 'string'
diskSizeGB: int
image: {
uri: 'string'
}
lun: int
managedDisk: {
diskEncryptionSet: {
id: 'string'
}
id: 'string'
securityProfile: {
diskEncryptionSet: {
id: 'string'
}
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
name: 'string'
sourceResource: {
id: 'string'
}
toBeDetached: bool
vhd: {
uri: 'string'
}
writeAcceleratorEnabled: bool
}
]
diskControllerType: 'string'
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
offer: 'string'
publisher: 'string'
sharedGalleryImageId: 'string'
sku: 'string'
version: 'string'
}
osDisk: {
caching: 'string'
createOption: 'string'
deleteOption: 'string'
diffDiskSettings: {
option: 'string'
placement: 'string'
}
diskSizeGB: int
encryptionSettings: {
diskEncryptionKey: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
enabled: bool
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
image: {
uri: 'string'
}
managedDisk: {
diskEncryptionSet: {
id: 'string'
}
id: 'string'
securityProfile: {
diskEncryptionSet: {
id: 'string'
}
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
name: 'string'
osType: 'string'
vhd: {
uri: 'string'
}
writeAcceleratorEnabled: bool
}
}
userData: 'string'
vmExtensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
protectedSettings: {
{customized property}: any(...)
}
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: {
{customized property}: any(...)
}
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
]
}
}
executionParameters: {
capacityRecommendationParameters: {
availabilityZones: bool
desiredLocations: [
'string'
]
desiredSizes: [
'string'
]
}
optimizationPreference: 'string'
retryPolicy: {
onFailureAction: 'string'
retryCount: int
retryWindowInMinutes: int
}
verifyVmAgentHealth: bool
}
minCapacity: int
overridesProfile: {
overrides: [
{
extensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
protectedSettings: {
{customized property}: any(...)
}
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: {
{customized property}: any(...)
}
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
]
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
tags: {
{customized property}: 'string'
}
virtualMachineName: 'string'
virtualMachineProfile: {
additionalCapabilities: {
hibernationEnabled: bool
ultraSSDEnabled: bool
}
applicationProfile: {
galleryApplications: [
{
configurationReference: 'string'
enableAutomaticUpgrade: bool
order: int
packageReferenceId: 'string'
tags: 'string'
treatFailureAsDeploymentFailure: bool
}
]
}
capacityReservation: {
capacityReservationGroup: {
id: 'string'
}
}
diagnosticsProfile: {
bootDiagnostics: {
enabled: bool
storageUri: 'string'
}
}
extensionsTimeBudget: 'string'
hardwareProfile: {
vmSize: 'string'
vmSizeProperties: {
vCpusAvailable: int
vCpusPerCore: int
}
}
licenseType: 'string'
networkProfile: {
networkApiVersion: 'string'
networkInterfaceConfigurations: [
{
name: 'string'
properties: {
auxiliaryMode: 'string'
auxiliarySku: 'string'
deleteOption: 'string'
disableTcpStateTracking: bool
dnsSettings: {
dnsServers: [
'string'
]
}
dscpConfiguration: {
id: 'string'
}
enableAcceleratedNetworking: bool
enableFpga: bool
enableIPForwarding: bool
ipConfigurations: [
{
name: 'string'
properties: {
applicationGatewayBackendAddressPools: [
{
id: 'string'
}
]
applicationSecurityGroups: [
{
id: 'string'
}
]
loadBalancerBackendAddressPools: [
{
id: 'string'
}
]
primary: bool
privateIPAddressVersion: 'string'
publicIPAddressConfiguration: {
name: 'string'
properties: {
deleteOption: 'string'
dnsSettings: {
domainNameLabel: 'string'
domainNameLabelScope: 'string'
}
idleTimeoutInMinutes: int
ipTags: [
{
ipTagType: 'string'
tag: 'string'
}
]
publicIPAddressVersion: 'string'
publicIPAllocationMethod: 'string'
publicIPPrefix: {
id: 'string'
}
}
sku: {
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
subnet: {
id: 'string'
}
}
}
]
networkSecurityGroup: {
id: 'string'
}
primary: bool
}
tags: {
{customized property}: 'string'
}
}
]
networkInterfaces: [
{
id: 'string'
properties: {
deleteOption: 'string'
primary: bool
}
}
]
}
osProfile: {
adminPassword: 'string'
adminUsername: 'string'
allowExtensionOperations: bool
computerName: 'string'
customData: 'string'
linuxConfiguration: {
disablePasswordAuthentication: bool
enableVMAgentPlatformUpdates: bool
patchSettings: {
assessmentMode: 'string'
automaticByPlatformSettings: {
bypassPlatformSafetyChecksOnUserSchedule: bool
rebootSetting: 'string'
}
patchMode: 'string'
}
provisionVMAgent: bool
ssh: {
publicKeys: [
{
keyData: 'string'
path: 'string'
}
]
}
}
requireGuestProvisionSignal: bool
secrets: [
{
sourceVault: {
id: 'string'
}
vaultCertificates: [
{
certificateStore: 'string'
certificateUrl: 'string'
}
]
}
]
windowsConfiguration: {
additionalUnattendContent: [
{
componentName: 'Microsoft-Windows-Shell-Setup'
content: 'string'
passName: 'OobeSystem'
settingName: 'string'
}
]
enableAutomaticUpdates: bool
patchSettings: {
assessmentMode: 'string'
automaticByPlatformSettings: {
bypassPlatformSafetyChecksOnUserSchedule: bool
rebootSetting: 'string'
}
enableHotpatching: bool
patchMode: 'string'
}
provisionVMAgent: bool
timeZone: 'string'
winRM: {
listeners: [
{
certificateUrl: 'string'
protocol: 'string'
}
]
}
}
}
scheduledEventsPolicy: {
allInstancesDown: {
automaticallyApprove: bool
}
scheduledEventsAdditionalPublishingTargets: {
eventGridAndResourceGraph: {
enable: bool
scheduledEventsApiVersion: 'string'
}
}
userInitiatedReboot: {
automaticallyApprove: bool
}
userInitiatedRedeploy: {
automaticallyApprove: bool
}
}
scheduledEventsProfile: {
osImageNotificationProfile: {
enable: bool
notBeforeTimeout: 'string'
}
terminateNotificationProfile: {
enable: bool
notBeforeTimeout: 'string'
}
}
securityProfile: {
encryptionAtHost: bool
encryptionIdentity: {
userAssignedIdentityResourceId: 'string'
}
proxyAgentSettings: {
addProxyAgentExtension: bool
enabled: bool
imds: {
inVMAccessControlProfileReferenceId: 'string'
mode: 'string'
}
keyIncarnationId: int
mode: 'string'
wireServer: {
inVMAccessControlProfileReferenceId: 'string'
mode: 'string'
}
}
securityType: 'string'
uefiSettings: {
secureBootEnabled: bool
vTpmEnabled: bool
}
}
storageProfile: {
dataDisks: [
{
caching: 'string'
createOption: 'string'
deleteOption: 'string'
detachOption: 'string'
diskSizeGB: int
image: {
uri: 'string'
}
lun: int
managedDisk: {
diskEncryptionSet: {
id: 'string'
}
id: 'string'
securityProfile: {
diskEncryptionSet: {
id: 'string'
}
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
name: 'string'
sourceResource: {
id: 'string'
}
toBeDetached: bool
vhd: {
uri: 'string'
}
writeAcceleratorEnabled: bool
}
]
diskControllerType: 'string'
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
offer: 'string'
publisher: 'string'
sharedGalleryImageId: 'string'
sku: 'string'
version: 'string'
}
osDisk: {
caching: 'string'
createOption: 'string'
deleteOption: 'string'
diffDiskSettings: {
option: 'string'
placement: 'string'
}
diskSizeGB: int
encryptionSettings: {
diskEncryptionKey: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
enabled: bool
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
image: {
uri: 'string'
}
managedDisk: {
diskEncryptionSet: {
id: 'string'
}
id: 'string'
securityProfile: {
diskEncryptionSet: {
id: 'string'
}
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
name: 'string'
osType: 'string'
vhd: {
uri: 'string'
}
writeAcceleratorEnabled: bool
}
}
userData: 'string'
vmExtensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
protectedSettings: {
{customized property}: any(...)
}
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: {
{customized property}: any(...)
}
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
]
}
}
]
virtualMachineNamePrefix: 'string'
}
partialFulfillmentPolicy: {
mode: 'string'
}
priorityProfile: {
allocationStrategy: 'string'
evictionPolicy: 'string'
maxPricePerVM: int
type: 'string'
}
vmSizesProfile: [
{
name: 'string'
override: {
extensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
protectedSettings: {
{customized property}: any(...)
}
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: {
{customized property}: any(...)
}
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
]
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
tags: {
{customized property}: 'string'
}
virtualMachineProfile: {
additionalCapabilities: {
hibernationEnabled: bool
ultraSSDEnabled: bool
}
applicationProfile: {
galleryApplications: [
{
configurationReference: 'string'
enableAutomaticUpgrade: bool
order: int
packageReferenceId: 'string'
tags: 'string'
treatFailureAsDeploymentFailure: bool
}
]
}
capacityReservation: {
capacityReservationGroup: {
id: 'string'
}
}
diagnosticsProfile: {
bootDiagnostics: {
enabled: bool
storageUri: 'string'
}
}
extensionsTimeBudget: 'string'
hardwareProfile: {
vmSize: 'string'
vmSizeProperties: {
vCpusAvailable: int
vCpusPerCore: int
}
}
licenseType: 'string'
networkProfile: {
networkApiVersion: 'string'
networkInterfaceConfigurations: [
{
name: 'string'
properties: {
auxiliaryMode: 'string'
auxiliarySku: 'string'
deleteOption: 'string'
disableTcpStateTracking: bool
dnsSettings: {
dnsServers: [
'string'
]
}
dscpConfiguration: {
id: 'string'
}
enableAcceleratedNetworking: bool
enableFpga: bool
enableIPForwarding: bool
ipConfigurations: [
{
name: 'string'
properties: {
applicationGatewayBackendAddressPools: [
{
id: 'string'
}
]
applicationSecurityGroups: [
{
id: 'string'
}
]
loadBalancerBackendAddressPools: [
{
id: 'string'
}
]
primary: bool
privateIPAddressVersion: 'string'
publicIPAddressConfiguration: {
name: 'string'
properties: {
deleteOption: 'string'
dnsSettings: {
domainNameLabel: 'string'
domainNameLabelScope: 'string'
}
idleTimeoutInMinutes: int
ipTags: [
{
ipTagType: 'string'
tag: 'string'
}
]
publicIPAddressVersion: 'string'
publicIPAllocationMethod: 'string'
publicIPPrefix: {
id: 'string'
}
}
sku: {
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
subnet: {
id: 'string'
}
}
}
]
networkSecurityGroup: {
id: 'string'
}
primary: bool
}
tags: {
{customized property}: 'string'
}
}
]
networkInterfaces: [
{
id: 'string'
properties: {
deleteOption: 'string'
primary: bool
}
}
]
}
osProfile: {
adminPassword: 'string'
adminUsername: 'string'
allowExtensionOperations: bool
computerName: 'string'
customData: 'string'
linuxConfiguration: {
disablePasswordAuthentication: bool
enableVMAgentPlatformUpdates: bool
patchSettings: {
assessmentMode: 'string'
automaticByPlatformSettings: {
bypassPlatformSafetyChecksOnUserSchedule: bool
rebootSetting: 'string'
}
patchMode: 'string'
}
provisionVMAgent: bool
ssh: {
publicKeys: [
{
keyData: 'string'
path: 'string'
}
]
}
}
requireGuestProvisionSignal: bool
secrets: [
{
sourceVault: {
id: 'string'
}
vaultCertificates: [
{
certificateStore: 'string'
certificateUrl: 'string'
}
]
}
]
windowsConfiguration: {
additionalUnattendContent: [
{
componentName: 'Microsoft-Windows-Shell-Setup'
content: 'string'
passName: 'OobeSystem'
settingName: 'string'
}
]
enableAutomaticUpdates: bool
patchSettings: {
assessmentMode: 'string'
automaticByPlatformSettings: {
bypassPlatformSafetyChecksOnUserSchedule: bool
rebootSetting: 'string'
}
enableHotpatching: bool
patchMode: 'string'
}
provisionVMAgent: bool
timeZone: 'string'
winRM: {
listeners: [
{
certificateUrl: 'string'
protocol: 'string'
}
]
}
}
}
scheduledEventsPolicy: {
allInstancesDown: {
automaticallyApprove: bool
}
scheduledEventsAdditionalPublishingTargets: {
eventGridAndResourceGraph: {
enable: bool
scheduledEventsApiVersion: 'string'
}
}
userInitiatedReboot: {
automaticallyApprove: bool
}
userInitiatedRedeploy: {
automaticallyApprove: bool
}
}
scheduledEventsProfile: {
osImageNotificationProfile: {
enable: bool
notBeforeTimeout: 'string'
}
terminateNotificationProfile: {
enable: bool
notBeforeTimeout: 'string'
}
}
securityProfile: {
encryptionAtHost: bool
encryptionIdentity: {
userAssignedIdentityResourceId: 'string'
}
proxyAgentSettings: {
addProxyAgentExtension: bool
enabled: bool
imds: {
inVMAccessControlProfileReferenceId: 'string'
mode: 'string'
}
keyIncarnationId: int
mode: 'string'
wireServer: {
inVMAccessControlProfileReferenceId: 'string'
mode: 'string'
}
}
securityType: 'string'
uefiSettings: {
secureBootEnabled: bool
vTpmEnabled: bool
}
}
storageProfile: {
dataDisks: [
{
caching: 'string'
createOption: 'string'
deleteOption: 'string'
detachOption: 'string'
diskSizeGB: int
image: {
uri: 'string'
}
lun: int
managedDisk: {
diskEncryptionSet: {
id: 'string'
}
id: 'string'
securityProfile: {
diskEncryptionSet: {
id: 'string'
}
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
name: 'string'
sourceResource: {
id: 'string'
}
toBeDetached: bool
vhd: {
uri: 'string'
}
writeAcceleratorEnabled: bool
}
]
diskControllerType: 'string'
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
offer: 'string'
publisher: 'string'
sharedGalleryImageId: 'string'
sku: 'string'
version: 'string'
}
osDisk: {
caching: 'string'
createOption: 'string'
deleteOption: 'string'
diffDiskSettings: {
option: 'string'
placement: 'string'
}
diskSizeGB: int
encryptionSettings: {
diskEncryptionKey: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
enabled: bool
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
image: {
uri: 'string'
}
managedDisk: {
diskEncryptionSet: {
id: 'string'
}
id: 'string'
securityProfile: {
diskEncryptionSet: {
id: 'string'
}
securityEncryptionType: 'string'
}
storageAccountType: 'string'
}
name: 'string'
osType: 'string'
vhd: {
uri: 'string'
}
writeAcceleratorEnabled: bool
}
}
userData: 'string'
vmExtensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
protectedSettings: {
{customized property}: any(...)
}
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: {
{customized property}: any(...)
}
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
]
}
}
rank: int
}
]
zoneAllocationPolicy: {
distributionStrategy: 'string'
zonePreferences: [
{
rank: int
zone: 'string'
}
]
}
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property Values
Microsoft.Compute/locations/bulkCreateCustom
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| name | The resource name | string Constraints: Min length = 1 Pattern = ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: locations |
| plan | Details of the resource plan. | Plan |
| properties | The resource-specific properties for this resource. | BulkCreateCustomProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| zones | Zones in which the BulkCreateCustom is available | string[] |
AdditionalCapabilities
| Name | Description | Value |
|---|---|---|
| hibernationEnabled | The flag that enables or disables hibernation capability on the VM. | bool |
| ultraSSDEnabled | The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. | bool |
AdditionalUnattendContent
| Name | Description | Value |
|---|---|---|
| componentName | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. | 'Microsoft-Windows-Shell-Setup' |
| content | Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. | string |
| passName | The pass name. Currently, the only allowable value is OobeSystem. | 'OobeSystem' |
| settingName | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. | 'AutoLogon' 'FirstLogonCommands' |
AllInstancesDown
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies if Scheduled Events should be auto-approved when all instances are down. Its default value is true. | bool |
ApiEntityReference
| Name | Description | Value |
|---|---|---|
| id | The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... | string |
ApplicationProfile
| Name | Description | Value |
|---|---|---|
| galleryApplications | Specifies the gallery applications that should be made available to the VM | VMGalleryApplication[] |
BootDiagnostics
| Name | Description | Value |
|---|---|---|
| enabled | Whether boot diagnostics should be enabled on the Virtual Machine. | bool |
| storageUri | Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. | string |
BulkactionVMExtension
| Name | Description | Value |
|---|---|---|
| name | The name of the virtual machine extension. | string (required) |
| properties | Properties of the virtual machine extension. | BulkActionVmExtensionProperties (required) |
BulkActionVmExtensionProperties
| Name | Description | Value |
|---|---|---|
| autoUpgradeMinorVersion | Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. | bool |
| enableAutomaticUpgrade | Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. | bool |
| forceUpdateTag | How the extension handler should be forced to update even if the extension configuration has not changed. | string |
| protectedSettings | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | BulkActionVmExtensionPropertiesProtectedSettings |
| protectedSettingsFromKeyVault | The extensions protected settings that are passed by reference, and consumed from key vault | KeyVaultSecretReference |
| provisionAfterExtensions | Collection of extension names after which this extension needs to be provisioned. | string[] |
| publisher | The name of the extension handler publisher. | string |
| settings | JSON formatted public settings for the extension. | BulkActionVmExtensionPropertiesSettings |
| suppressFailures | Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. | bool |
| type | Specifies the type of the extension; an example is 'CustomScriptExtension'. | string |
| typeHandlerVersion | Specifies the version of the script handler. | string |
BulkActionVmExtensionPropertiesProtectedSettings
| Name | Description | Value |
|---|
BulkActionVmExtensionPropertiesSettings
| Name | Description | Value |
|---|
BulkactionVMProperties
| Name | Description | Value |
|---|---|---|
| additionalCapabilities | Specifies additional capabilities enabled or disabled on the virtual machine. | AdditionalCapabilities |
| applicationProfile | Specifies the gallery applications that should be made available to the VM. | ApplicationProfile |
| capacityReservation | Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum compute api-version: 2021-04-01. | CapacityReservationProfile |
| diagnosticsProfile | Specifies the boot diagnostic settings state. Minimum compute api-version: 2015-06-15. | DiagnosticsProfile |
| extensionsTimeBudget | Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum compute api-version: 2020-06-01. | string |
| hardwareProfile | Specifies the hardware profile for the virtual machine. | HardwareProfile |
| licenseType | Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15 |
string |
| networkProfile | Specifies the network interfaces of the virtual machine. | NetworkProfile |
| osProfile | Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. | OSProfile |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. | ScheduledEventsPolicy |
| scheduledEventsProfile | Specifies Scheduled Event related configurations. | ScheduledEventsProfile |
| securityProfile | Specifies the Security related profile settings for the virtual machine. | SecurityProfile |
| storageProfile | Specifies the storage settings for the virtual machine disks. | StorageProfile |
| userData | UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum compute api-version: 2021-03-01. | string |
| vmExtensions | Virtual Machine Extensions Array to be applied to the Virtual Machines. | BulkactionVMExtension[] |
BulkCreateCustomOverride
| Name | Description | Value |
|---|---|---|
| extensions | Extensions. When non-empty they replace the operation-level extensions; when omitted the operation-level extensions are inherited. | BulkactionVMExtension[] |
| identity | Identity overriding the operation-level identity. | VirtualMachineIdentity |
| plan | Plan overriding the operation-level plan. | Plan |
| tags | Tags overriding the operation-level tags. | BulkCreateCustomOverrideTags |
| virtualMachineName | ARM VM name for this VM. Optional; when omitted the name is generated from the prefix as {prefix}_{index}. | string |
| virtualMachineProfile | VM profile, the same shape as operation-level ComputeProfile.virtualMachineProfile. Overrides the operation-level VM profile. | BulkactionVMProperties |
BulkCreateCustomOverrideBase
| Name | Description | Value |
|---|---|---|
| extensions | Extensions. When non-empty they replace the operation-level extensions; when omitted the operation-level extensions are inherited. | BulkactionVMExtension[] |
| identity | Identity overriding the operation-level identity. | VirtualMachineIdentity |
| plan | Plan overriding the operation-level plan. | Plan |
| tags | Tags overriding the operation-level tags. | BulkCreateCustomOverrideBaseTags |
| virtualMachineProfile | VM profile, the same shape as operation-level ComputeProfile.virtualMachineProfile. Overrides the operation-level VM profile. | BulkactionVMProperties |
BulkCreateCustomOverrideBaseTags
| Name | Description | Value |
|---|
BulkCreateCustomOverridesProfile
| Name | Description | Value |
|---|---|---|
| overrides | Per-VM overrides. The count is the VM count and must equal capacity. Each override maps to VM index i. | BulkCreateCustomOverride[] |
| virtualMachineNamePrefix | Prefix used to build the ARM VM name ({prefix}_{index}) for overrides that omit a virtualMachineName. Required when any override is unnamed and rejected when every override is named. | string |
BulkCreateCustomOverrideTags
| Name | Description | Value |
|---|
BulkCreateCustomPriorityProfile
| Name | Description | Value |
|---|---|---|
| allocationStrategy | The allocation strategy for VM size selection | 'LowestPrice' 'Prioritized' |
| evictionPolicy | Eviction Policy to follow when evicting Spot VMs. | 'Deallocate' 'Delete' |
| maxPricePerVM | Price per hour of each Spot VM will never exceed this. | int |
| type | The priority type for VM allocation | 'Regular' 'Spot' |
BulkCreateCustomProperties
| Name | Description | Value |
|---|---|---|
| capacity | Total capacity to achieve. It can be in terms of VMs or vCPUs. | int Constraints: Min value = 1 (required) |
| capacityType | Specifies capacity type for launching instances. It can be in terms of VMs or vCPUs. | 'VCpu' 'VM' |
| computeProfile | Compute Profile to configure the Virtual Machines. | ComputeProfile (required) |
| executionParameters | Extra parameters that control how the request is executed, including the retry policy. | ExecutionParameters |
| minCapacity | The minimum capacity, expressed in units specified by capacityType, that Azure must be able to allocate for the request to proceed. If Azure cannot allocate at least this capacity with high confidence, the request is rejected with 409 Conflict (InsufficientCapacity) and no VMs are created. Otherwise, Azure allocates as much capacity as possible, up to the requested capacity. Must be greater than 0, less than capacity, and requires partialFulfillmentPolicy.mode to be Enabled. | int Constraints: Min value = 1 |
| overridesProfile | Per-VM overrides and the shared name prefix, specified when the operation is created. | BulkCreateCustomOverridesProfile |
| partialFulfillmentPolicy | Controls how partial fulfillment is handled for a BulkCreateCustom request. When enabled, Azure creates only the VMs or vCPUs it has high confidence can be successfully allocated, instead of attempting the entire request and potentially returning allocation failures. | PartialFulfillmentPolicy |
| priorityProfile | Configuration Options for Regular or Spot instances in BulkCreateCustom. | BulkCreateCustomPriorityProfile (required) |
| vmSizesProfile | List of VM sizes supported for BulkCreateCustom | BulkCreateCustomVmSizeProfile[] |
| zoneAllocationPolicy | Zone Allocation Policy for launching instances. | BulkCreateCustomZoneAllocationPolicy |
BulkCreateCustomVmSizeProfile
| Name | Description | Value |
|---|---|---|
| name | The name of the VM size, eg Standard_D2ads_v5 | string Constraints: Min length = 1 (required) |
| override | Optional per-VM-size profile override applied to every VM the service assigns to this size. A size maps to many VMs, so virtualMachineName is not part of this shape. virtualMachineProfile is layered beneath any per-VM override; tags, identity, and plan are merged with the per-VM override, with the per-VM value winning. | BulkCreateCustomOverrideBase |
| rank | The rank of this VM size in the priority order | int (required) |
BulkCreateCustomZoneAllocationPolicy
| Name | Description | Value |
|---|---|---|
| distributionStrategy | The distribution strategy for zone allocation. Defaults to BestEffortBalanced. | 'BestEffortBalanced' 'BestEffortSingleZone' 'Prioritized' |
| zonePreferences | The zone preferences for allocation priority | ZonePreference[] |
CapacityRecommendationParameters
| Name | Description | Value |
|---|---|---|
| availabilityZones | Whether the capacity recommendation should be computed per availability zone | bool |
| desiredLocations | The list of desired Azure regions to be considered for the capacity recommendation | string[] |
| desiredSizes | The list of desired VM sizes (SKUs) to be considered for the capacity recommendation | string[] |
CapacityReservationProfile
| Name | Description | Value |
|---|---|---|
| capacityReservationGroup | Specifies the capacity reservation group resource id that should be used for allocating the virtual machine provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. | SubResource |
ComputeProfile
| Name | Description | Value |
|---|---|---|
| computeApiVersion | Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machines. The default value will be the latest supported computeApiVersion by LaunchBulkInstancesOperation. | string |
| extensions | Virtual Machine Extensions Array to be specified according to specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineExtension | BulkactionVMExtension[] |
| virtualMachineProfile | Base Virtual Machine Profile Properties to be specified according to specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineProperties | BulkactionVMProperties (required) |
DataDisk
| Name | Description | Value |
|---|---|---|
| caching | Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. | 'None' 'ReadOnly' 'ReadWrite' |
| createOption | Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage, Empty, Copy, Restore. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Restore' (required) |
| deleteOption | Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. | 'Delete' 'Detach' |
| detachOption | Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. | 'ForceDetach' |
| diskSizeGB | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. | int |
| image | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. | VirtualHardDisk |
| lun | Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. | int (required) |
| managedDisk | The managed disk parameters. | ManagedDiskParameters |
| name | The disk name. | string |
| sourceResource | The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. | ApiEntityReference |
| toBeDetached | Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset. | bool |
| vhd | The virtual hard disk. | VirtualHardDisk |
| writeAcceleratorEnabled | Specifies whether writeAccelerator should be enabled or disabled on the disk. | bool |
DiagnosticsProfile
| Name | Description | Value |
|---|---|---|
| bootDiagnostics | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. | BootDiagnostics |
DiffDiskSettings
| Name | Description | Value |
|---|---|---|
| option | Specifies the ephemeral disk settings for operating system disk. | 'Local' |
| placement | Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Minimum api-version for NvmeDisk: 2024-03-01. | 'CacheDisk' 'NvmeDisk' 'ResourceDisk' |
DiskEncryptionSetParameters
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
DiskEncryptionSettings
| Name | Description | Value |
|---|---|---|
| diskEncryptionKey | Specifies the location of the disk encryption key, which is a Key Vault Secret. | KeyVaultSecretReference |
| enabled | Specifies whether disk encryption should be enabled on the virtual machine. | bool |
| keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. | KeyVaultKeyReference |
EncryptionIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentityResourceId | Specifies ARM Resource ID of one of the user identities associated with the VM. | string |
EventGridAndResourceGraph
| Name | Description | Value |
|---|---|---|
| enable | Specifies if event grid and resource graph is enabled for Scheduled event related configurations. | bool |
| scheduledEventsApiVersion | Specifies the api-version to determine which Scheduled Events configuration schema version will be delivered. | string |
ExecutionParameters
| Name | Description | Value |
|---|---|---|
| capacityRecommendationParameters | Capacity recommendation parameters for the request. When provided on an executeStart request, the service computes placement recommendations only if the VM fails to start due to an allocation failure; the recommendations for the desired sizes and locations are then surfaced in the operation's capacityRecommendation response. | CapacityRecommendationParameters |
| optimizationPreference | Details that could optimize the user's request | 'Availability' 'Cost' 'CostAvailabilityBalanced' |
| retryPolicy | Retry policy the user can pass | RetryPolicy |
| verifyVmAgentHealth | When true on an executeStart request, run a post-Start VM agent health check and engage the fallback chain if the guest agent does not report Ready. Ignored for non-Start operations. | bool |
HardwareProfile
| Name | Description | Value |
|---|---|---|
| vmSize | Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. | string |
| vmSizeProperties | Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details. | VmSizeProperties |
HostEndpointSettings
| Name | Description | Value |
|---|---|---|
| inVMAccessControlProfileReferenceId | Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} | string |
| mode | Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. | 'Audit' 'Disabled' 'Enforce' |
ImageReference
| Name | Description | Value |
|---|---|---|
| communityGalleryImageId | Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. | string |
| id | The ID of the sub-resource. | string |
| offer | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | string |
| publisher | The image publisher. | string |
| sharedGalleryImageId | Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. | string |
| sku | The image SKU. | string |
| version | Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. | string |
KeyVaultKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | The URL referencing a key encryption key in Key Vault. | string (required) |
| sourceVault | The relative URL of the Key Vault containing the key. | SubResource (required) |
KeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretUrl | The URL referencing a secret in a Key Vault. | string (required) |
| sourceVault | The relative URL of the Key Vault containing the secret. | SubResource (required) |
LinuxConfiguration
| Name | Description | Value |
|---|---|---|
| disablePasswordAuthentication | Specifies whether password authentication should be disabled. | bool |
| enableVMAgentPlatformUpdates | Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. | bool |
| patchSettings | [Preview Feature] Specifies settings related to VM Guest Patching on Linux. | LinuxPatchSettings |
| provisionVMAgent | Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. | bool |
| ssh | Specifies the ssh key configuration for a Linux OS. | SshConfiguration |
LinuxPatchSettings
| Name | Description | Value |
|---|---|---|
| assessmentMode | Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
'AutomaticByPlatform' 'ImageDefault' |
| automaticByPlatformSettings | Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. | LinuxVMGuestPatchAutomaticByPlatformSettings |
| patchMode | Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true |
'AutomaticByPlatform' 'ImageDefault' |
LinuxVMGuestPatchAutomaticByPlatformSettings
| Name | Description | Value |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule | Enables customer to schedule patching without accidental upgrades | bool |
| rebootSetting | Specifies the reboot setting for all AutomaticByPlatform patch installation operations. | 'Always' 'IfRequired' 'Never' 'Unknown' |
LocationBasedBulkCreateCustomTags
| Name | Description | Value |
|---|
ManagedDiskParameters
| Name | Description | Value |
|---|---|---|
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed disk. | DiskEncryptionSetParameters |
| id | The ID of the sub-resource. | string |
| securityProfile | Specifies the security profile for the managed disk. | VMDiskSecurityProfile |
| storageAccountType | Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. | 'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS' 'UltraSSD_LRS' |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NetworkInterfaceReference
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
| properties | Describes a network interface reference properties. | NetworkInterfaceReferenceProperties |
NetworkInterfaceReferenceProperties
| Name | Description | Value |
|---|---|---|
| deleteOption | Specify what happens to the network interface when the VM is deleted | 'Delete' 'Detach' |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| networkApiVersion | specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations | '2020-11-01' '2022-11-01' |
| networkInterfaceConfigurations | Specifies the networking configurations that will be used to create the virtual machine networking resources. | VirtualMachineNetworkInterfaceConfiguration[] |
| networkInterfaces | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. | NetworkInterfaceReference[] |
OSDisk
| Name | Description | Value |
|---|---|---|
| caching | Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. | 'None' 'ReadOnly' 'ReadWrite' |
| createOption | Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Restore' (required) |
| deleteOption | Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk. | 'Delete' 'Detach' |
| diffDiskSettings | Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. | DiffDiskSettings |
| diskSizeGB | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. | int |
| encryptionSettings | Specifies the encryption settings for the OS Disk. Minimum compute api-version: 2015-06-15. | DiskEncryptionSettings |
| image | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. | VirtualHardDisk |
| managedDisk | The managed disk parameters. | ManagedDiskParameters |
| name | The disk name. | string |
| osType | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. | 'Linux' 'Windows' |
| vhd | The virtual hard disk. | VirtualHardDisk |
| writeAcceleratorEnabled | Specifies whether writeAccelerator should be enabled or disabled on the disk. | bool |
OSImageNotificationProfile
| Name | Description | Value |
|---|---|---|
| enable | Specifies whether the OS Image Scheduled event is enabled or disabled. | bool |
| notBeforeTimeout | Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) | string |
OSProfile
| Name | Description | Value |
|---|---|---|
| adminPassword | Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension |
string Constraints: Sensitive value. Pass in as a secure parameter. |
| adminUsername | Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters. |
string |
| allowExtensionOperations | Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. | bool |
| computerName | Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines. | string |
| customData | Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation. | string |
| linuxConfiguration | Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. | LinuxConfiguration |
| requireGuestProvisionSignal | Optional property which must either be set to True or omitted. | bool |
| secrets | Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. | VaultSecretGroup[] |
| windowsConfiguration | Specifies Windows operating system settings on the virtual machine. | WindowsConfiguration |
PartialFulfillmentPolicy
| Name | Description | Value |
|---|---|---|
| mode | Specifies whether partial fulfillment is allowed. When Enabled, Azure creates as many VMs as it has high confidence can be successfully allocated. When Disabled, Azure attempts to create all requested VMs, which may result into allocation failures. | 'Disabled' 'Enabled' |
PatchSettings
| Name | Description | Value |
|---|---|---|
| assessmentMode | Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
'AutomaticByPlatform' 'ImageDefault' |
| automaticByPlatformSettings | Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. | WindowsVMGuestPatchAutomaticByPlatformSettings |
| enableHotpatching | Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. | bool |
| patchMode | Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true |
'AutomaticByOS' 'AutomaticByPlatform' 'Manual' |
Plan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ProxyAgentSettings
| Name | Description | Value |
|---|---|---|
| addProxyAgentExtension | Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os. | bool |
| enabled | Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. | bool |
| imds | Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. | HostEndpointSettings |
| keyIncarnationId | Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. | int |
| mode | Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. | 'Audit' 'Enforce' |
| wireServer | Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. | HostEndpointSettings |
PublicIPAddressSku
| Name | Description | Value |
|---|---|---|
| name | Specify public IP sku name | 'Basic' 'Standard' |
| tier | Specify public IP sku tier | 'Global' 'Regional' |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| onFailureAction | Action to take on failure | 'Create' 'Deallocate' 'Delete' 'GetInstanceView' 'Hibernate' 'Start' 'Unknown' |
| retryCount | Retry count for user request | int |
| retryWindowInMinutes | Retry window in minutes for user request | int |
ScheduledEventsAdditionalPublishingTargets
| Name | Description | Value |
|---|---|---|
| eventGridAndResourceGraph | The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. | EventGridAndResourceGraph |
ScheduledEventsPolicy
| Name | Description | Value |
|---|---|---|
| allInstancesDown | The configuration parameters used while creating AllInstancesDown scheduled event setting creation. | AllInstancesDown |
| scheduledEventsAdditionalPublishingTargets | The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. | ScheduledEventsAdditionalPublishingTargets |
| userInitiatedReboot | The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. | UserInitiatedReboot |
| userInitiatedRedeploy | The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. | UserInitiatedRedeploy |
ScheduledEventsProfile
| Name | Description | Value |
|---|---|---|
| osImageNotificationProfile | Specifies OS Image Scheduled Event related configurations. | OSImageNotificationProfile |
| terminateNotificationProfile | Specifies Terminate Scheduled Event related configurations. | TerminateNotificationProfile |
SecurityProfile
| Name | Description | Value |
|---|---|---|
| encryptionAtHost | This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. | bool |
| encryptionIdentity | Specifies the Managed Identity used by ADE to get access token for keyvault operations. | EncryptionIdentity |
| proxyAgentSettings | Specifies ProxyAgent settings while creating the virtual machine. Minimum compute api-version: 2023-09-01. | ProxyAgentSettings |
| securityType | Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. | 'ConfidentialVM' 'TrustedLaunch' |
| uefiSettings | Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum compute api-version: 2020-12-01. | UefiSettings |
SshConfiguration
| Name | Description | Value |
|---|---|---|
| publicKeys | The list of SSH public keys used to authenticate with linux based VMs. | SshPublicKey[] |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]/azure/virtual-machines/linux/create-ssh-keys-detailed). | string |
| path | Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys | string |
StorageProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. | DataDisk[] |
| diskControllerType | Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. | 'NVMe' 'SCSI' |
| imageReference | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. | ImageReference |
| osDisk | Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. | OSDisk |
SubResource
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
TerminateNotificationProfile
| Name | Description | Value |
|---|---|---|
| enable | Specifies whether the Terminate Scheduled event is enabled or disabled. | bool |
| notBeforeTimeout | Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) | string |
UefiSettings
| Name | Description | Value |
|---|---|---|
| secureBootEnabled | Specifies whether secure boot should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. | bool |
| vTpmEnabled | Specifies whether vTPM should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. | bool |
UserAssignedIdentitiesValue
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserInitiatedReboot
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies Reboot Scheduled Event related configurations. | bool |
UserInitiatedRedeploy
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies Redeploy Scheduled Event related configurations. | bool |
VaultCertificate
| Name | Description | Value |
|---|---|---|
| certificateStore | For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. | string |
| certificateUrl | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { 'data':'<Base64-encoded-certificate>', 'dataType':'pfx', 'password':'<pfx-file-password>' } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
string |
VaultSecretGroup
| Name | Description | Value |
|---|---|---|
| sourceVault | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. | SubResource |
| vaultCertificates | The list of key vault references in SourceVault which contain certificates. | VaultCertificate[] |
VirtualHardDisk
| Name | Description | Value |
|---|---|---|
| uri | Specifies the virtual hard disk's uri. | string |
VirtualMachineIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | VirtualMachineIdentityUserAssignedIdentities |
VirtualMachineIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
VirtualMachineIpTag
| Name | Description | Value |
|---|---|---|
| ipTagType | IP tag type. Example: FirstPartyUsage. | string |
| tag | IP tag associated with the public IP. Example: SQL, Storage etc. | string |
VirtualMachineNetworkInterfaceConfiguration
| Name | Description | Value |
|---|---|---|
| name | The network interface configuration name. | string (required) |
| properties | Describes a virtual machine network profile's IP configuration. | VirtualMachineNetworkInterfaceConfigurationProperties |
| tags | Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration | VirtualMachineNetworkInterfaceConfigurationTags |
VirtualMachineNetworkInterfaceConfigurationProperties
| Name | Description | Value |
|---|---|---|
| auxiliaryMode | Specifies whether the Auxiliary mode is enabled for the Network Interface resource. | 'AcceleratedConnections' 'Floating' 'None' |
| auxiliarySku | Specifies whether the Auxiliary sku is enabled for the Network Interface resource. | 'A1' 'A2' 'A4' 'A8' 'None' |
| deleteOption | Specify what happens to the network interface when the VM is deleted | 'Delete' 'Detach' |
| disableTcpStateTracking | Specifies whether the network interface is disabled for tcp state tracking. | bool |
| dnsSettings | The dns settings to be applied on the network interfaces. | VirtualMachineNetworkInterfaceDnsSettingsConfiguration |
| dscpConfiguration | The DSCP configuration for the network interface. | SubResource |
| enableAcceleratedNetworking | Specifies whether the network interface is accelerated networking-enabled. | bool |
| enableFpga | Specifies whether the network interface is FPGA networking-enabled. | bool |
| enableIPForwarding | Whether IP forwarding enabled on this NIC. | bool |
| ipConfigurations | Specifies the IP configurations of the network interface. | VirtualMachineNetworkInterfaceIPConfiguration[] (required) |
| networkSecurityGroup | The network security group. | SubResource |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
VirtualMachineNetworkInterfaceConfigurationTags
| Name | Description | Value |
|---|
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
| Name | Description | Value |
|---|---|---|
| dnsServers | List of DNS servers IP addresses | string[] |
VirtualMachineNetworkInterfaceIPConfiguration
| Name | Description | Value |
|---|---|---|
| name | The IP configuration name. | string (required) |
| properties | Describes a virtual machine network interface IP configuration properties. | VirtualMachineNetworkInterfaceIPConfigurationProperties |
VirtualMachineNetworkInterfaceIPConfigurationProperties
| Name | Description | Value |
|---|---|---|
| applicationGatewayBackendAddressPools | Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. | SubResource[] |
| applicationSecurityGroups | Specifies an array of references to application security group. | SubResource[] |
| loadBalancerBackendAddressPools | Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. | SubResource[] |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
| privateIPAddressVersion | Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. | 'IPv4' 'IPv6' |
| publicIPAddressConfiguration | The publicIPAddressConfiguration. | VirtualMachinePublicIPAddressConfiguration |
| subnet | Specifies the identifier of the subnet. | SubResource |
VirtualMachinePublicIPAddressConfiguration
| Name | Description | Value |
|---|---|---|
| name | The publicIP address configuration name. | string (required) |
| properties | Describes a virtual machines IP Configuration's PublicIPAddress configuration | VirtualMachinePublicIPAddressConfigurationProperties |
| sku | Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. | PublicIPAddressSku |
| tags | Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration | VirtualMachinePublicIPAddressConfigurationTags |
VirtualMachinePublicIPAddressConfigurationProperties
| Name | Description | Value |
|---|---|---|
| deleteOption | Specify what happens to the public IP address when the VM is deleted | 'Delete' 'Detach' |
| dnsSettings | The dns settings to be applied on the publicIP addresses . | VirtualMachinePublicIPAddressDnsSettingsConfiguration |
| idleTimeoutInMinutes | The idle timeout of the public IP address. | int |
| ipTags | The list of IP tags associated with the public IP address. | VirtualMachineIpTag[] |
| publicIPAddressVersion | Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. | 'IPv4' 'IPv6' |
| publicIPAllocationMethod | Specify the public IP allocation type | 'Dynamic' 'Static' |
| publicIPPrefix | The PublicIPPrefix from which to allocate publicIP addresses. | SubResource |
VirtualMachinePublicIPAddressConfigurationTags
| Name | Description | Value |
|---|
VirtualMachinePublicIPAddressDnsSettingsConfiguration
| Name | Description | Value |
|---|---|---|
| domainNameLabel | The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. | string (required) |
| domainNameLabelScope | The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. | 'NoReuse' 'ResourceGroupReuse' 'SubscriptionReuse' 'TenantReuse' |
VMDiskSecurityProfile
| Name | Description | Value |
|---|---|---|
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. | DiskEncryptionSetParameters |
| securityEncryptionType | Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. | 'DiskWithVMGuestState' 'NonPersistedTPM' 'VMGuestStateOnly' |
VMGalleryApplication
| Name | Description | Value |
|---|---|---|
| configurationReference | Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided | string |
| enableAutomaticUpgrade | If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS | bool |
| order | Optional, Specifies the order in which the packages have to be installed | int |
| packageReferenceId | Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} | string (required) |
| tags | Optional, Specifies a passthrough value for more generic context. | string |
| treatFailureAsDeploymentFailure | Optional, If true, any failure for any operation in the VmApplication will fail the deployment | bool |
VmSizeProperties
| Name | Description | Value |
|---|---|---|
| vCpusAvailable | Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region. | int |
| vCpusPerCore | Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled. | int |
WindowsConfiguration
| Name | Description | Value |
|---|---|---|
| additionalUnattendContent | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. | AdditionalUnattendContent[] |
| enableAutomaticUpdates | Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. | bool |
| patchSettings | [Preview Feature] Specifies settings related to VM Guest Patching on Windows. | PatchSettings |
| provisionVMAgent | Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. | bool |
| timeZone | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. | string |
| winRM | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. | WinRMConfiguration |
WindowsVMGuestPatchAutomaticByPlatformSettings
| Name | Description | Value |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule | Enables customer to schedule patching without accidental upgrades | bool |
| rebootSetting | Specifies the reboot setting for all AutomaticByPlatform patch installation operations. | 'Always' 'IfRequired' 'Never' 'Unknown' |
WinRMConfiguration
| Name | Description | Value |
|---|---|---|
| listeners | The list of Windows Remote Management listeners | WinRMListener[] |
WinRMListener
| Name | Description | Value |
|---|---|---|
| certificateUrl | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
string |
| protocol | Specifies the protocol of WinRM listener. Possible values are: http, https. | 'Http' 'Https' |
ZonePreference
| Name | Description | Value |
|---|---|---|
| rank | The rank of this zone in the priority order | int (required) |
| zone | The zone identifier | string (required) |
ARM template resource definition
The locations/bulkCreateCustom resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.Compute/locations/bulkCreateCustom resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/locations/bulkCreateCustom",
"apiVersion": "2026-08-06-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"capacity": "int",
"capacityType": "string",
"computeProfile": {
"computeApiVersion": "string",
"extensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"protectedSettings": {
"{customized property}": {}
},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {
"{customized property}": {}
},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
],
"virtualMachineProfile": {
"additionalCapabilities": {
"hibernationEnabled": "bool",
"ultraSSDEnabled": "bool"
},
"applicationProfile": {
"galleryApplications": [
{
"configurationReference": "string",
"enableAutomaticUpgrade": "bool",
"order": "int",
"packageReferenceId": "string",
"tags": "string",
"treatFailureAsDeploymentFailure": "bool"
}
]
},
"capacityReservation": {
"capacityReservationGroup": {
"id": "string"
}
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": "bool",
"storageUri": "string"
}
},
"extensionsTimeBudget": "string",
"hardwareProfile": {
"vmSize": "string",
"vmSizeProperties": {
"vCpusAvailable": "int",
"vCpusPerCore": "int"
}
},
"licenseType": "string",
"networkProfile": {
"networkApiVersion": "string",
"networkInterfaceConfigurations": [
{
"name": "string",
"properties": {
"auxiliaryMode": "string",
"auxiliarySku": "string",
"deleteOption": "string",
"disableTcpStateTracking": "bool",
"dnsSettings": {
"dnsServers": [ "string" ]
},
"dscpConfiguration": {
"id": "string"
},
"enableAcceleratedNetworking": "bool",
"enableFpga": "bool",
"enableIPForwarding": "bool",
"ipConfigurations": [
{
"name": "string",
"properties": {
"applicationGatewayBackendAddressPools": [
{
"id": "string"
}
],
"applicationSecurityGroups": [
{
"id": "string"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "string"
}
],
"primary": "bool",
"privateIPAddressVersion": "string",
"publicIPAddressConfiguration": {
"name": "string",
"properties": {
"deleteOption": "string",
"dnsSettings": {
"domainNameLabel": "string",
"domainNameLabelScope": "string"
},
"idleTimeoutInMinutes": "int",
"ipTags": [
{
"ipTagType": "string",
"tag": "string"
}
],
"publicIPAddressVersion": "string",
"publicIPAllocationMethod": "string",
"publicIPPrefix": {
"id": "string"
}
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
},
"subnet": {
"id": "string"
}
}
}
],
"networkSecurityGroup": {
"id": "string"
},
"primary": "bool"
},
"tags": {
"{customized property}": "string"
}
}
],
"networkInterfaces": [
{
"id": "string",
"properties": {
"deleteOption": "string",
"primary": "bool"
}
}
]
},
"osProfile": {
"adminPassword": "string",
"adminUsername": "string",
"allowExtensionOperations": "bool",
"computerName": "string",
"customData": "string",
"linuxConfiguration": {
"disablePasswordAuthentication": "bool",
"enableVMAgentPlatformUpdates": "bool",
"patchSettings": {
"assessmentMode": "string",
"automaticByPlatformSettings": {
"bypassPlatformSafetyChecksOnUserSchedule": "bool",
"rebootSetting": "string"
},
"patchMode": "string"
},
"provisionVMAgent": "bool",
"ssh": {
"publicKeys": [
{
"keyData": "string",
"path": "string"
}
]
}
},
"requireGuestProvisionSignal": "bool",
"secrets": [
{
"sourceVault": {
"id": "string"
},
"vaultCertificates": [
{
"certificateStore": "string",
"certificateUrl": "string"
}
]
}
],
"windowsConfiguration": {
"additionalUnattendContent": [
{
"componentName": "Microsoft-Windows-Shell-Setup",
"content": "string",
"passName": "OobeSystem",
"settingName": "string"
}
],
"enableAutomaticUpdates": "bool",
"patchSettings": {
"assessmentMode": "string",
"automaticByPlatformSettings": {
"bypassPlatformSafetyChecksOnUserSchedule": "bool",
"rebootSetting": "string"
},
"enableHotpatching": "bool",
"patchMode": "string"
},
"provisionVMAgent": "bool",
"timeZone": "string",
"winRM": {
"listeners": [
{
"certificateUrl": "string",
"protocol": "string"
}
]
}
}
},
"scheduledEventsPolicy": {
"allInstancesDown": {
"automaticallyApprove": "bool"
},
"scheduledEventsAdditionalPublishingTargets": {
"eventGridAndResourceGraph": {
"enable": "bool",
"scheduledEventsApiVersion": "string"
}
},
"userInitiatedReboot": {
"automaticallyApprove": "bool"
},
"userInitiatedRedeploy": {
"automaticallyApprove": "bool"
}
},
"scheduledEventsProfile": {
"osImageNotificationProfile": {
"enable": "bool",
"notBeforeTimeout": "string"
},
"terminateNotificationProfile": {
"enable": "bool",
"notBeforeTimeout": "string"
}
},
"securityProfile": {
"encryptionAtHost": "bool",
"encryptionIdentity": {
"userAssignedIdentityResourceId": "string"
},
"proxyAgentSettings": {
"addProxyAgentExtension": "bool",
"enabled": "bool",
"imds": {
"inVMAccessControlProfileReferenceId": "string",
"mode": "string"
},
"keyIncarnationId": "int",
"mode": "string",
"wireServer": {
"inVMAccessControlProfileReferenceId": "string",
"mode": "string"
}
},
"securityType": "string",
"uefiSettings": {
"secureBootEnabled": "bool",
"vTpmEnabled": "bool"
}
},
"storageProfile": {
"dataDisks": [
{
"caching": "string",
"createOption": "string",
"deleteOption": "string",
"detachOption": "string",
"diskSizeGB": "int",
"image": {
"uri": "string"
},
"lun": "int",
"managedDisk": {
"diskEncryptionSet": {
"id": "string"
},
"id": "string",
"securityProfile": {
"diskEncryptionSet": {
"id": "string"
},
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"name": "string",
"sourceResource": {
"id": "string"
},
"toBeDetached": "bool",
"vhd": {
"uri": "string"
},
"writeAcceleratorEnabled": "bool"
}
],
"diskControllerType": "string",
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"offer": "string",
"publisher": "string",
"sharedGalleryImageId": "string",
"sku": "string",
"version": "string"
},
"osDisk": {
"caching": "string",
"createOption": "string",
"deleteOption": "string",
"diffDiskSettings": {
"option": "string",
"placement": "string"
},
"diskSizeGB": "int",
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"enabled": "bool",
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
},
"image": {
"uri": "string"
},
"managedDisk": {
"diskEncryptionSet": {
"id": "string"
},
"id": "string",
"securityProfile": {
"diskEncryptionSet": {
"id": "string"
},
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"name": "string",
"osType": "string",
"vhd": {
"uri": "string"
},
"writeAcceleratorEnabled": "bool"
}
},
"userData": "string",
"vmExtensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"protectedSettings": {
"{customized property}": {}
},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {
"{customized property}": {}
},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
]
}
},
"executionParameters": {
"capacityRecommendationParameters": {
"availabilityZones": "bool",
"desiredLocations": [ "string" ],
"desiredSizes": [ "string" ]
},
"optimizationPreference": "string",
"retryPolicy": {
"onFailureAction": "string",
"retryCount": "int",
"retryWindowInMinutes": "int"
},
"verifyVmAgentHealth": "bool"
},
"minCapacity": "int",
"overridesProfile": {
"overrides": [
{
"extensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"protectedSettings": {
"{customized property}": {}
},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {
"{customized property}": {}
},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
],
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"tags": {
"{customized property}": "string"
},
"virtualMachineName": "string",
"virtualMachineProfile": {
"additionalCapabilities": {
"hibernationEnabled": "bool",
"ultraSSDEnabled": "bool"
},
"applicationProfile": {
"galleryApplications": [
{
"configurationReference": "string",
"enableAutomaticUpgrade": "bool",
"order": "int",
"packageReferenceId": "string",
"tags": "string",
"treatFailureAsDeploymentFailure": "bool"
}
]
},
"capacityReservation": {
"capacityReservationGroup": {
"id": "string"
}
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": "bool",
"storageUri": "string"
}
},
"extensionsTimeBudget": "string",
"hardwareProfile": {
"vmSize": "string",
"vmSizeProperties": {
"vCpusAvailable": "int",
"vCpusPerCore": "int"
}
},
"licenseType": "string",
"networkProfile": {
"networkApiVersion": "string",
"networkInterfaceConfigurations": [
{
"name": "string",
"properties": {
"auxiliaryMode": "string",
"auxiliarySku": "string",
"deleteOption": "string",
"disableTcpStateTracking": "bool",
"dnsSettings": {
"dnsServers": [ "string" ]
},
"dscpConfiguration": {
"id": "string"
},
"enableAcceleratedNetworking": "bool",
"enableFpga": "bool",
"enableIPForwarding": "bool",
"ipConfigurations": [
{
"name": "string",
"properties": {
"applicationGatewayBackendAddressPools": [
{
"id": "string"
}
],
"applicationSecurityGroups": [
{
"id": "string"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "string"
}
],
"primary": "bool",
"privateIPAddressVersion": "string",
"publicIPAddressConfiguration": {
"name": "string",
"properties": {
"deleteOption": "string",
"dnsSettings": {
"domainNameLabel": "string",
"domainNameLabelScope": "string"
},
"idleTimeoutInMinutes": "int",
"ipTags": [
{
"ipTagType": "string",
"tag": "string"
}
],
"publicIPAddressVersion": "string",
"publicIPAllocationMethod": "string",
"publicIPPrefix": {
"id": "string"
}
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
},
"subnet": {
"id": "string"
}
}
}
],
"networkSecurityGroup": {
"id": "string"
},
"primary": "bool"
},
"tags": {
"{customized property}": "string"
}
}
],
"networkInterfaces": [
{
"id": "string",
"properties": {
"deleteOption": "string",
"primary": "bool"
}
}
]
},
"osProfile": {
"adminPassword": "string",
"adminUsername": "string",
"allowExtensionOperations": "bool",
"computerName": "string",
"customData": "string",
"linuxConfiguration": {
"disablePasswordAuthentication": "bool",
"enableVMAgentPlatformUpdates": "bool",
"patchSettings": {
"assessmentMode": "string",
"automaticByPlatformSettings": {
"bypassPlatformSafetyChecksOnUserSchedule": "bool",
"rebootSetting": "string"
},
"patchMode": "string"
},
"provisionVMAgent": "bool",
"ssh": {
"publicKeys": [
{
"keyData": "string",
"path": "string"
}
]
}
},
"requireGuestProvisionSignal": "bool",
"secrets": [
{
"sourceVault": {
"id": "string"
},
"vaultCertificates": [
{
"certificateStore": "string",
"certificateUrl": "string"
}
]
}
],
"windowsConfiguration": {
"additionalUnattendContent": [
{
"componentName": "Microsoft-Windows-Shell-Setup",
"content": "string",
"passName": "OobeSystem",
"settingName": "string"
}
],
"enableAutomaticUpdates": "bool",
"patchSettings": {
"assessmentMode": "string",
"automaticByPlatformSettings": {
"bypassPlatformSafetyChecksOnUserSchedule": "bool",
"rebootSetting": "string"
},
"enableHotpatching": "bool",
"patchMode": "string"
},
"provisionVMAgent": "bool",
"timeZone": "string",
"winRM": {
"listeners": [
{
"certificateUrl": "string",
"protocol": "string"
}
]
}
}
},
"scheduledEventsPolicy": {
"allInstancesDown": {
"automaticallyApprove": "bool"
},
"scheduledEventsAdditionalPublishingTargets": {
"eventGridAndResourceGraph": {
"enable": "bool",
"scheduledEventsApiVersion": "string"
}
},
"userInitiatedReboot": {
"automaticallyApprove": "bool"
},
"userInitiatedRedeploy": {
"automaticallyApprove": "bool"
}
},
"scheduledEventsProfile": {
"osImageNotificationProfile": {
"enable": "bool",
"notBeforeTimeout": "string"
},
"terminateNotificationProfile": {
"enable": "bool",
"notBeforeTimeout": "string"
}
},
"securityProfile": {
"encryptionAtHost": "bool",
"encryptionIdentity": {
"userAssignedIdentityResourceId": "string"
},
"proxyAgentSettings": {
"addProxyAgentExtension": "bool",
"enabled": "bool",
"imds": {
"inVMAccessControlProfileReferenceId": "string",
"mode": "string"
},
"keyIncarnationId": "int",
"mode": "string",
"wireServer": {
"inVMAccessControlProfileReferenceId": "string",
"mode": "string"
}
},
"securityType": "string",
"uefiSettings": {
"secureBootEnabled": "bool",
"vTpmEnabled": "bool"
}
},
"storageProfile": {
"dataDisks": [
{
"caching": "string",
"createOption": "string",
"deleteOption": "string",
"detachOption": "string",
"diskSizeGB": "int",
"image": {
"uri": "string"
},
"lun": "int",
"managedDisk": {
"diskEncryptionSet": {
"id": "string"
},
"id": "string",
"securityProfile": {
"diskEncryptionSet": {
"id": "string"
},
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"name": "string",
"sourceResource": {
"id": "string"
},
"toBeDetached": "bool",
"vhd": {
"uri": "string"
},
"writeAcceleratorEnabled": "bool"
}
],
"diskControllerType": "string",
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"offer": "string",
"publisher": "string",
"sharedGalleryImageId": "string",
"sku": "string",
"version": "string"
},
"osDisk": {
"caching": "string",
"createOption": "string",
"deleteOption": "string",
"diffDiskSettings": {
"option": "string",
"placement": "string"
},
"diskSizeGB": "int",
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"enabled": "bool",
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
},
"image": {
"uri": "string"
},
"managedDisk": {
"diskEncryptionSet": {
"id": "string"
},
"id": "string",
"securityProfile": {
"diskEncryptionSet": {
"id": "string"
},
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"name": "string",
"osType": "string",
"vhd": {
"uri": "string"
},
"writeAcceleratorEnabled": "bool"
}
},
"userData": "string",
"vmExtensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"protectedSettings": {
"{customized property}": {}
},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {
"{customized property}": {}
},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
]
}
}
],
"virtualMachineNamePrefix": "string"
},
"partialFulfillmentPolicy": {
"mode": "string"
},
"priorityProfile": {
"allocationStrategy": "string",
"evictionPolicy": "string",
"maxPricePerVM": "int",
"type": "string"
},
"vmSizesProfile": [
{
"name": "string",
"override": {
"extensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"protectedSettings": {
"{customized property}": {}
},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {
"{customized property}": {}
},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
],
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"tags": {
"{customized property}": "string"
},
"virtualMachineProfile": {
"additionalCapabilities": {
"hibernationEnabled": "bool",
"ultraSSDEnabled": "bool"
},
"applicationProfile": {
"galleryApplications": [
{
"configurationReference": "string",
"enableAutomaticUpgrade": "bool",
"order": "int",
"packageReferenceId": "string",
"tags": "string",
"treatFailureAsDeploymentFailure": "bool"
}
]
},
"capacityReservation": {
"capacityReservationGroup": {
"id": "string"
}
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": "bool",
"storageUri": "string"
}
},
"extensionsTimeBudget": "string",
"hardwareProfile": {
"vmSize": "string",
"vmSizeProperties": {
"vCpusAvailable": "int",
"vCpusPerCore": "int"
}
},
"licenseType": "string",
"networkProfile": {
"networkApiVersion": "string",
"networkInterfaceConfigurations": [
{
"name": "string",
"properties": {
"auxiliaryMode": "string",
"auxiliarySku": "string",
"deleteOption": "string",
"disableTcpStateTracking": "bool",
"dnsSettings": {
"dnsServers": [ "string" ]
},
"dscpConfiguration": {
"id": "string"
},
"enableAcceleratedNetworking": "bool",
"enableFpga": "bool",
"enableIPForwarding": "bool",
"ipConfigurations": [
{
"name": "string",
"properties": {
"applicationGatewayBackendAddressPools": [
{
"id": "string"
}
],
"applicationSecurityGroups": [
{
"id": "string"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "string"
}
],
"primary": "bool",
"privateIPAddressVersion": "string",
"publicIPAddressConfiguration": {
"name": "string",
"properties": {
"deleteOption": "string",
"dnsSettings": {
"domainNameLabel": "string",
"domainNameLabelScope": "string"
},
"idleTimeoutInMinutes": "int",
"ipTags": [
{
"ipTagType": "string",
"tag": "string"
}
],
"publicIPAddressVersion": "string",
"publicIPAllocationMethod": "string",
"publicIPPrefix": {
"id": "string"
}
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
},
"subnet": {
"id": "string"
}
}
}
],
"networkSecurityGroup": {
"id": "string"
},
"primary": "bool"
},
"tags": {
"{customized property}": "string"
}
}
],
"networkInterfaces": [
{
"id": "string",
"properties": {
"deleteOption": "string",
"primary": "bool"
}
}
]
},
"osProfile": {
"adminPassword": "string",
"adminUsername": "string",
"allowExtensionOperations": "bool",
"computerName": "string",
"customData": "string",
"linuxConfiguration": {
"disablePasswordAuthentication": "bool",
"enableVMAgentPlatformUpdates": "bool",
"patchSettings": {
"assessmentMode": "string",
"automaticByPlatformSettings": {
"bypassPlatformSafetyChecksOnUserSchedule": "bool",
"rebootSetting": "string"
},
"patchMode": "string"
},
"provisionVMAgent": "bool",
"ssh": {
"publicKeys": [
{
"keyData": "string",
"path": "string"
}
]
}
},
"requireGuestProvisionSignal": "bool",
"secrets": [
{
"sourceVault": {
"id": "string"
},
"vaultCertificates": [
{
"certificateStore": "string",
"certificateUrl": "string"
}
]
}
],
"windowsConfiguration": {
"additionalUnattendContent": [
{
"componentName": "Microsoft-Windows-Shell-Setup",
"content": "string",
"passName": "OobeSystem",
"settingName": "string"
}
],
"enableAutomaticUpdates": "bool",
"patchSettings": {
"assessmentMode": "string",
"automaticByPlatformSettings": {
"bypassPlatformSafetyChecksOnUserSchedule": "bool",
"rebootSetting": "string"
},
"enableHotpatching": "bool",
"patchMode": "string"
},
"provisionVMAgent": "bool",
"timeZone": "string",
"winRM": {
"listeners": [
{
"certificateUrl": "string",
"protocol": "string"
}
]
}
}
},
"scheduledEventsPolicy": {
"allInstancesDown": {
"automaticallyApprove": "bool"
},
"scheduledEventsAdditionalPublishingTargets": {
"eventGridAndResourceGraph": {
"enable": "bool",
"scheduledEventsApiVersion": "string"
}
},
"userInitiatedReboot": {
"automaticallyApprove": "bool"
},
"userInitiatedRedeploy": {
"automaticallyApprove": "bool"
}
},
"scheduledEventsProfile": {
"osImageNotificationProfile": {
"enable": "bool",
"notBeforeTimeout": "string"
},
"terminateNotificationProfile": {
"enable": "bool",
"notBeforeTimeout": "string"
}
},
"securityProfile": {
"encryptionAtHost": "bool",
"encryptionIdentity": {
"userAssignedIdentityResourceId": "string"
},
"proxyAgentSettings": {
"addProxyAgentExtension": "bool",
"enabled": "bool",
"imds": {
"inVMAccessControlProfileReferenceId": "string",
"mode": "string"
},
"keyIncarnationId": "int",
"mode": "string",
"wireServer": {
"inVMAccessControlProfileReferenceId": "string",
"mode": "string"
}
},
"securityType": "string",
"uefiSettings": {
"secureBootEnabled": "bool",
"vTpmEnabled": "bool"
}
},
"storageProfile": {
"dataDisks": [
{
"caching": "string",
"createOption": "string",
"deleteOption": "string",
"detachOption": "string",
"diskSizeGB": "int",
"image": {
"uri": "string"
},
"lun": "int",
"managedDisk": {
"diskEncryptionSet": {
"id": "string"
},
"id": "string",
"securityProfile": {
"diskEncryptionSet": {
"id": "string"
},
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"name": "string",
"sourceResource": {
"id": "string"
},
"toBeDetached": "bool",
"vhd": {
"uri": "string"
},
"writeAcceleratorEnabled": "bool"
}
],
"diskControllerType": "string",
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"offer": "string",
"publisher": "string",
"sharedGalleryImageId": "string",
"sku": "string",
"version": "string"
},
"osDisk": {
"caching": "string",
"createOption": "string",
"deleteOption": "string",
"diffDiskSettings": {
"option": "string",
"placement": "string"
},
"diskSizeGB": "int",
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"enabled": "bool",
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
},
"image": {
"uri": "string"
},
"managedDisk": {
"diskEncryptionSet": {
"id": "string"
},
"id": "string",
"securityProfile": {
"diskEncryptionSet": {
"id": "string"
},
"securityEncryptionType": "string"
},
"storageAccountType": "string"
},
"name": "string",
"osType": "string",
"vhd": {
"uri": "string"
},
"writeAcceleratorEnabled": "bool"
}
},
"userData": "string",
"vmExtensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"protectedSettings": {
"{customized property}": {}
},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {
"{customized property}": {}
},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
]
}
},
"rank": "int"
}
],
"zoneAllocationPolicy": {
"distributionStrategy": "string",
"zonePreferences": [
{
"rank": "int",
"zone": "string"
}
]
}
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property Values
Microsoft.Compute/locations/bulkCreateCustom
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-08-06-preview' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| name | The resource name | string Constraints: Min length = 1 Pattern = ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required) |
| plan | Details of the resource plan. | Plan |
| properties | The resource-specific properties for this resource. | BulkCreateCustomProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Compute/locations/bulkCreateCustom' |
| zones | Zones in which the BulkCreateCustom is available | string[] |
AdditionalCapabilities
| Name | Description | Value |
|---|---|---|
| hibernationEnabled | The flag that enables or disables hibernation capability on the VM. | bool |
| ultraSSDEnabled | The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. | bool |
AdditionalUnattendContent
| Name | Description | Value |
|---|---|---|
| componentName | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. | 'Microsoft-Windows-Shell-Setup' |
| content | Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. | string |
| passName | The pass name. Currently, the only allowable value is OobeSystem. | 'OobeSystem' |
| settingName | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. | 'AutoLogon' 'FirstLogonCommands' |
AllInstancesDown
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies if Scheduled Events should be auto-approved when all instances are down. Its default value is true. | bool |
ApiEntityReference
| Name | Description | Value |
|---|---|---|
| id | The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... | string |
ApplicationProfile
| Name | Description | Value |
|---|---|---|
| galleryApplications | Specifies the gallery applications that should be made available to the VM | VMGalleryApplication[] |
BootDiagnostics
| Name | Description | Value |
|---|---|---|
| enabled | Whether boot diagnostics should be enabled on the Virtual Machine. | bool |
| storageUri | Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. | string |
BulkactionVMExtension
| Name | Description | Value |
|---|---|---|
| name | The name of the virtual machine extension. | string (required) |
| properties | Properties of the virtual machine extension. | BulkActionVmExtensionProperties (required) |
BulkActionVmExtensionProperties
| Name | Description | Value |
|---|---|---|
| autoUpgradeMinorVersion | Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. | bool |
| enableAutomaticUpgrade | Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. | bool |
| forceUpdateTag | How the extension handler should be forced to update even if the extension configuration has not changed. | string |
| protectedSettings | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | BulkActionVmExtensionPropertiesProtectedSettings |
| protectedSettingsFromKeyVault | The extensions protected settings that are passed by reference, and consumed from key vault | KeyVaultSecretReference |
| provisionAfterExtensions | Collection of extension names after which this extension needs to be provisioned. | string[] |
| publisher | The name of the extension handler publisher. | string |
| settings | JSON formatted public settings for the extension. | BulkActionVmExtensionPropertiesSettings |
| suppressFailures | Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. | bool |
| type | Specifies the type of the extension; an example is 'CustomScriptExtension'. | string |
| typeHandlerVersion | Specifies the version of the script handler. | string |
BulkActionVmExtensionPropertiesProtectedSettings
| Name | Description | Value |
|---|
BulkActionVmExtensionPropertiesSettings
| Name | Description | Value |
|---|
BulkactionVMProperties
| Name | Description | Value |
|---|---|---|
| additionalCapabilities | Specifies additional capabilities enabled or disabled on the virtual machine. | AdditionalCapabilities |
| applicationProfile | Specifies the gallery applications that should be made available to the VM. | ApplicationProfile |
| capacityReservation | Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum compute api-version: 2021-04-01. | CapacityReservationProfile |
| diagnosticsProfile | Specifies the boot diagnostic settings state. Minimum compute api-version: 2015-06-15. | DiagnosticsProfile |
| extensionsTimeBudget | Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum compute api-version: 2020-06-01. | string |
| hardwareProfile | Specifies the hardware profile for the virtual machine. | HardwareProfile |
| licenseType | Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15 |
string |
| networkProfile | Specifies the network interfaces of the virtual machine. | NetworkProfile |
| osProfile | Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. | OSProfile |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. | ScheduledEventsPolicy |
| scheduledEventsProfile | Specifies Scheduled Event related configurations. | ScheduledEventsProfile |
| securityProfile | Specifies the Security related profile settings for the virtual machine. | SecurityProfile |
| storageProfile | Specifies the storage settings for the virtual machine disks. | StorageProfile |
| userData | UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum compute api-version: 2021-03-01. | string |
| vmExtensions | Virtual Machine Extensions Array to be applied to the Virtual Machines. | BulkactionVMExtension[] |
BulkCreateCustomOverride
| Name | Description | Value |
|---|---|---|
| extensions | Extensions. When non-empty they replace the operation-level extensions; when omitted the operation-level extensions are inherited. | BulkactionVMExtension[] |
| identity | Identity overriding the operation-level identity. | VirtualMachineIdentity |
| plan | Plan overriding the operation-level plan. | Plan |
| tags | Tags overriding the operation-level tags. | BulkCreateCustomOverrideTags |
| virtualMachineName | ARM VM name for this VM. Optional; when omitted the name is generated from the prefix as {prefix}_{index}. | string |
| virtualMachineProfile | VM profile, the same shape as operation-level ComputeProfile.virtualMachineProfile. Overrides the operation-level VM profile. | BulkactionVMProperties |
BulkCreateCustomOverrideBase
| Name | Description | Value |
|---|---|---|
| extensions | Extensions. When non-empty they replace the operation-level extensions; when omitted the operation-level extensions are inherited. | BulkactionVMExtension[] |
| identity | Identity overriding the operation-level identity. | VirtualMachineIdentity |
| plan | Plan overriding the operation-level plan. | Plan |
| tags | Tags overriding the operation-level tags. | BulkCreateCustomOverrideBaseTags |
| virtualMachineProfile | VM profile, the same shape as operation-level ComputeProfile.virtualMachineProfile. Overrides the operation-level VM profile. | BulkactionVMProperties |
BulkCreateCustomOverrideBaseTags
| Name | Description | Value |
|---|
BulkCreateCustomOverridesProfile
| Name | Description | Value |
|---|---|---|
| overrides | Per-VM overrides. The count is the VM count and must equal capacity. Each override maps to VM index i. | BulkCreateCustomOverride[] |
| virtualMachineNamePrefix | Prefix used to build the ARM VM name ({prefix}_{index}) for overrides that omit a virtualMachineName. Required when any override is unnamed and rejected when every override is named. | string |
BulkCreateCustomOverrideTags
| Name | Description | Value |
|---|
BulkCreateCustomPriorityProfile
| Name | Description | Value |
|---|---|---|
| allocationStrategy | The allocation strategy for VM size selection | 'LowestPrice' 'Prioritized' |
| evictionPolicy | Eviction Policy to follow when evicting Spot VMs. | 'Deallocate' 'Delete' |
| maxPricePerVM | Price per hour of each Spot VM will never exceed this. | int |
| type | The priority type for VM allocation | 'Regular' 'Spot' |
BulkCreateCustomProperties
| Name | Description | Value |
|---|---|---|
| capacity | Total capacity to achieve. It can be in terms of VMs or vCPUs. | int Constraints: Min value = 1 (required) |
| capacityType | Specifies capacity type for launching instances. It can be in terms of VMs or vCPUs. | 'VCpu' 'VM' |
| computeProfile | Compute Profile to configure the Virtual Machines. | ComputeProfile (required) |
| executionParameters | Extra parameters that control how the request is executed, including the retry policy. | ExecutionParameters |
| minCapacity | The minimum capacity, expressed in units specified by capacityType, that Azure must be able to allocate for the request to proceed. If Azure cannot allocate at least this capacity with high confidence, the request is rejected with 409 Conflict (InsufficientCapacity) and no VMs are created. Otherwise, Azure allocates as much capacity as possible, up to the requested capacity. Must be greater than 0, less than capacity, and requires partialFulfillmentPolicy.mode to be Enabled. | int Constraints: Min value = 1 |
| overridesProfile | Per-VM overrides and the shared name prefix, specified when the operation is created. | BulkCreateCustomOverridesProfile |
| partialFulfillmentPolicy | Controls how partial fulfillment is handled for a BulkCreateCustom request. When enabled, Azure creates only the VMs or vCPUs it has high confidence can be successfully allocated, instead of attempting the entire request and potentially returning allocation failures. | PartialFulfillmentPolicy |
| priorityProfile | Configuration Options for Regular or Spot instances in BulkCreateCustom. | BulkCreateCustomPriorityProfile (required) |
| vmSizesProfile | List of VM sizes supported for BulkCreateCustom | BulkCreateCustomVmSizeProfile[] |
| zoneAllocationPolicy | Zone Allocation Policy for launching instances. | BulkCreateCustomZoneAllocationPolicy |
BulkCreateCustomVmSizeProfile
| Name | Description | Value |
|---|---|---|
| name | The name of the VM size, eg Standard_D2ads_v5 | string Constraints: Min length = 1 (required) |
| override | Optional per-VM-size profile override applied to every VM the service assigns to this size. A size maps to many VMs, so virtualMachineName is not part of this shape. virtualMachineProfile is layered beneath any per-VM override; tags, identity, and plan are merged with the per-VM override, with the per-VM value winning. | BulkCreateCustomOverrideBase |
| rank | The rank of this VM size in the priority order | int (required) |
BulkCreateCustomZoneAllocationPolicy
| Name | Description | Value |
|---|---|---|
| distributionStrategy | The distribution strategy for zone allocation. Defaults to BestEffortBalanced. | 'BestEffortBalanced' 'BestEffortSingleZone' 'Prioritized' |
| zonePreferences | The zone preferences for allocation priority | ZonePreference[] |
CapacityRecommendationParameters
| Name | Description | Value |
|---|---|---|
| availabilityZones | Whether the capacity recommendation should be computed per availability zone | bool |
| desiredLocations | The list of desired Azure regions to be considered for the capacity recommendation | string[] |
| desiredSizes | The list of desired VM sizes (SKUs) to be considered for the capacity recommendation | string[] |
CapacityReservationProfile
| Name | Description | Value |
|---|---|---|
| capacityReservationGroup | Specifies the capacity reservation group resource id that should be used for allocating the virtual machine provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. | SubResource |
ComputeProfile
| Name | Description | Value |
|---|---|---|
| computeApiVersion | Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machines. The default value will be the latest supported computeApiVersion by LaunchBulkInstancesOperation. | string |
| extensions | Virtual Machine Extensions Array to be specified according to specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineExtension | BulkactionVMExtension[] |
| virtualMachineProfile | Base Virtual Machine Profile Properties to be specified according to specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineProperties | BulkactionVMProperties (required) |
DataDisk
| Name | Description | Value |
|---|---|---|
| caching | Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. | 'None' 'ReadOnly' 'ReadWrite' |
| createOption | Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage, Empty, Copy, Restore. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Restore' (required) |
| deleteOption | Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. | 'Delete' 'Detach' |
| detachOption | Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. | 'ForceDetach' |
| diskSizeGB | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. | int |
| image | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. | VirtualHardDisk |
| lun | Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. | int (required) |
| managedDisk | The managed disk parameters. | ManagedDiskParameters |
| name | The disk name. | string |
| sourceResource | The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. | ApiEntityReference |
| toBeDetached | Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset. | bool |
| vhd | The virtual hard disk. | VirtualHardDisk |
| writeAcceleratorEnabled | Specifies whether writeAccelerator should be enabled or disabled on the disk. | bool |
DiagnosticsProfile
| Name | Description | Value |
|---|---|---|
| bootDiagnostics | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. | BootDiagnostics |
DiffDiskSettings
| Name | Description | Value |
|---|---|---|
| option | Specifies the ephemeral disk settings for operating system disk. | 'Local' |
| placement | Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Minimum api-version for NvmeDisk: 2024-03-01. | 'CacheDisk' 'NvmeDisk' 'ResourceDisk' |
DiskEncryptionSetParameters
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
DiskEncryptionSettings
| Name | Description | Value |
|---|---|---|
| diskEncryptionKey | Specifies the location of the disk encryption key, which is a Key Vault Secret. | KeyVaultSecretReference |
| enabled | Specifies whether disk encryption should be enabled on the virtual machine. | bool |
| keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. | KeyVaultKeyReference |
EncryptionIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentityResourceId | Specifies ARM Resource ID of one of the user identities associated with the VM. | string |
EventGridAndResourceGraph
| Name | Description | Value |
|---|---|---|
| enable | Specifies if event grid and resource graph is enabled for Scheduled event related configurations. | bool |
| scheduledEventsApiVersion | Specifies the api-version to determine which Scheduled Events configuration schema version will be delivered. | string |
ExecutionParameters
| Name | Description | Value |
|---|---|---|
| capacityRecommendationParameters | Capacity recommendation parameters for the request. When provided on an executeStart request, the service computes placement recommendations only if the VM fails to start due to an allocation failure; the recommendations for the desired sizes and locations are then surfaced in the operation's capacityRecommendation response. | CapacityRecommendationParameters |
| optimizationPreference | Details that could optimize the user's request | 'Availability' 'Cost' 'CostAvailabilityBalanced' |
| retryPolicy | Retry policy the user can pass | RetryPolicy |
| verifyVmAgentHealth | When true on an executeStart request, run a post-Start VM agent health check and engage the fallback chain if the guest agent does not report Ready. Ignored for non-Start operations. | bool |
HardwareProfile
| Name | Description | Value |
|---|---|---|
| vmSize | Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. | string |
| vmSizeProperties | Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details. | VmSizeProperties |
HostEndpointSettings
| Name | Description | Value |
|---|---|---|
| inVMAccessControlProfileReferenceId | Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} | string |
| mode | Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. | 'Audit' 'Disabled' 'Enforce' |
ImageReference
| Name | Description | Value |
|---|---|---|
| communityGalleryImageId | Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. | string |
| id | The ID of the sub-resource. | string |
| offer | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | string |
| publisher | The image publisher. | string |
| sharedGalleryImageId | Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. | string |
| sku | The image SKU. | string |
| version | Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. | string |
KeyVaultKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | The URL referencing a key encryption key in Key Vault. | string (required) |
| sourceVault | The relative URL of the Key Vault containing the key. | SubResource (required) |
KeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretUrl | The URL referencing a secret in a Key Vault. | string (required) |
| sourceVault | The relative URL of the Key Vault containing the secret. | SubResource (required) |
LinuxConfiguration
| Name | Description | Value |
|---|---|---|
| disablePasswordAuthentication | Specifies whether password authentication should be disabled. | bool |
| enableVMAgentPlatformUpdates | Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. | bool |
| patchSettings | [Preview Feature] Specifies settings related to VM Guest Patching on Linux. | LinuxPatchSettings |
| provisionVMAgent | Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. | bool |
| ssh | Specifies the ssh key configuration for a Linux OS. | SshConfiguration |
LinuxPatchSettings
| Name | Description | Value |
|---|---|---|
| assessmentMode | Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
'AutomaticByPlatform' 'ImageDefault' |
| automaticByPlatformSettings | Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. | LinuxVMGuestPatchAutomaticByPlatformSettings |
| patchMode | Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true |
'AutomaticByPlatform' 'ImageDefault' |
LinuxVMGuestPatchAutomaticByPlatformSettings
| Name | Description | Value |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule | Enables customer to schedule patching without accidental upgrades | bool |
| rebootSetting | Specifies the reboot setting for all AutomaticByPlatform patch installation operations. | 'Always' 'IfRequired' 'Never' 'Unknown' |
LocationBasedBulkCreateCustomTags
| Name | Description | Value |
|---|
ManagedDiskParameters
| Name | Description | Value |
|---|---|---|
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed disk. | DiskEncryptionSetParameters |
| id | The ID of the sub-resource. | string |
| securityProfile | Specifies the security profile for the managed disk. | VMDiskSecurityProfile |
| storageAccountType | Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. | 'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS' 'UltraSSD_LRS' |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NetworkInterfaceReference
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
| properties | Describes a network interface reference properties. | NetworkInterfaceReferenceProperties |
NetworkInterfaceReferenceProperties
| Name | Description | Value |
|---|---|---|
| deleteOption | Specify what happens to the network interface when the VM is deleted | 'Delete' 'Detach' |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| networkApiVersion | specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations | '2020-11-01' '2022-11-01' |
| networkInterfaceConfigurations | Specifies the networking configurations that will be used to create the virtual machine networking resources. | VirtualMachineNetworkInterfaceConfiguration[] |
| networkInterfaces | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. | NetworkInterfaceReference[] |
OSDisk
| Name | Description | Value |
|---|---|---|
| caching | Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. | 'None' 'ReadOnly' 'ReadWrite' |
| createOption | Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Restore' (required) |
| deleteOption | Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk. | 'Delete' 'Detach' |
| diffDiskSettings | Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. | DiffDiskSettings |
| diskSizeGB | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. | int |
| encryptionSettings | Specifies the encryption settings for the OS Disk. Minimum compute api-version: 2015-06-15. | DiskEncryptionSettings |
| image | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. | VirtualHardDisk |
| managedDisk | The managed disk parameters. | ManagedDiskParameters |
| name | The disk name. | string |
| osType | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. | 'Linux' 'Windows' |
| vhd | The virtual hard disk. | VirtualHardDisk |
| writeAcceleratorEnabled | Specifies whether writeAccelerator should be enabled or disabled on the disk. | bool |
OSImageNotificationProfile
| Name | Description | Value |
|---|---|---|
| enable | Specifies whether the OS Image Scheduled event is enabled or disabled. | bool |
| notBeforeTimeout | Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) | string |
OSProfile
| Name | Description | Value |
|---|---|---|
| adminPassword | Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension |
string Constraints: Sensitive value. Pass in as a secure parameter. |
| adminUsername | Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters. |
string |
| allowExtensionOperations | Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. | bool |
| computerName | Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines. | string |
| customData | Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation. | string |
| linuxConfiguration | Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. | LinuxConfiguration |
| requireGuestProvisionSignal | Optional property which must either be set to True or omitted. | bool |
| secrets | Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. | VaultSecretGroup[] |
| windowsConfiguration | Specifies Windows operating system settings on the virtual machine. | WindowsConfiguration |
PartialFulfillmentPolicy
| Name | Description | Value |
|---|---|---|
| mode | Specifies whether partial fulfillment is allowed. When Enabled, Azure creates as many VMs as it has high confidence can be successfully allocated. When Disabled, Azure attempts to create all requested VMs, which may result into allocation failures. | 'Disabled' 'Enabled' |
PatchSettings
| Name | Description | Value |
|---|---|---|
| assessmentMode | Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
'AutomaticByPlatform' 'ImageDefault' |
| automaticByPlatformSettings | Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. | WindowsVMGuestPatchAutomaticByPlatformSettings |
| enableHotpatching | Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. | bool |
| patchMode | Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true |
'AutomaticByOS' 'AutomaticByPlatform' 'Manual' |
Plan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ProxyAgentSettings
| Name | Description | Value |
|---|---|---|
| addProxyAgentExtension | Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os. | bool |
| enabled | Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. | bool |
| imds | Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. | HostEndpointSettings |
| keyIncarnationId | Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. | int |
| mode | Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. | 'Audit' 'Enforce' |
| wireServer | Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. | HostEndpointSettings |
PublicIPAddressSku
| Name | Description | Value |
|---|---|---|
| name | Specify public IP sku name | 'Basic' 'Standard' |
| tier | Specify public IP sku tier | 'Global' 'Regional' |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| onFailureAction | Action to take on failure | 'Create' 'Deallocate' 'Delete' 'GetInstanceView' 'Hibernate' 'Start' 'Unknown' |
| retryCount | Retry count for user request | int |
| retryWindowInMinutes | Retry window in minutes for user request | int |
ScheduledEventsAdditionalPublishingTargets
| Name | Description | Value |
|---|---|---|
| eventGridAndResourceGraph | The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. | EventGridAndResourceGraph |
ScheduledEventsPolicy
| Name | Description | Value |
|---|---|---|
| allInstancesDown | The configuration parameters used while creating AllInstancesDown scheduled event setting creation. | AllInstancesDown |
| scheduledEventsAdditionalPublishingTargets | The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. | ScheduledEventsAdditionalPublishingTargets |
| userInitiatedReboot | The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. | UserInitiatedReboot |
| userInitiatedRedeploy | The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. | UserInitiatedRedeploy |
ScheduledEventsProfile
| Name | Description | Value |
|---|---|---|
| osImageNotificationProfile | Specifies OS Image Scheduled Event related configurations. | OSImageNotificationProfile |
| terminateNotificationProfile | Specifies Terminate Scheduled Event related configurations. | TerminateNotificationProfile |
SecurityProfile
| Name | Description | Value |
|---|---|---|
| encryptionAtHost | This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. | bool |
| encryptionIdentity | Specifies the Managed Identity used by ADE to get access token for keyvault operations. | EncryptionIdentity |
| proxyAgentSettings | Specifies ProxyAgent settings while creating the virtual machine. Minimum compute api-version: 2023-09-01. | ProxyAgentSettings |
| securityType | Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. | 'ConfidentialVM' 'TrustedLaunch' |
| uefiSettings | Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum compute api-version: 2020-12-01. | UefiSettings |
SshConfiguration
| Name | Description | Value |
|---|---|---|
| publicKeys | The list of SSH public keys used to authenticate with linux based VMs. | SshPublicKey[] |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]/azure/virtual-machines/linux/create-ssh-keys-detailed). | string |
| path | Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys | string |
StorageProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. | DataDisk[] |
| diskControllerType | Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. | 'NVMe' 'SCSI' |
| imageReference | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. | ImageReference |
| osDisk | Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. | OSDisk |
SubResource
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
TerminateNotificationProfile
| Name | Description | Value |
|---|---|---|
| enable | Specifies whether the Terminate Scheduled event is enabled or disabled. | bool |
| notBeforeTimeout | Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) | string |
UefiSettings
| Name | Description | Value |
|---|---|---|
| secureBootEnabled | Specifies whether secure boot should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. | bool |
| vTpmEnabled | Specifies whether vTPM should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. | bool |
UserAssignedIdentitiesValue
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserInitiatedReboot
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies Reboot Scheduled Event related configurations. | bool |
UserInitiatedRedeploy
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies Redeploy Scheduled Event related configurations. | bool |
VaultCertificate
| Name | Description | Value |
|---|---|---|
| certificateStore | For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. | string |
| certificateUrl | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { 'data':'<Base64-encoded-certificate>', 'dataType':'pfx', 'password':'<pfx-file-password>' } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
string |
VaultSecretGroup
| Name | Description | Value |
|---|---|---|
| sourceVault | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. | SubResource |
| vaultCertificates | The list of key vault references in SourceVault which contain certificates. | VaultCertificate[] |
VirtualHardDisk
| Name | Description | Value |
|---|---|---|
| uri | Specifies the virtual hard disk's uri. | string |
VirtualMachineIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | VirtualMachineIdentityUserAssignedIdentities |
VirtualMachineIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
VirtualMachineIpTag
| Name | Description | Value |
|---|---|---|
| ipTagType | IP tag type. Example: FirstPartyUsage. | string |
| tag | IP tag associated with the public IP. Example: SQL, Storage etc. | string |
VirtualMachineNetworkInterfaceConfiguration
| Name | Description | Value |
|---|---|---|
| name | The network interface configuration name. | string (required) |
| properties | Describes a virtual machine network profile's IP configuration. | VirtualMachineNetworkInterfaceConfigurationProperties |
| tags | Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration | VirtualMachineNetworkInterfaceConfigurationTags |
VirtualMachineNetworkInterfaceConfigurationProperties
| Name | Description | Value |
|---|---|---|
| auxiliaryMode | Specifies whether the Auxiliary mode is enabled for the Network Interface resource. | 'AcceleratedConnections' 'Floating' 'None' |
| auxiliarySku | Specifies whether the Auxiliary sku is enabled for the Network Interface resource. | 'A1' 'A2' 'A4' 'A8' 'None' |
| deleteOption | Specify what happens to the network interface when the VM is deleted | 'Delete' 'Detach' |
| disableTcpStateTracking | Specifies whether the network interface is disabled for tcp state tracking. | bool |
| dnsSettings | The dns settings to be applied on the network interfaces. | VirtualMachineNetworkInterfaceDnsSettingsConfiguration |
| dscpConfiguration | The DSCP configuration for the network interface. | SubResource |
| enableAcceleratedNetworking | Specifies whether the network interface is accelerated networking-enabled. | bool |
| enableFpga | Specifies whether the network interface is FPGA networking-enabled. | bool |
| enableIPForwarding | Whether IP forwarding enabled on this NIC. | bool |
| ipConfigurations | Specifies the IP configurations of the network interface. | VirtualMachineNetworkInterfaceIPConfiguration[] (required) |
| networkSecurityGroup | The network security group. | SubResource |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
VirtualMachineNetworkInterfaceConfigurationTags
| Name | Description | Value |
|---|
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
| Name | Description | Value |
|---|---|---|
| dnsServers | List of DNS servers IP addresses | string[] |
VirtualMachineNetworkInterfaceIPConfiguration
| Name | Description | Value |
|---|---|---|
| name | The IP configuration name. | string (required) |
| properties | Describes a virtual machine network interface IP configuration properties. | VirtualMachineNetworkInterfaceIPConfigurationProperties |
VirtualMachineNetworkInterfaceIPConfigurationProperties
| Name | Description | Value |
|---|---|---|
| applicationGatewayBackendAddressPools | Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. | SubResource[] |
| applicationSecurityGroups | Specifies an array of references to application security group. | SubResource[] |
| loadBalancerBackendAddressPools | Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. | SubResource[] |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
| privateIPAddressVersion | Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. | 'IPv4' 'IPv6' |
| publicIPAddressConfiguration | The publicIPAddressConfiguration. | VirtualMachinePublicIPAddressConfiguration |
| subnet | Specifies the identifier of the subnet. | SubResource |
VirtualMachinePublicIPAddressConfiguration
| Name | Description | Value |
|---|---|---|
| name | The publicIP address configuration name. | string (required) |
| properties | Describes a virtual machines IP Configuration's PublicIPAddress configuration | VirtualMachinePublicIPAddressConfigurationProperties |
| sku | Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. | PublicIPAddressSku |
| tags | Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration | VirtualMachinePublicIPAddressConfigurationTags |
VirtualMachinePublicIPAddressConfigurationProperties
| Name | Description | Value |
|---|---|---|
| deleteOption | Specify what happens to the public IP address when the VM is deleted | 'Delete' 'Detach' |
| dnsSettings | The dns settings to be applied on the publicIP addresses . | VirtualMachinePublicIPAddressDnsSettingsConfiguration |
| idleTimeoutInMinutes | The idle timeout of the public IP address. | int |
| ipTags | The list of IP tags associated with the public IP address. | VirtualMachineIpTag[] |
| publicIPAddressVersion | Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. | 'IPv4' 'IPv6' |
| publicIPAllocationMethod | Specify the public IP allocation type | 'Dynamic' 'Static' |
| publicIPPrefix | The PublicIPPrefix from which to allocate publicIP addresses. | SubResource |
VirtualMachinePublicIPAddressConfigurationTags
| Name | Description | Value |
|---|
VirtualMachinePublicIPAddressDnsSettingsConfiguration
| Name | Description | Value |
|---|---|---|
| domainNameLabel | The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. | string (required) |
| domainNameLabelScope | The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. | 'NoReuse' 'ResourceGroupReuse' 'SubscriptionReuse' 'TenantReuse' |
VMDiskSecurityProfile
| Name | Description | Value |
|---|---|---|
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. | DiskEncryptionSetParameters |
| securityEncryptionType | Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. | 'DiskWithVMGuestState' 'NonPersistedTPM' 'VMGuestStateOnly' |
VMGalleryApplication
| Name | Description | Value |
|---|---|---|
| configurationReference | Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided | string |
| enableAutomaticUpgrade | If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS | bool |
| order | Optional, Specifies the order in which the packages have to be installed | int |
| packageReferenceId | Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} | string (required) |
| tags | Optional, Specifies a passthrough value for more generic context. | string |
| treatFailureAsDeploymentFailure | Optional, If true, any failure for any operation in the VmApplication will fail the deployment | bool |
VmSizeProperties
| Name | Description | Value |
|---|---|---|
| vCpusAvailable | Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region. | int |
| vCpusPerCore | Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled. | int |
WindowsConfiguration
| Name | Description | Value |
|---|---|---|
| additionalUnattendContent | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. | AdditionalUnattendContent[] |
| enableAutomaticUpdates | Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. | bool |
| patchSettings | [Preview Feature] Specifies settings related to VM Guest Patching on Windows. | PatchSettings |
| provisionVMAgent | Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. | bool |
| timeZone | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. | string |
| winRM | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. | WinRMConfiguration |
WindowsVMGuestPatchAutomaticByPlatformSettings
| Name | Description | Value |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule | Enables customer to schedule patching without accidental upgrades | bool |
| rebootSetting | Specifies the reboot setting for all AutomaticByPlatform patch installation operations. | 'Always' 'IfRequired' 'Never' 'Unknown' |
WinRMConfiguration
| Name | Description | Value |
|---|---|---|
| listeners | The list of Windows Remote Management listeners | WinRMListener[] |
WinRMListener
| Name | Description | Value |
|---|---|---|
| certificateUrl | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
string |
| protocol | Specifies the protocol of WinRM listener. Possible values are: http, https. | 'Http' 'Https' |
ZonePreference
| Name | Description | Value |
|---|---|---|
| rank | The rank of this zone in the priority order | int (required) |
| zone | The zone identifier | string (required) |
Terraform (AzAPI provider) resource definition
The locations/bulkCreateCustom resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Compute/locations/bulkCreateCustom resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/locations/bulkCreateCustom@2026-08-06-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
tags = {
{customized property} = "string"
}
body = {
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
properties = {
capacity = int
capacityType = "string"
computeProfile = {
computeApiVersion = "string"
extensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
protectedSettings = {
{customized property} = ?
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = {
{customized property} = ?
}
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
}
]
virtualMachineProfile = {
additionalCapabilities = {
hibernationEnabled = bool
ultraSSDEnabled = bool
}
applicationProfile = {
galleryApplications = [
{
configurationReference = "string"
enableAutomaticUpgrade = bool
order = int
packageReferenceId = "string"
tags = "string"
treatFailureAsDeploymentFailure = bool
}
]
}
capacityReservation = {
capacityReservationGroup = {
id = "string"
}
}
diagnosticsProfile = {
bootDiagnostics = {
enabled = bool
storageUri = "string"
}
}
extensionsTimeBudget = "string"
hardwareProfile = {
vmSize = "string"
vmSizeProperties = {
vCpusAvailable = int
vCpusPerCore = int
}
}
licenseType = "string"
networkProfile = {
networkApiVersion = "string"
networkInterfaceConfigurations = [
{
name = "string"
properties = {
auxiliaryMode = "string"
auxiliarySku = "string"
deleteOption = "string"
disableTcpStateTracking = bool
dnsSettings = {
dnsServers = [
"string"
]
}
dscpConfiguration = {
id = "string"
}
enableAcceleratedNetworking = bool
enableFpga = bool
enableIPForwarding = bool
ipConfigurations = [
{
name = "string"
properties = {
applicationGatewayBackendAddressPools = [
{
id = "string"
}
]
applicationSecurityGroups = [
{
id = "string"
}
]
loadBalancerBackendAddressPools = [
{
id = "string"
}
]
primary = bool
privateIPAddressVersion = "string"
publicIPAddressConfiguration = {
name = "string"
properties = {
deleteOption = "string"
dnsSettings = {
domainNameLabel = "string"
domainNameLabelScope = "string"
}
idleTimeoutInMinutes = int
ipTags = [
{
ipTagType = "string"
tag = "string"
}
]
publicIPAddressVersion = "string"
publicIPAllocationMethod = "string"
publicIPPrefix = {
id = "string"
}
}
sku = {
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
}
subnet = {
id = "string"
}
}
}
]
networkSecurityGroup = {
id = "string"
}
primary = bool
}
tags = {
{customized property} = "string"
}
}
]
networkInterfaces = [
{
id = "string"
properties = {
deleteOption = "string"
primary = bool
}
}
]
}
osProfile = {
adminPassword = "string"
adminUsername = "string"
allowExtensionOperations = bool
computerName = "string"
customData = "string"
linuxConfiguration = {
disablePasswordAuthentication = bool
enableVMAgentPlatformUpdates = bool
patchSettings = {
assessmentMode = "string"
automaticByPlatformSettings = {
bypassPlatformSafetyChecksOnUserSchedule = bool
rebootSetting = "string"
}
patchMode = "string"
}
provisionVMAgent = bool
ssh = {
publicKeys = [
{
keyData = "string"
path = "string"
}
]
}
}
requireGuestProvisionSignal = bool
secrets = [
{
sourceVault = {
id = "string"
}
vaultCertificates = [
{
certificateStore = "string"
certificateUrl = "string"
}
]
}
]
windowsConfiguration = {
additionalUnattendContent = [
{
componentName = "Microsoft-Windows-Shell-Setup"
content = "string"
passName = "OobeSystem"
settingName = "string"
}
]
enableAutomaticUpdates = bool
patchSettings = {
assessmentMode = "string"
automaticByPlatformSettings = {
bypassPlatformSafetyChecksOnUserSchedule = bool
rebootSetting = "string"
}
enableHotpatching = bool
patchMode = "string"
}
provisionVMAgent = bool
timeZone = "string"
winRM = {
listeners = [
{
certificateUrl = "string"
protocol = "string"
}
]
}
}
}
scheduledEventsPolicy = {
allInstancesDown = {
automaticallyApprove = bool
}
scheduledEventsAdditionalPublishingTargets = {
eventGridAndResourceGraph = {
enable = bool
scheduledEventsApiVersion = "string"
}
}
userInitiatedReboot = {
automaticallyApprove = bool
}
userInitiatedRedeploy = {
automaticallyApprove = bool
}
}
scheduledEventsProfile = {
osImageNotificationProfile = {
enable = bool
notBeforeTimeout = "string"
}
terminateNotificationProfile = {
enable = bool
notBeforeTimeout = "string"
}
}
securityProfile = {
encryptionAtHost = bool
encryptionIdentity = {
userAssignedIdentityResourceId = "string"
}
proxyAgentSettings = {
addProxyAgentExtension = bool
enabled = bool
imds = {
inVMAccessControlProfileReferenceId = "string"
mode = "string"
}
keyIncarnationId = int
mode = "string"
wireServer = {
inVMAccessControlProfileReferenceId = "string"
mode = "string"
}
}
securityType = "string"
uefiSettings = {
secureBootEnabled = bool
vTpmEnabled = bool
}
}
storageProfile = {
dataDisks = [
{
caching = "string"
createOption = "string"
deleteOption = "string"
detachOption = "string"
diskSizeGB = int
image = {
uri = "string"
}
lun = int
managedDisk = {
diskEncryptionSet = {
id = "string"
}
id = "string"
securityProfile = {
diskEncryptionSet = {
id = "string"
}
securityEncryptionType = "string"
}
storageAccountType = "string"
}
name = "string"
sourceResource = {
id = "string"
}
toBeDetached = bool
vhd = {
uri = "string"
}
writeAcceleratorEnabled = bool
}
]
diskControllerType = "string"
imageReference = {
communityGalleryImageId = "string"
id = "string"
offer = "string"
publisher = "string"
sharedGalleryImageId = "string"
sku = "string"
version = "string"
}
osDisk = {
caching = "string"
createOption = "string"
deleteOption = "string"
diffDiskSettings = {
option = "string"
placement = "string"
}
diskSizeGB = int
encryptionSettings = {
diskEncryptionKey = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
enabled = bool
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
image = {
uri = "string"
}
managedDisk = {
diskEncryptionSet = {
id = "string"
}
id = "string"
securityProfile = {
diskEncryptionSet = {
id = "string"
}
securityEncryptionType = "string"
}
storageAccountType = "string"
}
name = "string"
osType = "string"
vhd = {
uri = "string"
}
writeAcceleratorEnabled = bool
}
}
userData = "string"
vmExtensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
protectedSettings = {
{customized property} = ?
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = {
{customized property} = ?
}
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
}
]
}
}
executionParameters = {
capacityRecommendationParameters = {
availabilityZones = bool
desiredLocations = [
"string"
]
desiredSizes = [
"string"
]
}
optimizationPreference = "string"
retryPolicy = {
onFailureAction = "string"
retryCount = int
retryWindowInMinutes = int
}
verifyVmAgentHealth = bool
}
minCapacity = int
overridesProfile = {
overrides = [
{
extensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
protectedSettings = {
{customized property} = ?
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = {
{customized property} = ?
}
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
}
]
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
tags = {
{customized property} = "string"
}
virtualMachineName = "string"
virtualMachineProfile = {
additionalCapabilities = {
hibernationEnabled = bool
ultraSSDEnabled = bool
}
applicationProfile = {
galleryApplications = [
{
configurationReference = "string"
enableAutomaticUpgrade = bool
order = int
packageReferenceId = "string"
tags = "string"
treatFailureAsDeploymentFailure = bool
}
]
}
capacityReservation = {
capacityReservationGroup = {
id = "string"
}
}
diagnosticsProfile = {
bootDiagnostics = {
enabled = bool
storageUri = "string"
}
}
extensionsTimeBudget = "string"
hardwareProfile = {
vmSize = "string"
vmSizeProperties = {
vCpusAvailable = int
vCpusPerCore = int
}
}
licenseType = "string"
networkProfile = {
networkApiVersion = "string"
networkInterfaceConfigurations = [
{
name = "string"
properties = {
auxiliaryMode = "string"
auxiliarySku = "string"
deleteOption = "string"
disableTcpStateTracking = bool
dnsSettings = {
dnsServers = [
"string"
]
}
dscpConfiguration = {
id = "string"
}
enableAcceleratedNetworking = bool
enableFpga = bool
enableIPForwarding = bool
ipConfigurations = [
{
name = "string"
properties = {
applicationGatewayBackendAddressPools = [
{
id = "string"
}
]
applicationSecurityGroups = [
{
id = "string"
}
]
loadBalancerBackendAddressPools = [
{
id = "string"
}
]
primary = bool
privateIPAddressVersion = "string"
publicIPAddressConfiguration = {
name = "string"
properties = {
deleteOption = "string"
dnsSettings = {
domainNameLabel = "string"
domainNameLabelScope = "string"
}
idleTimeoutInMinutes = int
ipTags = [
{
ipTagType = "string"
tag = "string"
}
]
publicIPAddressVersion = "string"
publicIPAllocationMethod = "string"
publicIPPrefix = {
id = "string"
}
}
sku = {
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
}
subnet = {
id = "string"
}
}
}
]
networkSecurityGroup = {
id = "string"
}
primary = bool
}
tags = {
{customized property} = "string"
}
}
]
networkInterfaces = [
{
id = "string"
properties = {
deleteOption = "string"
primary = bool
}
}
]
}
osProfile = {
adminPassword = "string"
adminUsername = "string"
allowExtensionOperations = bool
computerName = "string"
customData = "string"
linuxConfiguration = {
disablePasswordAuthentication = bool
enableVMAgentPlatformUpdates = bool
patchSettings = {
assessmentMode = "string"
automaticByPlatformSettings = {
bypassPlatformSafetyChecksOnUserSchedule = bool
rebootSetting = "string"
}
patchMode = "string"
}
provisionVMAgent = bool
ssh = {
publicKeys = [
{
keyData = "string"
path = "string"
}
]
}
}
requireGuestProvisionSignal = bool
secrets = [
{
sourceVault = {
id = "string"
}
vaultCertificates = [
{
certificateStore = "string"
certificateUrl = "string"
}
]
}
]
windowsConfiguration = {
additionalUnattendContent = [
{
componentName = "Microsoft-Windows-Shell-Setup"
content = "string"
passName = "OobeSystem"
settingName = "string"
}
]
enableAutomaticUpdates = bool
patchSettings = {
assessmentMode = "string"
automaticByPlatformSettings = {
bypassPlatformSafetyChecksOnUserSchedule = bool
rebootSetting = "string"
}
enableHotpatching = bool
patchMode = "string"
}
provisionVMAgent = bool
timeZone = "string"
winRM = {
listeners = [
{
certificateUrl = "string"
protocol = "string"
}
]
}
}
}
scheduledEventsPolicy = {
allInstancesDown = {
automaticallyApprove = bool
}
scheduledEventsAdditionalPublishingTargets = {
eventGridAndResourceGraph = {
enable = bool
scheduledEventsApiVersion = "string"
}
}
userInitiatedReboot = {
automaticallyApprove = bool
}
userInitiatedRedeploy = {
automaticallyApprove = bool
}
}
scheduledEventsProfile = {
osImageNotificationProfile = {
enable = bool
notBeforeTimeout = "string"
}
terminateNotificationProfile = {
enable = bool
notBeforeTimeout = "string"
}
}
securityProfile = {
encryptionAtHost = bool
encryptionIdentity = {
userAssignedIdentityResourceId = "string"
}
proxyAgentSettings = {
addProxyAgentExtension = bool
enabled = bool
imds = {
inVMAccessControlProfileReferenceId = "string"
mode = "string"
}
keyIncarnationId = int
mode = "string"
wireServer = {
inVMAccessControlProfileReferenceId = "string"
mode = "string"
}
}
securityType = "string"
uefiSettings = {
secureBootEnabled = bool
vTpmEnabled = bool
}
}
storageProfile = {
dataDisks = [
{
caching = "string"
createOption = "string"
deleteOption = "string"
detachOption = "string"
diskSizeGB = int
image = {
uri = "string"
}
lun = int
managedDisk = {
diskEncryptionSet = {
id = "string"
}
id = "string"
securityProfile = {
diskEncryptionSet = {
id = "string"
}
securityEncryptionType = "string"
}
storageAccountType = "string"
}
name = "string"
sourceResource = {
id = "string"
}
toBeDetached = bool
vhd = {
uri = "string"
}
writeAcceleratorEnabled = bool
}
]
diskControllerType = "string"
imageReference = {
communityGalleryImageId = "string"
id = "string"
offer = "string"
publisher = "string"
sharedGalleryImageId = "string"
sku = "string"
version = "string"
}
osDisk = {
caching = "string"
createOption = "string"
deleteOption = "string"
diffDiskSettings = {
option = "string"
placement = "string"
}
diskSizeGB = int
encryptionSettings = {
diskEncryptionKey = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
enabled = bool
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
image = {
uri = "string"
}
managedDisk = {
diskEncryptionSet = {
id = "string"
}
id = "string"
securityProfile = {
diskEncryptionSet = {
id = "string"
}
securityEncryptionType = "string"
}
storageAccountType = "string"
}
name = "string"
osType = "string"
vhd = {
uri = "string"
}
writeAcceleratorEnabled = bool
}
}
userData = "string"
vmExtensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
protectedSettings = {
{customized property} = ?
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = {
{customized property} = ?
}
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
}
]
}
}
]
virtualMachineNamePrefix = "string"
}
partialFulfillmentPolicy = {
mode = "string"
}
priorityProfile = {
allocationStrategy = "string"
evictionPolicy = "string"
maxPricePerVM = int
type = "string"
}
vmSizesProfile = [
{
name = "string"
override = {
extensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
protectedSettings = {
{customized property} = ?
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = {
{customized property} = ?
}
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
}
]
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
tags = {
{customized property} = "string"
}
virtualMachineProfile = {
additionalCapabilities = {
hibernationEnabled = bool
ultraSSDEnabled = bool
}
applicationProfile = {
galleryApplications = [
{
configurationReference = "string"
enableAutomaticUpgrade = bool
order = int
packageReferenceId = "string"
tags = "string"
treatFailureAsDeploymentFailure = bool
}
]
}
capacityReservation = {
capacityReservationGroup = {
id = "string"
}
}
diagnosticsProfile = {
bootDiagnostics = {
enabled = bool
storageUri = "string"
}
}
extensionsTimeBudget = "string"
hardwareProfile = {
vmSize = "string"
vmSizeProperties = {
vCpusAvailable = int
vCpusPerCore = int
}
}
licenseType = "string"
networkProfile = {
networkApiVersion = "string"
networkInterfaceConfigurations = [
{
name = "string"
properties = {
auxiliaryMode = "string"
auxiliarySku = "string"
deleteOption = "string"
disableTcpStateTracking = bool
dnsSettings = {
dnsServers = [
"string"
]
}
dscpConfiguration = {
id = "string"
}
enableAcceleratedNetworking = bool
enableFpga = bool
enableIPForwarding = bool
ipConfigurations = [
{
name = "string"
properties = {
applicationGatewayBackendAddressPools = [
{
id = "string"
}
]
applicationSecurityGroups = [
{
id = "string"
}
]
loadBalancerBackendAddressPools = [
{
id = "string"
}
]
primary = bool
privateIPAddressVersion = "string"
publicIPAddressConfiguration = {
name = "string"
properties = {
deleteOption = "string"
dnsSettings = {
domainNameLabel = "string"
domainNameLabelScope = "string"
}
idleTimeoutInMinutes = int
ipTags = [
{
ipTagType = "string"
tag = "string"
}
]
publicIPAddressVersion = "string"
publicIPAllocationMethod = "string"
publicIPPrefix = {
id = "string"
}
}
sku = {
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
}
subnet = {
id = "string"
}
}
}
]
networkSecurityGroup = {
id = "string"
}
primary = bool
}
tags = {
{customized property} = "string"
}
}
]
networkInterfaces = [
{
id = "string"
properties = {
deleteOption = "string"
primary = bool
}
}
]
}
osProfile = {
adminPassword = "string"
adminUsername = "string"
allowExtensionOperations = bool
computerName = "string"
customData = "string"
linuxConfiguration = {
disablePasswordAuthentication = bool
enableVMAgentPlatformUpdates = bool
patchSettings = {
assessmentMode = "string"
automaticByPlatformSettings = {
bypassPlatformSafetyChecksOnUserSchedule = bool
rebootSetting = "string"
}
patchMode = "string"
}
provisionVMAgent = bool
ssh = {
publicKeys = [
{
keyData = "string"
path = "string"
}
]
}
}
requireGuestProvisionSignal = bool
secrets = [
{
sourceVault = {
id = "string"
}
vaultCertificates = [
{
certificateStore = "string"
certificateUrl = "string"
}
]
}
]
windowsConfiguration = {
additionalUnattendContent = [
{
componentName = "Microsoft-Windows-Shell-Setup"
content = "string"
passName = "OobeSystem"
settingName = "string"
}
]
enableAutomaticUpdates = bool
patchSettings = {
assessmentMode = "string"
automaticByPlatformSettings = {
bypassPlatformSafetyChecksOnUserSchedule = bool
rebootSetting = "string"
}
enableHotpatching = bool
patchMode = "string"
}
provisionVMAgent = bool
timeZone = "string"
winRM = {
listeners = [
{
certificateUrl = "string"
protocol = "string"
}
]
}
}
}
scheduledEventsPolicy = {
allInstancesDown = {
automaticallyApprove = bool
}
scheduledEventsAdditionalPublishingTargets = {
eventGridAndResourceGraph = {
enable = bool
scheduledEventsApiVersion = "string"
}
}
userInitiatedReboot = {
automaticallyApprove = bool
}
userInitiatedRedeploy = {
automaticallyApprove = bool
}
}
scheduledEventsProfile = {
osImageNotificationProfile = {
enable = bool
notBeforeTimeout = "string"
}
terminateNotificationProfile = {
enable = bool
notBeforeTimeout = "string"
}
}
securityProfile = {
encryptionAtHost = bool
encryptionIdentity = {
userAssignedIdentityResourceId = "string"
}
proxyAgentSettings = {
addProxyAgentExtension = bool
enabled = bool
imds = {
inVMAccessControlProfileReferenceId = "string"
mode = "string"
}
keyIncarnationId = int
mode = "string"
wireServer = {
inVMAccessControlProfileReferenceId = "string"
mode = "string"
}
}
securityType = "string"
uefiSettings = {
secureBootEnabled = bool
vTpmEnabled = bool
}
}
storageProfile = {
dataDisks = [
{
caching = "string"
createOption = "string"
deleteOption = "string"
detachOption = "string"
diskSizeGB = int
image = {
uri = "string"
}
lun = int
managedDisk = {
diskEncryptionSet = {
id = "string"
}
id = "string"
securityProfile = {
diskEncryptionSet = {
id = "string"
}
securityEncryptionType = "string"
}
storageAccountType = "string"
}
name = "string"
sourceResource = {
id = "string"
}
toBeDetached = bool
vhd = {
uri = "string"
}
writeAcceleratorEnabled = bool
}
]
diskControllerType = "string"
imageReference = {
communityGalleryImageId = "string"
id = "string"
offer = "string"
publisher = "string"
sharedGalleryImageId = "string"
sku = "string"
version = "string"
}
osDisk = {
caching = "string"
createOption = "string"
deleteOption = "string"
diffDiskSettings = {
option = "string"
placement = "string"
}
diskSizeGB = int
encryptionSettings = {
diskEncryptionKey = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
enabled = bool
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
image = {
uri = "string"
}
managedDisk = {
diskEncryptionSet = {
id = "string"
}
id = "string"
securityProfile = {
diskEncryptionSet = {
id = "string"
}
securityEncryptionType = "string"
}
storageAccountType = "string"
}
name = "string"
osType = "string"
vhd = {
uri = "string"
}
writeAcceleratorEnabled = bool
}
}
userData = "string"
vmExtensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
protectedSettings = {
{customized property} = ?
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
settings = {
{customized property} = ?
}
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
}
]
}
}
rank = int
}
]
zoneAllocationPolicy = {
distributionStrategy = "string"
zonePreferences = [
{
rank = int
zone = "string"
}
]
}
}
zones = [
"string"
]
}
}
Property Values
Microsoft.Compute/locations/bulkCreateCustom
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| name | The resource name | string Constraints: Min length = 1 Pattern = ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: locations |
| plan | Details of the resource plan. | Plan |
| properties | The resource-specific properties for this resource. | BulkCreateCustomProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Compute/locations/bulkCreateCustom@2026-08-06-preview" |
| zones | Zones in which the BulkCreateCustom is available | string[] |
AdditionalCapabilities
| Name | Description | Value |
|---|---|---|
| hibernationEnabled | The flag that enables or disables hibernation capability on the VM. | bool |
| ultraSSDEnabled | The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. | bool |
AdditionalUnattendContent
| Name | Description | Value |
|---|---|---|
| componentName | The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. | 'Microsoft-Windows-Shell-Setup' |
| content | Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. | string |
| passName | The pass name. Currently, the only allowable value is OobeSystem. | 'OobeSystem' |
| settingName | Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. | 'AutoLogon' 'FirstLogonCommands' |
AllInstancesDown
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies if Scheduled Events should be auto-approved when all instances are down. Its default value is true. | bool |
ApiEntityReference
| Name | Description | Value |
|---|---|---|
| id | The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... | string |
ApplicationProfile
| Name | Description | Value |
|---|---|---|
| galleryApplications | Specifies the gallery applications that should be made available to the VM | VMGalleryApplication[] |
BootDiagnostics
| Name | Description | Value |
|---|---|---|
| enabled | Whether boot diagnostics should be enabled on the Virtual Machine. | bool |
| storageUri | Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. | string |
BulkactionVMExtension
| Name | Description | Value |
|---|---|---|
| name | The name of the virtual machine extension. | string (required) |
| properties | Properties of the virtual machine extension. | BulkActionVmExtensionProperties (required) |
BulkActionVmExtensionProperties
| Name | Description | Value |
|---|---|---|
| autoUpgradeMinorVersion | Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. | bool |
| enableAutomaticUpgrade | Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. | bool |
| forceUpdateTag | How the extension handler should be forced to update even if the extension configuration has not changed. | string |
| protectedSettings | The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. | BulkActionVmExtensionPropertiesProtectedSettings |
| protectedSettingsFromKeyVault | The extensions protected settings that are passed by reference, and consumed from key vault | KeyVaultSecretReference |
| provisionAfterExtensions | Collection of extension names after which this extension needs to be provisioned. | string[] |
| publisher | The name of the extension handler publisher. | string |
| settings | JSON formatted public settings for the extension. | BulkActionVmExtensionPropertiesSettings |
| suppressFailures | Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. | bool |
| type | Specifies the type of the extension; an example is 'CustomScriptExtension'. | string |
| typeHandlerVersion | Specifies the version of the script handler. | string |
BulkActionVmExtensionPropertiesProtectedSettings
| Name | Description | Value |
|---|
BulkActionVmExtensionPropertiesSettings
| Name | Description | Value |
|---|
BulkactionVMProperties
| Name | Description | Value |
|---|---|---|
| additionalCapabilities | Specifies additional capabilities enabled or disabled on the virtual machine. | AdditionalCapabilities |
| applicationProfile | Specifies the gallery applications that should be made available to the VM. | ApplicationProfile |
| capacityReservation | Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum compute api-version: 2021-04-01. | CapacityReservationProfile |
| diagnosticsProfile | Specifies the boot diagnostic settings state. Minimum compute api-version: 2015-06-15. | DiagnosticsProfile |
| extensionsTimeBudget | Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum compute api-version: 2020-06-01. | string |
| hardwareProfile | Specifies the hardware profile for the virtual machine. | HardwareProfile |
| licenseType | Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15 |
string |
| networkProfile | Specifies the network interfaces of the virtual machine. | NetworkProfile |
| osProfile | Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. | OSProfile |
| scheduledEventsPolicy | Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. | ScheduledEventsPolicy |
| scheduledEventsProfile | Specifies Scheduled Event related configurations. | ScheduledEventsProfile |
| securityProfile | Specifies the Security related profile settings for the virtual machine. | SecurityProfile |
| storageProfile | Specifies the storage settings for the virtual machine disks. | StorageProfile |
| userData | UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum compute api-version: 2021-03-01. | string |
| vmExtensions | Virtual Machine Extensions Array to be applied to the Virtual Machines. | BulkactionVMExtension[] |
BulkCreateCustomOverride
| Name | Description | Value |
|---|---|---|
| extensions | Extensions. When non-empty they replace the operation-level extensions; when omitted the operation-level extensions are inherited. | BulkactionVMExtension[] |
| identity | Identity overriding the operation-level identity. | VirtualMachineIdentity |
| plan | Plan overriding the operation-level plan. | Plan |
| tags | Tags overriding the operation-level tags. | BulkCreateCustomOverrideTags |
| virtualMachineName | ARM VM name for this VM. Optional; when omitted the name is generated from the prefix as {prefix}_{index}. | string |
| virtualMachineProfile | VM profile, the same shape as operation-level ComputeProfile.virtualMachineProfile. Overrides the operation-level VM profile. | BulkactionVMProperties |
BulkCreateCustomOverrideBase
| Name | Description | Value |
|---|---|---|
| extensions | Extensions. When non-empty they replace the operation-level extensions; when omitted the operation-level extensions are inherited. | BulkactionVMExtension[] |
| identity | Identity overriding the operation-level identity. | VirtualMachineIdentity |
| plan | Plan overriding the operation-level plan. | Plan |
| tags | Tags overriding the operation-level tags. | BulkCreateCustomOverrideBaseTags |
| virtualMachineProfile | VM profile, the same shape as operation-level ComputeProfile.virtualMachineProfile. Overrides the operation-level VM profile. | BulkactionVMProperties |
BulkCreateCustomOverrideBaseTags
| Name | Description | Value |
|---|
BulkCreateCustomOverridesProfile
| Name | Description | Value |
|---|---|---|
| overrides | Per-VM overrides. The count is the VM count and must equal capacity. Each override maps to VM index i. | BulkCreateCustomOverride[] |
| virtualMachineNamePrefix | Prefix used to build the ARM VM name ({prefix}_{index}) for overrides that omit a virtualMachineName. Required when any override is unnamed and rejected when every override is named. | string |
BulkCreateCustomOverrideTags
| Name | Description | Value |
|---|
BulkCreateCustomPriorityProfile
| Name | Description | Value |
|---|---|---|
| allocationStrategy | The allocation strategy for VM size selection | 'LowestPrice' 'Prioritized' |
| evictionPolicy | Eviction Policy to follow when evicting Spot VMs. | 'Deallocate' 'Delete' |
| maxPricePerVM | Price per hour of each Spot VM will never exceed this. | int |
| type | The priority type for VM allocation | 'Regular' 'Spot' |
BulkCreateCustomProperties
| Name | Description | Value |
|---|---|---|
| capacity | Total capacity to achieve. It can be in terms of VMs or vCPUs. | int Constraints: Min value = 1 (required) |
| capacityType | Specifies capacity type for launching instances. It can be in terms of VMs or vCPUs. | 'VCpu' 'VM' |
| computeProfile | Compute Profile to configure the Virtual Machines. | ComputeProfile (required) |
| executionParameters | Extra parameters that control how the request is executed, including the retry policy. | ExecutionParameters |
| minCapacity | The minimum capacity, expressed in units specified by capacityType, that Azure must be able to allocate for the request to proceed. If Azure cannot allocate at least this capacity with high confidence, the request is rejected with 409 Conflict (InsufficientCapacity) and no VMs are created. Otherwise, Azure allocates as much capacity as possible, up to the requested capacity. Must be greater than 0, less than capacity, and requires partialFulfillmentPolicy.mode to be Enabled. | int Constraints: Min value = 1 |
| overridesProfile | Per-VM overrides and the shared name prefix, specified when the operation is created. | BulkCreateCustomOverridesProfile |
| partialFulfillmentPolicy | Controls how partial fulfillment is handled for a BulkCreateCustom request. When enabled, Azure creates only the VMs or vCPUs it has high confidence can be successfully allocated, instead of attempting the entire request and potentially returning allocation failures. | PartialFulfillmentPolicy |
| priorityProfile | Configuration Options for Regular or Spot instances in BulkCreateCustom. | BulkCreateCustomPriorityProfile (required) |
| vmSizesProfile | List of VM sizes supported for BulkCreateCustom | BulkCreateCustomVmSizeProfile[] |
| zoneAllocationPolicy | Zone Allocation Policy for launching instances. | BulkCreateCustomZoneAllocationPolicy |
BulkCreateCustomVmSizeProfile
| Name | Description | Value |
|---|---|---|
| name | The name of the VM size, eg Standard_D2ads_v5 | string Constraints: Min length = 1 (required) |
| override | Optional per-VM-size profile override applied to every VM the service assigns to this size. A size maps to many VMs, so virtualMachineName is not part of this shape. virtualMachineProfile is layered beneath any per-VM override; tags, identity, and plan are merged with the per-VM override, with the per-VM value winning. | BulkCreateCustomOverrideBase |
| rank | The rank of this VM size in the priority order | int (required) |
BulkCreateCustomZoneAllocationPolicy
| Name | Description | Value |
|---|---|---|
| distributionStrategy | The distribution strategy for zone allocation. Defaults to BestEffortBalanced. | 'BestEffortBalanced' 'BestEffortSingleZone' 'Prioritized' |
| zonePreferences | The zone preferences for allocation priority | ZonePreference[] |
CapacityRecommendationParameters
| Name | Description | Value |
|---|---|---|
| availabilityZones | Whether the capacity recommendation should be computed per availability zone | bool |
| desiredLocations | The list of desired Azure regions to be considered for the capacity recommendation | string[] |
| desiredSizes | The list of desired VM sizes (SKUs) to be considered for the capacity recommendation | string[] |
CapacityReservationProfile
| Name | Description | Value |
|---|---|---|
| capacityReservationGroup | Specifies the capacity reservation group resource id that should be used for allocating the virtual machine provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. | SubResource |
ComputeProfile
| Name | Description | Value |
|---|---|---|
| computeApiVersion | Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machines. The default value will be the latest supported computeApiVersion by LaunchBulkInstancesOperation. | string |
| extensions | Virtual Machine Extensions Array to be specified according to specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineExtension | BulkactionVMExtension[] |
| virtualMachineProfile | Base Virtual Machine Profile Properties to be specified according to specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineProperties | BulkactionVMProperties (required) |
DataDisk
| Name | Description | Value |
|---|---|---|
| caching | Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. | 'None' 'ReadOnly' 'ReadWrite' |
| createOption | Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage, Empty, Copy, Restore. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Restore' (required) |
| deleteOption | Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. | 'Delete' 'Detach' |
| detachOption | Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. | 'ForceDetach' |
| diskSizeGB | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. | int |
| image | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. | VirtualHardDisk |
| lun | Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. | int (required) |
| managedDisk | The managed disk parameters. | ManagedDiskParameters |
| name | The disk name. | string |
| sourceResource | The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. | ApiEntityReference |
| toBeDetached | Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset. | bool |
| vhd | The virtual hard disk. | VirtualHardDisk |
| writeAcceleratorEnabled | Specifies whether writeAccelerator should be enabled or disabled on the disk. | bool |
DiagnosticsProfile
| Name | Description | Value |
|---|---|---|
| bootDiagnostics | Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. | BootDiagnostics |
DiffDiskSettings
| Name | Description | Value |
|---|---|---|
| option | Specifies the ephemeral disk settings for operating system disk. | 'Local' |
| placement | Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Minimum api-version for NvmeDisk: 2024-03-01. | 'CacheDisk' 'NvmeDisk' 'ResourceDisk' |
DiskEncryptionSetParameters
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
DiskEncryptionSettings
| Name | Description | Value |
|---|---|---|
| diskEncryptionKey | Specifies the location of the disk encryption key, which is a Key Vault Secret. | KeyVaultSecretReference |
| enabled | Specifies whether disk encryption should be enabled on the virtual machine. | bool |
| keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. | KeyVaultKeyReference |
EncryptionIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentityResourceId | Specifies ARM Resource ID of one of the user identities associated with the VM. | string |
EventGridAndResourceGraph
| Name | Description | Value |
|---|---|---|
| enable | Specifies if event grid and resource graph is enabled for Scheduled event related configurations. | bool |
| scheduledEventsApiVersion | Specifies the api-version to determine which Scheduled Events configuration schema version will be delivered. | string |
ExecutionParameters
| Name | Description | Value |
|---|---|---|
| capacityRecommendationParameters | Capacity recommendation parameters for the request. When provided on an executeStart request, the service computes placement recommendations only if the VM fails to start due to an allocation failure; the recommendations for the desired sizes and locations are then surfaced in the operation's capacityRecommendation response. | CapacityRecommendationParameters |
| optimizationPreference | Details that could optimize the user's request | 'Availability' 'Cost' 'CostAvailabilityBalanced' |
| retryPolicy | Retry policy the user can pass | RetryPolicy |
| verifyVmAgentHealth | When true on an executeStart request, run a post-Start VM agent health check and engage the fallback chain if the guest agent does not report Ready. Ignored for non-Start operations. | bool |
HardwareProfile
| Name | Description | Value |
|---|---|---|
| vmSize | Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. | string |
| vmSizeProperties | Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details. | VmSizeProperties |
HostEndpointSettings
| Name | Description | Value |
|---|---|---|
| inVMAccessControlProfileReferenceId | Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} | string |
| mode | Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. | 'Audit' 'Disabled' 'Enforce' |
ImageReference
| Name | Description | Value |
|---|---|---|
| communityGalleryImageId | Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. | string |
| id | The ID of the sub-resource. | string |
| offer | Specifies the offer of the platform image or marketplace image used to create the virtual machine. | string |
| publisher | The image publisher. | string |
| sharedGalleryImageId | Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. | string |
| sku | The image SKU. | string |
| version | Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. | string |
KeyVaultKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | The URL referencing a key encryption key in Key Vault. | string (required) |
| sourceVault | The relative URL of the Key Vault containing the key. | SubResource (required) |
KeyVaultSecretReference
| Name | Description | Value |
|---|---|---|
| secretUrl | The URL referencing a secret in a Key Vault. | string (required) |
| sourceVault | The relative URL of the Key Vault containing the secret. | SubResource (required) |
LinuxConfiguration
| Name | Description | Value |
|---|---|---|
| disablePasswordAuthentication | Specifies whether password authentication should be disabled. | bool |
| enableVMAgentPlatformUpdates | Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. | bool |
| patchSettings | [Preview Feature] Specifies settings related to VM Guest Patching on Linux. | LinuxPatchSettings |
| provisionVMAgent | Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. | bool |
| ssh | Specifies the ssh key configuration for a Linux OS. | SshConfiguration |
LinuxPatchSettings
| Name | Description | Value |
|---|---|---|
| assessmentMode | Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
'AutomaticByPlatform' 'ImageDefault' |
| automaticByPlatformSettings | Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. | LinuxVMGuestPatchAutomaticByPlatformSettings |
| patchMode | Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true |
'AutomaticByPlatform' 'ImageDefault' |
LinuxVMGuestPatchAutomaticByPlatformSettings
| Name | Description | Value |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule | Enables customer to schedule patching without accidental upgrades | bool |
| rebootSetting | Specifies the reboot setting for all AutomaticByPlatform patch installation operations. | 'Always' 'IfRequired' 'Never' 'Unknown' |
LocationBasedBulkCreateCustomTags
| Name | Description | Value |
|---|
ManagedDiskParameters
| Name | Description | Value |
|---|---|---|
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed disk. | DiskEncryptionSetParameters |
| id | The ID of the sub-resource. | string |
| securityProfile | Specifies the security profile for the managed disk. | VMDiskSecurityProfile |
| storageAccountType | Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. | 'PremiumV2_LRS' 'Premium_LRS' 'Premium_ZRS' 'StandardSSD_LRS' 'StandardSSD_ZRS' 'Standard_LRS' 'UltraSSD_LRS' |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
NetworkInterfaceReference
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
| properties | Describes a network interface reference properties. | NetworkInterfaceReferenceProperties |
NetworkInterfaceReferenceProperties
| Name | Description | Value |
|---|---|---|
| deleteOption | Specify what happens to the network interface when the VM is deleted | 'Delete' 'Detach' |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
NetworkProfile
| Name | Description | Value |
|---|---|---|
| networkApiVersion | specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations | '2020-11-01' '2022-11-01' |
| networkInterfaceConfigurations | Specifies the networking configurations that will be used to create the virtual machine networking resources. | VirtualMachineNetworkInterfaceConfiguration[] |
| networkInterfaces | Specifies the list of resource Ids for the network interfaces associated with the virtual machine. | NetworkInterfaceReference[] |
OSDisk
| Name | Description | Value |
|---|---|---|
| caching | Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. | 'None' 'ReadOnly' 'ReadWrite' |
| createOption | Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. | 'Attach' 'Copy' 'Empty' 'FromImage' 'Restore' (required) |
| deleteOption | Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk. | 'Delete' 'Detach' |
| diffDiskSettings | Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. | DiffDiskSettings |
| diskSizeGB | Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. | int |
| encryptionSettings | Specifies the encryption settings for the OS Disk. Minimum compute api-version: 2015-06-15. | DiskEncryptionSettings |
| image | The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. | VirtualHardDisk |
| managedDisk | The managed disk parameters. | ManagedDiskParameters |
| name | The disk name. | string |
| osType | This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. | 'Linux' 'Windows' |
| vhd | The virtual hard disk. | VirtualHardDisk |
| writeAcceleratorEnabled | Specifies whether writeAccelerator should be enabled or disabled on the disk. | bool |
OSImageNotificationProfile
| Name | Description | Value |
|---|---|---|
| enable | Specifies whether the OS Image Scheduled event is enabled or disabled. | bool |
| notBeforeTimeout | Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) | string |
OSProfile
| Name | Description | Value |
|---|---|---|
| adminPassword | Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension |
string Constraints: Sensitive value. Pass in as a secure parameter. |
| adminUsername | Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters. |
string |
| allowExtensionOperations | Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. | bool |
| computerName | Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines. | string |
| customData | Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation. | string |
| linuxConfiguration | Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. | LinuxConfiguration |
| requireGuestProvisionSignal | Optional property which must either be set to True or omitted. | bool |
| secrets | Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. | VaultSecretGroup[] |
| windowsConfiguration | Specifies Windows operating system settings on the virtual machine. | WindowsConfiguration |
PartialFulfillmentPolicy
| Name | Description | Value |
|---|---|---|
| mode | Specifies whether partial fulfillment is allowed. When Enabled, Azure creates as many VMs as it has high confidence can be successfully allocated. When Disabled, Azure attempts to create all requested VMs, which may result into allocation failures. | 'Disabled' 'Enabled' |
PatchSettings
| Name | Description | Value |
|---|---|---|
| assessmentMode | Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
'AutomaticByPlatform' 'ImageDefault' |
| automaticByPlatformSettings | Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. | WindowsVMGuestPatchAutomaticByPlatformSettings |
| enableHotpatching | Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. | bool |
| patchMode | Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true |
'AutomaticByOS' 'AutomaticByPlatform' 'Manual' |
Plan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ProxyAgentSettings
| Name | Description | Value |
|---|---|---|
| addProxyAgentExtension | Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os. | bool |
| enabled | Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. | bool |
| imds | Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. | HostEndpointSettings |
| keyIncarnationId | Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. | int |
| mode | Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. | 'Audit' 'Enforce' |
| wireServer | Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. | HostEndpointSettings |
PublicIPAddressSku
| Name | Description | Value |
|---|---|---|
| name | Specify public IP sku name | 'Basic' 'Standard' |
| tier | Specify public IP sku tier | 'Global' 'Regional' |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| onFailureAction | Action to take on failure | 'Create' 'Deallocate' 'Delete' 'GetInstanceView' 'Hibernate' 'Start' 'Unknown' |
| retryCount | Retry count for user request | int |
| retryWindowInMinutes | Retry window in minutes for user request | int |
ScheduledEventsAdditionalPublishingTargets
| Name | Description | Value |
|---|---|---|
| eventGridAndResourceGraph | The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. | EventGridAndResourceGraph |
ScheduledEventsPolicy
| Name | Description | Value |
|---|---|---|
| allInstancesDown | The configuration parameters used while creating AllInstancesDown scheduled event setting creation. | AllInstancesDown |
| scheduledEventsAdditionalPublishingTargets | The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. | ScheduledEventsAdditionalPublishingTargets |
| userInitiatedReboot | The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. | UserInitiatedReboot |
| userInitiatedRedeploy | The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. | UserInitiatedRedeploy |
ScheduledEventsProfile
| Name | Description | Value |
|---|---|---|
| osImageNotificationProfile | Specifies OS Image Scheduled Event related configurations. | OSImageNotificationProfile |
| terminateNotificationProfile | Specifies Terminate Scheduled Event related configurations. | TerminateNotificationProfile |
SecurityProfile
| Name | Description | Value |
|---|---|---|
| encryptionAtHost | This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. | bool |
| encryptionIdentity | Specifies the Managed Identity used by ADE to get access token for keyvault operations. | EncryptionIdentity |
| proxyAgentSettings | Specifies ProxyAgent settings while creating the virtual machine. Minimum compute api-version: 2023-09-01. | ProxyAgentSettings |
| securityType | Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. | 'ConfidentialVM' 'TrustedLaunch' |
| uefiSettings | Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum compute api-version: 2020-12-01. | UefiSettings |
SshConfiguration
| Name | Description | Value |
|---|---|---|
| publicKeys | The list of SSH public keys used to authenticate with linux based VMs. | SshPublicKey[] |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]/azure/virtual-machines/linux/create-ssh-keys-detailed). | string |
| path | Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys | string |
StorageProfile
| Name | Description | Value |
|---|---|---|
| dataDisks | Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. | DataDisk[] |
| diskControllerType | Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. | 'NVMe' 'SCSI' |
| imageReference | Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. | ImageReference |
| osDisk | Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. | OSDisk |
SubResource
| Name | Description | Value |
|---|---|---|
| id | The ID of the sub-resource. | string |
TerminateNotificationProfile
| Name | Description | Value |
|---|---|---|
| enable | Specifies whether the Terminate Scheduled event is enabled or disabled. | bool |
| notBeforeTimeout | Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) | string |
UefiSettings
| Name | Description | Value |
|---|---|---|
| secureBootEnabled | Specifies whether secure boot should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. | bool |
| vTpmEnabled | Specifies whether vTPM should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. | bool |
UserAssignedIdentitiesValue
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserInitiatedReboot
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies Reboot Scheduled Event related configurations. | bool |
UserInitiatedRedeploy
| Name | Description | Value |
|---|---|---|
| automaticallyApprove | Specifies Redeploy Scheduled Event related configurations. | bool |
VaultCertificate
| Name | Description | Value |
|---|---|---|
| certificateStore | For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. | string |
| certificateUrl | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { 'data':'<Base64-encoded-certificate>', 'dataType':'pfx', 'password':'<pfx-file-password>' } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
string |
VaultSecretGroup
| Name | Description | Value |
|---|---|---|
| sourceVault | The relative URL of the Key Vault containing all of the certificates in VaultCertificates. | SubResource |
| vaultCertificates | The list of key vault references in SourceVault which contain certificates. | VaultCertificate[] |
VirtualHardDisk
| Name | Description | Value |
|---|---|---|
| uri | Specifies the virtual hard disk's uri. | string |
VirtualMachineIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | VirtualMachineIdentityUserAssignedIdentities |
VirtualMachineIdentityUserAssignedIdentities
| Name | Description | Value |
|---|
VirtualMachineIpTag
| Name | Description | Value |
|---|---|---|
| ipTagType | IP tag type. Example: FirstPartyUsage. | string |
| tag | IP tag associated with the public IP. Example: SQL, Storage etc. | string |
VirtualMachineNetworkInterfaceConfiguration
| Name | Description | Value |
|---|---|---|
| name | The network interface configuration name. | string (required) |
| properties | Describes a virtual machine network profile's IP configuration. | VirtualMachineNetworkInterfaceConfigurationProperties |
| tags | Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration | VirtualMachineNetworkInterfaceConfigurationTags |
VirtualMachineNetworkInterfaceConfigurationProperties
| Name | Description | Value |
|---|---|---|
| auxiliaryMode | Specifies whether the Auxiliary mode is enabled for the Network Interface resource. | 'AcceleratedConnections' 'Floating' 'None' |
| auxiliarySku | Specifies whether the Auxiliary sku is enabled for the Network Interface resource. | 'A1' 'A2' 'A4' 'A8' 'None' |
| deleteOption | Specify what happens to the network interface when the VM is deleted | 'Delete' 'Detach' |
| disableTcpStateTracking | Specifies whether the network interface is disabled for tcp state tracking. | bool |
| dnsSettings | The dns settings to be applied on the network interfaces. | VirtualMachineNetworkInterfaceDnsSettingsConfiguration |
| dscpConfiguration | The DSCP configuration for the network interface. | SubResource |
| enableAcceleratedNetworking | Specifies whether the network interface is accelerated networking-enabled. | bool |
| enableFpga | Specifies whether the network interface is FPGA networking-enabled. | bool |
| enableIPForwarding | Whether IP forwarding enabled on this NIC. | bool |
| ipConfigurations | Specifies the IP configurations of the network interface. | VirtualMachineNetworkInterfaceIPConfiguration[] (required) |
| networkSecurityGroup | The network security group. | SubResource |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
VirtualMachineNetworkInterfaceConfigurationTags
| Name | Description | Value |
|---|
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
| Name | Description | Value |
|---|---|---|
| dnsServers | List of DNS servers IP addresses | string[] |
VirtualMachineNetworkInterfaceIPConfiguration
| Name | Description | Value |
|---|---|---|
| name | The IP configuration name. | string (required) |
| properties | Describes a virtual machine network interface IP configuration properties. | VirtualMachineNetworkInterfaceIPConfigurationProperties |
VirtualMachineNetworkInterfaceIPConfigurationProperties
| Name | Description | Value |
|---|---|---|
| applicationGatewayBackendAddressPools | Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. | SubResource[] |
| applicationSecurityGroups | Specifies an array of references to application security group. | SubResource[] |
| loadBalancerBackendAddressPools | Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. | SubResource[] |
| primary | Specifies the primary network interface in case the virtual machine has more than 1 network interface. | bool |
| privateIPAddressVersion | Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. | 'IPv4' 'IPv6' |
| publicIPAddressConfiguration | The publicIPAddressConfiguration. | VirtualMachinePublicIPAddressConfiguration |
| subnet | Specifies the identifier of the subnet. | SubResource |
VirtualMachinePublicIPAddressConfiguration
| Name | Description | Value |
|---|---|---|
| name | The publicIP address configuration name. | string (required) |
| properties | Describes a virtual machines IP Configuration's PublicIPAddress configuration | VirtualMachinePublicIPAddressConfigurationProperties |
| sku | Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. | PublicIPAddressSku |
| tags | Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration | VirtualMachinePublicIPAddressConfigurationTags |
VirtualMachinePublicIPAddressConfigurationProperties
| Name | Description | Value |
|---|---|---|
| deleteOption | Specify what happens to the public IP address when the VM is deleted | 'Delete' 'Detach' |
| dnsSettings | The dns settings to be applied on the publicIP addresses . | VirtualMachinePublicIPAddressDnsSettingsConfiguration |
| idleTimeoutInMinutes | The idle timeout of the public IP address. | int |
| ipTags | The list of IP tags associated with the public IP address. | VirtualMachineIpTag[] |
| publicIPAddressVersion | Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. | 'IPv4' 'IPv6' |
| publicIPAllocationMethod | Specify the public IP allocation type | 'Dynamic' 'Static' |
| publicIPPrefix | The PublicIPPrefix from which to allocate publicIP addresses. | SubResource |
VirtualMachinePublicIPAddressConfigurationTags
| Name | Description | Value |
|---|
VirtualMachinePublicIPAddressDnsSettingsConfiguration
| Name | Description | Value |
|---|---|---|
| domainNameLabel | The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. | string (required) |
| domainNameLabelScope | The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. | 'NoReuse' 'ResourceGroupReuse' 'SubscriptionReuse' 'TenantReuse' |
VMDiskSecurityProfile
| Name | Description | Value |
|---|---|---|
| diskEncryptionSet | Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. | DiskEncryptionSetParameters |
| securityEncryptionType | Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. | 'DiskWithVMGuestState' 'NonPersistedTPM' 'VMGuestStateOnly' |
VMGalleryApplication
| Name | Description | Value |
|---|---|---|
| configurationReference | Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided | string |
| enableAutomaticUpgrade | If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS | bool |
| order | Optional, Specifies the order in which the packages have to be installed | int |
| packageReferenceId | Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} | string (required) |
| tags | Optional, Specifies a passthrough value for more generic context. | string |
| treatFailureAsDeploymentFailure | Optional, If true, any failure for any operation in the VmApplication will fail the deployment | bool |
VmSizeProperties
| Name | Description | Value |
|---|---|---|
| vCpusAvailable | Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region. | int |
| vCpusPerCore | Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled. | int |
WindowsConfiguration
| Name | Description | Value |
|---|---|---|
| additionalUnattendContent | Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. | AdditionalUnattendContent[] |
| enableAutomaticUpdates | Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. | bool |
| patchSettings | [Preview Feature] Specifies settings related to VM Guest Patching on Windows. | PatchSettings |
| provisionVMAgent | Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. | bool |
| timeZone | Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. | string |
| winRM | Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. | WinRMConfiguration |
WindowsVMGuestPatchAutomaticByPlatformSettings
| Name | Description | Value |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule | Enables customer to schedule patching without accidental upgrades | bool |
| rebootSetting | Specifies the reboot setting for all AutomaticByPlatform patch installation operations. | 'Always' 'IfRequired' 'Never' 'Unknown' |
WinRMConfiguration
| Name | Description | Value |
|---|---|---|
| listeners | The list of Windows Remote Management listeners | WinRMListener[] |
WinRMListener
| Name | Description | Value |
|---|---|---|
| certificateUrl | This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
string |
| protocol | Specifies the protocol of WinRM listener. Possible values are: http, https. | 'Http' 'Https' |
ZonePreference
| Name | Description | Value |
|---|---|---|
| rank | The rank of this zone in the priority order | int (required) |
| zone | The zone identifier | string (required) |