diff --git a/schemas/2015-06-15/Microsoft.Compute.json b/schemas/2015-06-15/Microsoft.Compute.json new file mode 100644 index 0000000000..14fe5d8914 --- /dev/null +++ b/schemas/2015-06-15/Microsoft.Compute.json @@ -0,0 +1,2035 @@ +{ + "id": "https://schema.management.azure.com/schemas/2015-06-15/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "availabilitySets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2015-06-15" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilitySetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/availabilitySets" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2015-06-15" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" + }, + "virtualMachineScaleSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2015-06-15" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2015-06-15" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + }, + "content": { + "type": "string", + "description": "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." + }, + "passName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "OobeSystem" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The pass name. Currently, the only allowable value is OobeSystem." + }, + "settingName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "virtualMachines": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of references to all virtual machines in the availability set." + } + }, + "description": "The instance view of a resource." + }, + "BootDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + } + }, + "required": [ + "createOption", + "lun", + "name", + "vhd" + ], + "description": "Describes a data disk." + }, + "DiagnosticsProfile": { + "type": "object", + "properties": { + "bootDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/BootDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Secret" + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Key" + } + }, + "required": [ + "diskEncryptionKey" + ], + "description": "Describes a Encryption Settings for a Disk" + }, + "HardwareProfile": { + "type": "object", + "properties": { + "vmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

[List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "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." + } + }, + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "InstanceViewStatus": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "level": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Info", + "Warning", + "Error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The level code." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "KeyVaultKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "KeyVaultSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "LinuxConfiguration": { + "type": "object", + "properties": { + "disablePasswordAuthentication": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "oneOf": [ + { + "$ref": "#/definitions/SshConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSH configuration for Linux based VMs running on Azure" + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "NetworkInterfaceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network interface reference properties." + } + }, + "description": "Describes a network interface reference." + }, + "NetworkInterfaceReferenceProperties": { + "type": "object", + "properties": { + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "OSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

This value cannot be larger than 1023 GB" + }, + "encryptionSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a Encryption Settings for a Disk" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + } + }, + "required": [ + "createOption", + "name", + "vhd" + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "OSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "Sku": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "SshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "SshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "StorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/OSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + } + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + } + }, + "description": "Describes an upgrade policy - automatic or manual." + }, + "VaultCertificate": { + "type": "object", + "properties": { + "certificateStore": { + "type": "string", + "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "properties": { + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "vaultCertificates": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "VirtualHardDisk": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "VirtualMachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "statuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "substatuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "instanceView": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineProperties": { + "type": "object", + "properties": { + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "properties": { + "extensions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether the extension handler should be automatically upgraded across minor versions." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "Json formatted protected settings for the extension." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "The type of the extension handler." + }, + "typeHandlerVersion": { + "type": "string", + "description": "The type version of the extension handler." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "properties": { + "loadBalancerBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The load balancer inbound nat pools." + }, + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + } + }, + "required": [ + "subnet" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "properties": { + "ipConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set IP Configuration." + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this is a primary NIC on a virtual machine." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "properties": { + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhdContainers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of virtual hard disk container uris." + } + }, + "required": [ + "createOption", + "name" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The List of certificates for addition to the VM." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetProperties": { + "type": "object", + "properties": { + "overProvision": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an upgrade policy - automatic or manual." + }, + "virtualMachineProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set virtual machine profile." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetVMProfile": { + "type": "object", + "properties": { + "extensionProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set extension profile." + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set OS profile." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set storage profile." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2015-06-15" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { + "additionalUnattendContent": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "winRM": { + "oneOf": [ + { + "$ref": "#/definitions/WinRMConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes Windows Remote Management configuration of the VM" + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "WinRMConfiguration": { + "type": "object", + "properties": { + "listeners": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WinRMListener": { + "type": "object", + "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Http", + "Https" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + } + } +} diff --git a/schemas/2015-11-01-preview/Microsoft.ContainerService.json b/schemas/2015-11-01-preview/Microsoft.ContainerService.json new file mode 100644 index 0000000000..0487f60c53 --- /dev/null +++ b/schemas/2015-11-01-preview/Microsoft.ContainerService.json @@ -0,0 +1,394 @@ +{ + "id": "https://schema.management.azure.com/schemas/2015-11-01-preview/Microsoft.ContainerService.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.ContainerService", + "description": "Microsoft ContainerService Resource Types", + "resourceDefinitions": { + "containerServices": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2015-11-01-preview" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the container service within the given subscription and resource group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of container service" + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.ContainerService/containerServices" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.ContainerService/containerServices" + } + }, + "definitions": { + "ContainerServiceAgentPoolProfile": { + "type": "object", + "properties": { + "count": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "No. of agents (VMs) that will host docker containers" + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create FQDN for this agent pool" + }, + "name": { + "type": "string", + "description": "Unique name of the agent pool profile within the context of the subscription and resource group" + }, + "vmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Size of agent VMs." + } + }, + "required": [ + "dnsPrefix", + "name" + ], + "description": "Profile for container service agent pool" + }, + "ContainerServiceDiagnosticsProfile": { + "type": "object", + "properties": { + "vmDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceVMDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes VM Diagnostics." + } + } + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for all Linux VMs" + }, + "ssh": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceSshConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSH configuration for Linux based VMs running on Azure" + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VM" + }, + "ContainerServiceMasterProfile": { + "type": "object", + "properties": { + "count": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of masters (VMs) in the container cluster" + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create FQDN for master" + } + }, + "required": [ + "dnsPrefix" + ], + "description": "Profile for container service master" + }, + "ContainerServiceOrchestratorProfile": { + "type": "object", + "properties": { + "orchestratorType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Mesos", + "SwarmPreview", + "DCOS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies what orchestrator will be used to manage container cluster resources." + } + }, + "description": "Profile for Orchestrator" + }, + "ContainerServiceProperties": { + "type": "object", + "properties": { + "agentPoolProfiles": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceAgentPoolProfile" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of agent pools" + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceDiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "linuxProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceLinuxProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Profile for Linux VM" + }, + "masterProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceMasterProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Profile for container service master" + }, + "orchestratorProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceOrchestratorProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Profile for Orchestrator" + }, + "windowsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ContainerServiceWindowsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Profile for Windows jumpbox" + } + }, + "required": [ + "agentPoolProfiles", + "linuxProfile", + "masterProfile" + ], + "description": "Properties of container service" + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gets or sets the list of SSH public keys used to authenticate with Linux based VMs" + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceVMDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine." + } + }, + "description": "Describes VM Diagnostics." + }, + "ContainerServiceWindowsProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows jumpbox" + }, + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows jumpbox" + } + }, + "required": [ + "adminPassword", + "adminUsername" + ], + "description": "Profile for Windows jumpbox" + } + } +} diff --git a/schemas/2016-03-30/Microsoft.Compute.json b/schemas/2016-03-30/Microsoft.Compute.json new file mode 100644 index 0000000000..41b28a3b1a --- /dev/null +++ b/schemas/2016-03-30/Microsoft.Compute.json @@ -0,0 +1,2115 @@ +{ + "id": "https://schema.management.azure.com/schemas/2016-03-30/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "availabilitySets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-03-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilitySetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a resource." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/availabilitySets" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-03-30" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" + }, + "virtualMachineScaleSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-03-30" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-03-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + }, + "content": { + "type": "string", + "description": "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." + }, + "passName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "OobeSystem" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The pass name. Currently, the only allowable value is OobeSystem." + }, + "settingName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "virtualMachines": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of references to all virtual machines in the availability set." + } + }, + "description": "The instance view of a resource." + }, + "BootDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + } + }, + "required": [ + "createOption", + "lun", + "name", + "vhd" + ], + "description": "Describes a data disk." + }, + "DiagnosticsProfile": { + "type": "object", + "properties": { + "bootDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/BootDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Secret" + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Key" + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "HardwareProfile": { + "type": "object", + "properties": { + "vmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "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." + } + }, + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "InstanceViewStatus": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "level": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Info", + "Warning", + "Error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The level code." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "KeyVaultKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "KeyVaultSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "LinuxConfiguration": { + "type": "object", + "properties": { + "disablePasswordAuthentication": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "oneOf": [ + { + "$ref": "#/definitions/SshConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSH configuration for Linux based VMs running on Azure" + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "NetworkInterfaceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network interface reference properties." + } + }, + "description": "Describes a network interface reference." + }, + "NetworkInterfaceReferenceProperties": { + "type": "object", + "properties": { + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "OSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "encryptionSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a Encryption Settings for a Disk" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + } + }, + "required": [ + "createOption", + "name", + "vhd" + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "OSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "Sku": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "SshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "SshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "StorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/OSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + } + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + } + }, + "description": "Describes an upgrade policy - automatic or manual." + }, + "VaultCertificate": { + "type": "object", + "properties": { + "certificateStore": { + "type": "string", + "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "properties": { + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "vaultCertificates": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "VirtualHardDisk": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "VirtualMachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "statuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "substatuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "instanceView": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." + } + }, + "description": "Identity for the virtual machine." + }, + "VirtualMachineProperties": { + "type": "object", + "properties": { + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "properties": { + "extensions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether the extension handler should be automatically upgraded across minor versions." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "Json formatted protected settings for the extension." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "The type of the extension handler." + }, + "typeHandlerVersion": { + "type": "string", + "description": "The type version of the extension handler." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "properties": { + "applicationGatewayBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The application gateway backend address pools." + }, + "loadBalancerBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The load balancer inbound nat pools." + }, + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + } + }, + "required": [ + "subnet" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "properties": { + "ipConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set IP Configuration." + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether this is a primary NIC on a virtual machine." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "properties": { + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhdContainers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of virtual hard disk container uris." + } + }, + "required": [ + "createOption", + "name" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The List of certificates for addition to the VM." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetProperties": { + "type": "object", + "properties": { + "overProvision": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an upgrade policy - automatic or manual." + }, + "virtualMachineProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set virtual machine profile." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetVMProfile": { + "type": "object", + "properties": { + "extensionProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set extension profile." + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set OS profile." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set storage profile." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-03-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { + "additionalUnattendContent": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "winRM": { + "oneOf": [ + { + "$ref": "#/definitions/WinRMConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes Windows Remote Management configuration of the VM" + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "WinRMConfiguration": { + "type": "object", + "properties": { + "listeners": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WinRMListener": { + "type": "object", + "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Http", + "Https" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + } + } +} diff --git a/schemas/2016-03-30/Microsoft.ContainerService.json b/schemas/2016-03-30/Microsoft.ContainerService.json index 31213cc4f6..56cc060a01 100644 --- a/schemas/2016-03-30/Microsoft.ContainerService.json +++ b/schemas/2016-03-30/Microsoft.ContainerService.json @@ -404,4 +404,4 @@ "description": "Profile for Windows VMs in the container service cluster." } } -} \ No newline at end of file +} diff --git a/schemas/2016-04-30-preview/Microsoft.Compute.json b/schemas/2016-04-30-preview/Microsoft.Compute.json index 2908e65da0..68d480576d 100644 --- a/schemas/2016-04-30-preview/Microsoft.Compute.json +++ b/schemas/2016-04-30-preview/Microsoft.Compute.json @@ -7,18 +7,20 @@ "availabilitySets": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ "2016-04-30-preview" ] }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the availability set." + }, "properties": { "oneOf": [ { @@ -27,7 +29,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The instance view of a resource." }, "sku": { "oneOf": [ @@ -38,239 +41,174 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set" - } - }, - "required": [ - "type", - "apiVersion", - "properties", - "location" - ], - "description": "Microsoft.Compute/availabilitySets" - }, - "images": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2016-04-30-preview" - ] + "description": "Describes a virtual machine scale set sku." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" ] } }, "required": [ - "type", "apiVersion", + "location", + "name", "properties", - "location" + "type" ], - "description": "Microsoft.Compute/images" + "description": "Microsoft.Compute/availabilitySets" }, - "virtualMachines": { + "disks": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ "2016-04-30-preview" ] }, - "plan": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "$ref": "#/definitions/DiskProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The purchase plan when deploying virtual machine from VM Marketplace images." + "description": "Disk resource properties." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/extensionsChild" - } - ] - } + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] } }, "required": [ - "type", "apiVersion", + "location", + "name", "properties", - "location" + "type" ], - "description": "Microsoft.Compute/virtualMachines" + "description": "Microsoft.Compute/disks" }, - "extensions": { + "images": { "type": "object", "properties": { - "type": { - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, "apiVersion": { + "type": "string", "enum": [ "2016-04-30-preview" ] }, - "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} - ] - } - }, - "required": [ - "type", - "properties", - "apiVersion", - "location" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { - "type": { + "location": { "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] + "description": "Resource location" }, - "apiVersion": { + "name": { "type": "string", - "enum": [ - "2016-04-30-preview" - ] + "description": "The name of the image." }, - "sku": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set sku." + "description": "Describes the properties of an Image." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + "description": "Resource tags" }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" ] } }, "required": [ - "type", "apiVersion", - "sku", + "location", + "name", "properties", - "location" + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets" + "description": "Microsoft.Compute/images" }, - "disks": { + "snapshots": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/disks" - ] - }, "apiVersion": { "type": "string", "enum": [ "2016-04-30-preview" ] }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot within the given subscription and resource group." + }, "properties": { "oneOf": [ { @@ -279,331 +217,362 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Disk resource properties." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" ] } }, "required": [ - "type", "apiVersion", + "location", + "name", "properties", - "location" + "type" ], - "description": "Microsoft.Compute/disks" + "description": "Microsoft.Compute/snapshots" }, - "snapshots": { + "virtualMachines": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/snapshots" - ] - }, "apiVersion": { "type": "string", "enum": [ "2016-04-30-preview" ] }, - "properties": { + "identity": { "oneOf": [ { - "$ref": "#/definitions/DiskProperties" + "$ref": "#/definitions/VirtualMachineIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] - } - }, - "required": [ - "type", - "apiVersion", - "properties", - "location" - ], - "description": "Microsoft.Compute/snapshots" - } - }, - "definitions": { - "extensionsChild": { - "type": "object", - "properties": { - "type": { - "enum": [ - "extensions" - ] + ], + "description": "Identity for the virtual machine." }, - "apiVersion": { - "enum": [ - "2016-04-30-preview" - ] + "location": { + "type": "string", + "description": "Resource location" }, - "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} - ] - } - }, - "required": [ - "type", - "apiVersion", - "properties", - "location" - ], - "description": "Microsoft.Compute/extensionsChild" - }, - "AdditionalUnattendContent": { - "type": "object", - "properties": { - "passName": { + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { "oneOf": [ { - "type": "string", - "enum": [ - "oobeSystem" - ] + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is oobeSystem." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "componentName": { + "properties": { "oneOf": [ { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] + "$ref": "#/definitions/VirtualMachineProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "Describes the properties of a Virtual Machine." }, - "settingName": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Setting name (e.g. FirstLogonCommands, AutoLogon )." + "description": "Resource tags" }, - "content": { + "type": { "type": "string", - "description": "XML formatted content that is added to the unattend.xml file in the specified pass and component. The XML must be less than 4 KB and must include the root element for the setting or feature that is being inserted." + "enum": [ + "Microsoft.Compute/virtualMachines" + ] } }, - "description": "Additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is a applied." + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" }, - "ApiEntityReference": { + "virtualMachineScaleSets": { "type": "object", "properties": { - "id": { + "apiVersion": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { + "enum": [ + "2016-04-30-preview" + ] + }, + "identity": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Update Domain count." + "description": "Identity for the virtual machine scale set." }, - "platformFaultDomainCount": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "virtualMachines": { + "properties": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A list of references to all virtual machines in the availability set." + "description": "Describes the properties of a Virtual Machine Scale Set." }, - "managed": { + "sku": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If the availability set supports managed disks." - } - }, - "description": "The instance view of a resource." - }, - "BootDiagnostics": { - "type": "object", - "properties": { - "enabled": { + "description": "Describes a virtual machine scale set sku." + }, + "tags": { "oneOf": [ { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + "description": "Resource tags" }, - "storageUri": { + "type": { "type": "string", - "description": "URI of the storage account to use for placing the console output and screenshot." + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] } }, - "description": "Describes Boot Diagnostics." + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" }, - "DataDisk": { + "virtualMachines_extensions": { "type": "object", "properties": { - "lun": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-04-30-preview" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The logical unit number." - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Describes the properties of a Virtual Machine Extension." }, - "vhd": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Resource tags" }, - "image": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source user image virtual hard disk. This virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist." + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." }, - "caching": { + "content": { + "type": "string", + "description": "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." + }, + "passName": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "OobeSystem" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "The pass name. Currently, the only allowable value is OobeSystem." }, - "createOption": { + "settingName": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "AutoLogon", + "FirstLogonCommands" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "managed": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If the availability set supports managed disks." }, - "diskSizeGB": { + "platformFaultDomainCount": { "oneOf": [ { "type": "integer" @@ -612,1888 +581,1688 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial disk size in GB for blank data disks, and the new desired size for resizing existing OS and data disks." + "description": "Fault Domain count." }, - "managedDisk": { + "platformUpdateDomainCount": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a data disk." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { + "description": "Update Domain count." + }, + "virtualMachines": { "oneOf": [ { - "$ref": "#/definitions/BootDiagnostics" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Boot Diagnostics is a debugging feature which allows the user to view console output and/or a screenshot of the virtual machine from the hypervisor." + "description": "A list of references to all virtual machines in the availability set." } }, - "description": "Describes a diagnostics profile." + "description": "The instance view of a resource." }, - "DiskEncryptionSettings": { + "BootDiagnostics": { "type": "object", "properties": { - "diskEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultSecretReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The disk encryption key which is a Key Vault Secret." + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." }, - "keyEncryptionKey": { + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "CreationData": { + "type": "object", + "properties": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The key encryption key which is Key Vault Key." + "description": "This enumerates the possible sources of a disk's creation." }, - "enabled": { + "imageReference": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/ImageDiskReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is a SAS URI to a blob to be imported into a managed disk. If createOption is Copy, this is a relative Uri containing the id of the source snapshot to be copied into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" } }, - "description": "Describes a Encryption Settings for a Disk" + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." }, - "HardwareProfile": { + "DataDisk": { "type": "object", "properties": { - "vmSize": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine size name." - } - }, - "description": "Describes a hardware profile." - }, - "ImageDataDisk": { - "type": "object", - "properties": { - "lun": { + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The logical unit number." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "image": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "Describes the uri of a disk." }, - "caching": { + "lun": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "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." }, - "diskSizeGB": { + "managedDisk": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "The parameters of a managed disk." }, - "storageAccountType": { + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." + "description": "Describes the uri of a disk." } }, "required": [ + "createOption", "lun" ], "description": "Describes a data disk." }, - "ImageOSDisk": { + "DiagnosticsProfile": { "type": "object", "properties": { - "osType": { + "bootDiagnostics": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/BootDiagnostics" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." - }, - "osState": { + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { "oneOf": [ { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] + "$ref": "#/definitions/KeyVaultSecretReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "Describes a reference to Key Vault Secret" }, - "snapshot": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies whether disk encryption should be enabled on the virtual machine." }, - "managedDisk": { + "keyEncryptionKey": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/KeyVaultKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { + "description": "Describes a reference to Key Vault Key" + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "DiskProperties": { + "type": "object", + "properties": { + "accountType": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Standard_LRS", + "Premium_LRS" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "the storage account type of the disk." }, - "diskSizeGB": { + "creationData": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/CreationData" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial managed disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "Data used when creating a disk." }, - "storageAccountType": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." - } - }, - "required": [ - "osType", - "osState" - ], - "description": "Describes an Operating System disk." - }, - "ImageProperties": { - "type": "object", - "properties": { - "sourceVirtualMachine": { + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettings": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/EncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source virtual machine from which Image is created." + "description": "Encryption settings for disk or snapshot" }, - "storageProfile": { + "osType": { "oneOf": [ { - "$ref": "#/definitions/ImageStorageProfile" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The storage profile." + "description": "The Operating System type." } }, - "description": "Describes the properties of an Image." + "required": [ + "creationData" + ], + "description": "Disk resource properties." }, - "ImageReference": { + "EncryptionSettings": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "Resource Id" - }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "The image offer." - }, - "sku": { - "type": "string", - "description": "The image SKU." + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Secret Url and vault id of the encryption key " }, - "version": { - "type": "string", - "description": "The image version. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor and Build are decimal numbers. Specify 'latest' to use the latest version of the image." - } - }, - "description": "The image reference." - }, - "ImageStorageProfile": { - "type": "object", - "properties": { - "osDisk": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/ImageOSDisk" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS disk." + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." }, - "dataDisks": { + "keyEncryptionKey": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } + "$ref": "#/definitions/KeyVaultAndKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The data disks." + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" } }, - "required": [ - "osDisk" - ], - "description": "Describes a storage profile." + "description": "Encryption settings for disk or snapshot" }, - "InstanceViewStatus": { + "HardwareProfile": { "type": "object", "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { + "vmSize": { "oneOf": [ { "type": "string", "enum": [ - "Info", - "Warning", - "Error" + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The level code." - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](virtualmachines-list-sizes-availability-set.md)

    [List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md)

    [List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md)." } }, - "description": "Instance view status." + "description": "Specifies the hardware settings for the virtual machine." }, - "KeyVaultKeyReference": { + "ImageDataDisk": { "type": "object", "properties": { - "keyUrl": { + "blobUri": { "type": "string", - "description": "The URL referencing a key in a Key Vault." + "description": "The Virtual Hard Disk." }, - "sourceVault": { + "caching": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "KeyVaultSecretReference": { - "type": "object", - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "sourceVault": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "LinuxConfiguration": { - "type": "object", - "properties": { - "disablePasswordAuthentication": { + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "lun": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether password authentication should be disabled." + "description": "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." }, - "ssh": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/SshConfiguration" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The SSH configuration for linux VMs." - } - }, - "description": "Describes Linux configuration of the OS Profile." - }, - "ManagedDiskParameters": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource Id" + ] }, - "storageAccountType": { + "snapshot": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The Storage Account type." + ] } }, - "description": "The parameters of a managed disk." + "required": [ + "lun" + ], + "description": "Describes a data disk." }, - "NetworkInterfaceReference": { + "ImageDiskReference": { "type": "object", "properties": { "id": { "type": "string", - "description": "Resource Id" + "description": "A relative uri containing either a Platform Image Repository or user image reference." }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] - } - }, - "description": "Describes a network interface reference." - }, - "NetworkInterfaceReferenceProperties": { - "type": "object", - "properties": { - "primary": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkProfile": { - "type": "object", - "properties": { - "networkInterfaces": { + "lun": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - } + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the list of resource IDs for the network interfaces associated with the virtual machine." + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." } }, - "description": "Describes a network profile." + "required": [ + "id" + ], + "description": "The source image used for creating the disk." }, - "OSDisk": { + "ImageOSDisk": { "type": "object", "properties": { - "osType": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The disk encryption settings." - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "vhd": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The virtual hard disk." + ] }, - "image": { + "osState": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist." + "description": "The OS State." }, - "caching": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." }, - "createOption": { + "snapshot": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The create option." - }, - "diskSizeGB": { + ] + } + }, + "required": [ + "osState", + "osType" + ], + "description": "Describes an Operating System disk." + }, + "ImageProperties": { + "type": "object", + "properties": { + "sourceVirtualMachine": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The initial disk size, in GB, for blank data disks, and the new desired size for resizing existing OS and data disks." + ] }, - "managedDisk": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "$ref": "#/definitions/ImageStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes a storage profile." } }, - "required": [ - "createOption" - ], - "description": "Describes an Operating System disk." + "description": "Describes the properties of an Image." }, - "OSProfile": { + "ImageReference": { "type": "object", "properties": { - "computerName": { + "id": { "type": "string", - "description": "Specifies the host OS name of the virtual machine." + "description": "Resource Id" }, - "adminUsername": { + "offer": { "type": "string", - "description": "Specifies the name of the administrator account." + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, - "adminPassword": { + "publisher": { "type": "string", - "description": "Specifies the password of the administrator account." + "description": "The image publisher." }, - "customData": { + "sku": { "type": "string", - "description": "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" - }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The Windows configuration of the OS profile." + "description": "The image SKU." }, - "linuxConfiguration": { + "version": { + "type": "string", + "description": "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." + } + }, + "description": "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." + }, + "ImageStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/LinuxConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Linux configuration of the OS profile." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "secrets": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } + "$ref": "#/definitions/ImageOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The list of certificates for addition to the VM." + "description": "Describes an Operating System disk." } }, - "description": "Describes an OS profile." + "required": [ + "osDisk" + ], + "description": "Describes a storage profile." }, - "Plan": { + "InstanceViewStatus": { "type": "object", "properties": { - "name": { + "code": { "type": "string", - "description": "The plan ID." + "description": "The status code." }, - "publisher": { + "displayStatus": { "type": "string", - "description": "The publisher ID." + "description": "The short localizable label for the status." }, - "product": { + "level": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Info", + "Warning", + "Error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The level code." + }, + "message": { "type": "string", - "description": "The offer ID." + "description": "The detailed status message, including for alerts and error messages." }, - "promotionCode": { + "time": { "type": "string", - "description": "The promotion code." + "format": "date-time", + "description": "The time of the status." } }, - "description": "Plan for the resource." + "description": "Instance view status." }, - "Sku": { + "KeyVaultAndKeyReference": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { + "keyUrl": { "type": "string", - "description": "The sku tier." + "description": "Url pointing to a key or secret in KeyVault" }, - "capacity": { + "sourceVault": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SourceVault" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The sku capacity." + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, - "description": "Describes a virtual machine scale set sku." + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" }, - "SshConfiguration": { + "KeyVaultAndSecretReference": { "type": "object", "properties": { - "publicKeys": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - } + "$ref": "#/definitions/SourceVault" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The list of SSH public keys used to authenticate with linux based VMs." + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, - "description": "SSH configuration for Linux based VMs running on Azure" + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " }, - "SshPublicKey": { + "KeyVaultKeyReference": { "type": "object", "properties": { - "path": { + "keyUrl": { "type": "string", - "description": "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." + "description": "The URL referencing a key encryption key in Key Vault." }, - "keyData": { - "type": "string", - "description": "Certificate public key used to authenticate to the VM through SSH. The certificate must be in Pem format with or without headers." + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] } }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" }, - "StorageProfile": { + "KeyVaultSecretReference": { "type": "object", "properties": { - "imageReference": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The image reference." - }, - "osDisk": { + ] + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "LinuxConfiguration": { + "type": "object", + "properties": { + "disablePasswordAuthentication": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS disk." + "description": "Specifies whether password authentication should be disabled." }, - "dataDisks": { + "ssh": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/SshConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The data disks." + "description": "SSH configuration for Linux based VMs running on Azure" } }, - "description": "Describes a storage profile." + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "SubResource": { + "ManagedDiskParameters": { "type": "object", "properties": { "id": { "type": "string", "description": "Resource Id" - } - } - }, - "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { + }, + "storageAccountType": { "oneOf": [ { "type": "string", "enum": [ - "Automatic", - "Manual" + "Standard_LRS", + "Premium_LRS" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade mode." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, - "description": "Describes an upgrade policy - automatic or manual." + "description": "The parameters of a managed disk." }, - "VaultCertificate": { + "NetworkInterfaceReference": { "type": "object", "properties": { - "certificateUrl": { + "id": { "type": "string", - "description": "The URL referencing a secret in a Key Vault which contains a properly formatted certificate." + "description": "Resource Id" }, - "certificateStore": { - "type": "string", - "description": "The Certificate store in LocalMachine to add the certificate to on Windows, leave empty on Linux." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "type": "object", - "properties": { - "sourceVault": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "VirtualHardDisk": { - "type": "object", - "properties": { - "uri": { - "type": "string", - "description": "The virtual hard disk's URI. Must be a valid URI to a virtual hard disk." + "description": "Describes a network interface reference properties." } }, - "description": "Describes the uri of a disk." + "description": "Describes a network interface reference." }, - "VirtualMachineExtensionInstanceView": { + "NetworkInterfaceReferenceProperties": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "The full type of the extension handler which includes both publisher and type." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, - "substatuses": { + "primary": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The resource status information." - }, - "statuses": { + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { "oneOf": [ { "type": "array", "items": { - "$ref": "#/definitions/InstanceViewStatus" + "$ref": "#/definitions/NetworkInterfaceReference" } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The resource status information." + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." } }, - "description": "The instance view of a virtual machine extension." + "description": "Specifies the network interfaces of the virtual machine." }, - "VirtualMachineExtensionProperties": { + "OSDisk": { "type": "object", "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "The type of the extension handler." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, - "autoUpgradeMinorVersion": { + "caching": { "oneOf": [ { - "type": "boolean" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether the extension handler should be automatically upgraded across minor versions." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "settings": { + "createOption": { "oneOf": [ { - "type": "object" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Json formatted public settings for the extension." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "protectedSettings": { + "diskSizeGB": { "oneOf": [ { - "type": "object" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Json formatted protected settings for the extension." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "instanceView": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineProperties": { - "type": "object", - "properties": { - "hardwareProfile": { + "encryptionSettings": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The hardware profile." + "description": "Describes a Encryption Settings for a Disk" }, - "storageProfile": { + "image": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The storage profile." + "description": "Describes the uri of a disk." }, - "osProfile": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS profile." + "description": "The parameters of a managed disk." }, - "networkProfile": { - "oneOf": [ - { - "$ref": "#/definitions/NetworkProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The network profile." + "name": { + "type": "string", + "description": "The disk name." }, - "diagnosticsProfile": { + "osType": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The diagnostics profile." + "description": "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**." }, - "availabilitySet": { + "vhd": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The reference Id of the availability set to which the virtual machine belongs." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system." + "description": "Describes the uri of a disk." } }, - "description": "Describes the properties of a Virtual Machine." + "required": [ + "createOption" + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "VirtualMachineScaleSetDataDisk": { + "OSProfile": { "type": "object", "properties": { - "name": { + "adminPassword": { "type": "string", - "description": "The disk name." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The logical unit number." + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "caching": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The caching type." + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, - "createOption": { + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "$ref": "#/definitions/LinuxConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "diskSizeGB": { + "secrets": { "oneOf": [ { - "type": "integer" + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "Specifies set of certificates that should be installed onto the virtual machine." }, - "managedDisk": { + "windowsConfiguration": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies Windows operating system settings on the virtual machine." } }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a virtual machine scale set data disk." + "description": "Specifies the operating system settings for the virtual machine." }, - "VirtualMachineScaleSetExtension": { + "Plan": { "type": "object", "properties": { "name": { "type": "string", - "description": "The name of the extension." + "description": "The plan ID." }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, - "description": "Describes a Virtual Machine Scale Set Extension." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "VirtualMachineScaleSetExtensionProfile": { + "Sku": { "type": "object", "properties": { - "extensions": { + "capacity": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set child extension resources." + "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" } }, - "description": "Describes a virtual machine scale set extension profile." + "description": "Describes a virtual machine scale set sku." }, - "VirtualMachineScaleSetExtensionProperties": { + "SourceVault": { "type": "object", "properties": { - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "The type of the extension handler." - }, - "typeHandlerVersion": { + "id": { "type": "string", - "description": "The type version of the extension handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Whether the extension handler should be automatically upgraded across minor versions." - }, - "settings": { - "oneOf": [ - { - "type": "object" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "SshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { "oneOf": [ { - "type": "object" + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Json formatted protected settings for the extension." + "description": "The list of SSH public keys used to authenticate with linux based VMs." } }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." + "description": "SSH configuration for Linux based VMs running on Azure" }, - "VirtualMachineScaleSetIPConfiguration": { + "SshPublicKey": { "type": "object", "properties": { - "id": { + "keyData": { "type": "string", - "description": "Resource Id" + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "name": { + "path": { "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] + "description": "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" } }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." }, - "VirtualMachineScaleSetIPConfigurationProperties": { + "StorageProfile": { "type": "object", "properties": { - "subnet": { - "oneOf": [ - { - "$ref": "#/definitions/ApiEntityReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The subnet." - }, - "applicationGatewayBackendAddressPools": { + "dataDisks": { "oneOf": [ { "type": "array", "items": { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/DataDisk" } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The application gateway backend address pools." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "loadBalancerBackendAddressPools": { + "imageReference": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The load balancer backend address pools." + "description": "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." }, - "loadBalancerInboundNatPools": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The load balancer inbound nat pools." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, - "required": [ - "subnet" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration properties." + "description": "Specifies the storage settings for the virtual machine disks." }, - "VirtualMachineScaleSetManagedDiskParameters": { + "SubResource": { "type": "object", "properties": { - "storageAccountType": { + "id": { + "type": "string", + "description": "Resource Id" + } + } + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "mode": { "oneOf": [ { "type": "string", "enum": [ - "Standard_LRS", - "Premium_LRS" + "Automatic", + "Manual" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." } }, - "description": "Describes the parameters of a ScaleSet managed disk." + "description": "Describes an upgrade policy - automatic or manual." }, - "VirtualMachineScaleSetNetworkConfiguration": { + "VaultCertificate": { "type": "object", "properties": { - "id": { + "certificateStore": { "type": "string", - "description": "Resource Id" + "description": "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 .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." }, - "name": { + "certificateUrl": { "type": "string", - "description": "The network configuration name." - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, - "required": [ - "name" - ], - "description": "Describes a virtual machine scale set network profile's network configurations." + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { + "VaultSecretGroup": { "type": "object", "properties": { - "primary": { + "sourceVault": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Whether this is a primary NIC on a virtual machine." + ] }, - "ipConfigurations": { + "vaultCertificates": { "oneOf": [ { "type": "array", "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + "$ref": "#/definitions/VaultCertificate" } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set IP Configuration." + "description": "The list of key vault references in SourceVault which contain certificates." } }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." + "description": "Describes a set of certificates which are all in the same Key Vault." }, - "VirtualMachineScaleSetNetworkProfile": { + "VirtualHardDisk": { "type": "object", "properties": { - "networkInterfaceConfigurations": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The list of network configurations." + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." } }, - "description": "Describes a virtual machine scale set network profile." + "description": "Describes the uri of a disk." }, - "VirtualMachineScaleSetOSDisk": { + "VirtualMachineExtensionInstanceView": { "type": "object", "properties": { "name": { "type": "string", - "description": "The disk name." + "description": "The virtual machine extension name." }, - "caching": { + "statuses": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "The resource status information." }, - "createOption": { + "substatuses": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "The resource status information." }, - "osType": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "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." }, - "image": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "instanceView": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + "description": "The instance view of a virtual machine extension." }, - "vhdContainers": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The list of virtual hard disk container uris." + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." - } - }, - "required": [ - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetOSProfile": { - "type": "object", - "properties": { - "computerNamePrefix": { + "publisher": { "type": "string", - "description": "The computer name prefix." + "description": "The name of the extension handler publisher." }, - "adminUsername": { - "type": "string", - "description": "The admin user name." + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." }, - "adminPassword": { + "type": { "type": "string", - "description": "The admin user password." + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." }, - "customData": { + "typeHandlerVersion": { "type": "string", - "description": "A base-64 encoded string of custom data." - }, - "windowsConfiguration": { + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineIdentity": { + "type": "object", + "properties": { + "type": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "type": "string", + "enum": [ + "SystemAssigned" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Windows Configuration of the OS profile." - }, - "linuxConfiguration": { + "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." + } + }, + "description": "Identity for the virtual machine." + }, + "VirtualMachineProperties": { + "type": "object", + "properties": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/LinuxConfiguration" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The Linux Configuration of the OS profile." + ] }, - "secrets": { + "diagnosticsProfile": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The List of certificates for addition to the VM." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetProperties": { - "type": "object", - "properties": { - "upgradePolicy": { + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Specifies the hardware settings for the virtual machine." }, - "virtualMachineProfile": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "$ref": "#/definitions/NetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "Specifies the network interfaces of the virtual machine." }, - "overprovision": { + "osProfile": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + "description": "Specifies the operating system settings for the virtual machine." }, - "singlePlacementGroup": { + "storageProfile": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + "description": "Specifies the storage settings for the virtual machine disks." } }, - "description": "Describes the properties of a Virtual Machine Scale Set." + "description": "Describes the properties of a Virtual Machine." }, - "VirtualMachineScaleSetStorageProfile": { + "VirtualMachineScaleSetDataDisk": { "type": "object", "properties": { - "imageReference": { + "caching": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The image reference." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "osDisk": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS disk." + "description": "The create option." }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The data disks." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set OS profile." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "storageProfile": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set storage profile." + "description": "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." }, - "networkProfile": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set network profile." + "description": "Describes the parameters of a ScaleSet managed disk." }, - "extensionProfile": { + "name": { + "type": "string", + "description": "The disk name." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set extension profile." + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, - "description": "Describes a virtual machine scale set virtual machine profile." + "description": "Describes a Virtual Machine Scale Set Extension." }, - "WindowsConfiguration": { + "VirtualMachineScaleSetExtensionProfile": { "type": "object", "properties": { - "provisionVMAgent": { + "extensions": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether the virtual machine agent should be provisioned on the Virtual Machine. If not specified, then the default behavior is to set it to true." - }, - "enableAutomaticUpdates": { + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { "oneOf": [ { "type": "boolean" @@ -2502,139 +2271,147 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether Windows updates are automatically installed on the VM." + "description": "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." }, - "timeZone": { + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { "type": "string", - "description": "The time zone of the VM" + "description": "The name of the extension handler publisher." }, - "additionalUnattendContent": { + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetIdentity": { + "type": "object", + "properties": { + "type": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } + "type": "string", + "enum": [ + "SystemAssigned" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Additional base-64 encoded XML formatted information that can be included in the Unattend.xml file." + "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" }, - "winRM": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/WinRMConfiguration" + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Windows Remote Management configuration of the VM" + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, - "description": "Describes Windows Configuration of the OS Profile." + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." }, - "WinRMConfiguration": { + "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "listeners": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { "type": "array", "items": { - "$ref": "#/definitions/WinRMListener" + "$ref": "#/definitions/SubResource" } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WinRMListener": { - "type": "object", - "properties": { - "protocol": { + "description": "The application gateway backend address pools." + }, + "loadBalancerBackendAddressPools": { "oneOf": [ { - "type": "string", - "enum": [ - "Http", - "Https" - ] + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Protocol used by the WinRM listener. Http and Https are supported." + "description": "The load balancer backend address pools." }, - "certificateUrl": { - "type": "string", - "description": "The Certificate URL in KMS for Https listeners. Should be null for Http listeners." - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - }, - "CreationData": { - "type": "object", - "properties": { - "createOption": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "type": "string", - "enum": [ - "Empty", - "Attach", - "FromImage", - "Import", - "Copy", - "Restore" - ] + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] - }, - "storageAccountId": { - "type": "string", - "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" + ], + "description": "The load balancer inbound nat pools." }, - "imageReference": { + "subnet": { "oneOf": [ { - "$ref": "#/definitions/ImageDiskReference" + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information." - }, - "sourceUri": { - "type": "string", - "description": "If creationOption is Import, this is a SAS URI to a blob to be imported into a managed disk. If creationOption is Copy, this is a relative Uri containing the id of the source snapshot to be copied into a managed disk." - }, - "sourceResourceId": { - "type": "string", - "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk. If creationOption is Restore, this is the ARM-like id of the source disk restore point." + "description": "The API entity reference." } }, "required": [ - "createOption" + "subnet" ], - "description": "Data used when creating a disk." + "description": "Describes a virtual machine scale set network profile's IP configuration properties." }, - "DiskProperties": { + "VirtualMachineScaleSetManagedDiskParameters": { "type": "object", "properties": { - "accountType": { + "storageAccountType": { "oneOf": [ { "type": "string", @@ -2647,2197 +2424,549 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "the storage account type of the disk." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" }, - "osType": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." - }, - "creationData": { + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "properties": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/CreationData" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "The virtual machine scale set IP Configuration." }, - "diskSizeGB": { + "primary": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." - }, - "encryptionSettings": { + "description": "Whether this is a primary NIC on a virtual machine." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "properties": { + "networkInterfaceConfigurations": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSettings" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption settings for disk or snapshot" + "description": "The list of network configurations." } }, - "required": [ - "creationData" - ], - "description": "Disk resource properties." + "description": "Describes a virtual machine scale set network profile." }, - "EncryptionSettings": { + "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "enabled": { + "caching": { "oneOf": [ { - "type": "boolean" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "diskEncryptionKey": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultAndSecretReference" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "keyEncryptionKey": { + "image": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultAndKeyReference" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Key Url and vault id of the key encryption key" - } - }, - "description": "Encryption settings for disk or snapshot" - }, - "ImageDiskReference": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A relative uri containing either a Platform Imgage Repository or user image reference." + "description": "Describes the uri of a disk." }, - "lun": { + "managedDisk": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." - } - }, - "required": [ - "id" - ], - "description": "The source image used for creating the disk." - }, - "KeyVaultAndKeyReference": { - "type": "object", - "properties": { - "sourceVault": { + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { - "$ref": "#/definitions/SourceVault" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" + "description": "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**." }, - "keyUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" - } - }, - "required": [ - "sourceVault", - "keyUrl" - ], - "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" - }, - "KeyVaultAndSecretReference": { - "type": "object", - "properties": { - "sourceVault": { + "vhdContainers": { "oneOf": [ { - "$ref": "#/definitions/SourceVault" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "secretUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The list of virtual hard disk container uris." } }, "required": [ - "sourceVault", - "secretUrl" + "createOption" ], - "description": "Key Vault Secret Url and vault id of the encryption key " + "description": "Describes a virtual machine scale set operating system disk." }, - "SourceVault": { + "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "id": { + "adminPassword": { "type": "string", - "description": "Resource Id" - } - }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" - }, - "genericExtension": { - "type": "object", - "properties": { - "publisher": { + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Publisher" + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "type": { + "computerNamePrefix": { "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Type" + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, - "typeHandlerVersion": { + "customData": { "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Type handler version" + "description": "A base-64 encoded string of custom data." }, - "settings": { + "linuxConfiguration": { "oneOf": [ - { "type": "object" }, - { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Microsoft.Compute/extensions - Settings" - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "settings" - ] - }, - "iaaSDiagnostics": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Diagnostics" - ] - }, - "type": { - "enum": [ - "IaaSDiagnostics" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "xmlCfg": { - "type": "string" - }, - "StorageAccount": { - "type": "string" - } - }, - "required": [ - "xmlCfg", - "StorageAccount" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - }, - "storageAccountEndPoint": { - "type": "string" - } - }, - "required": [ - "storageAccountName", - "storageAccountKey", - "storageAccountEndPoint" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "iaaSAntimalware": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Security" - ] - }, - "type": { - "enum": [ - "IaaSAntimalware" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "AntimalwareEnabled": { - "type": "boolean" - }, - "Exclusions": { - "type": "object", - "properties": { - "Paths": { - "type": "string" - }, - "Extensions": { - "type": "string" - }, - "Processes": { - "type": "string" - } - }, - "required": [ - "Paths", - "Extensions", - "Processes" - ] - }, - "RealtimeProtectionEnabled": { - "enum": [ - "true", - "false" - ] + { + "$ref": "#/definitions/LinuxConfiguration" }, - "ScheduledScanSettings": { - "type": "object", - "properties": { - "isEnabled": { - "enum": [ - "true", - "false" - ] - }, - "scanType": { - "type": "string" - }, - "day": { - "type": "string" - }, - "time": { - "type": "string" - } - }, - "required": [ - "isEnabled", - "scanType", - "day", - "time" - ] + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required": [ - "AntimalwareEnabled", - "Exclusions", - "RealtimeProtectionEnabled", - "ScheduledScanSettings" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "customScriptExtension": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Compute" - ] - }, - "type": { - "enum": [ - "CustomScriptExtension" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "settings": { - "type": "object", - "properties": { - "fileUris": { + "secrets": { + "oneOf": [ + { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/VaultSecretGroup" } }, - "commandToExecute": { - "type": "string" - } - }, - "required": [ - "commandToExecute" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - } - } - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "customScriptForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "CustomScriptForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "fileUris":{ - "type":"array", - "items":{ - "type":"string" - } + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - } + ], + "description": "The List of certificates for addition to the VM." }, - "protectedSettings":{ - "type":"object", - "properties":{ - "commandToExecute":{ - "type":"string" - }, - "storageAccountName":{ - "type":"string" + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" }, - "storageAccountKey":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "commandToExecute" - ] + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] + "description": "Describes a virtual machine scale set OS profile." }, - "linuxDiagnostic":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "LinuxDiagnostic" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "enableSyslog":{ - "type":"string" - }, - "mdsdHttpProxy":{ - "type":"string" - }, - "perCfg":{ - "type":"array" - }, - "fileCfg":{ - "type":"array" - }, - "xmlCfg":{ - "type":"string" - }, - "ladCfg":{ - "type":"object" - }, - "syslogCfg":{ - "type":"string" - }, - "eventVolume":{ - "type":"string" + "VirtualMachineScaleSetProperties": { + "type": "object", + "properties": { + "overProvision": { + "oneOf": [ + { + "type": "boolean" }, - "mdsdCfg":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - } + ], + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, - "protectedSettings":{ - "type":"object", - "properties":{ - "mdsdHttpProxy":{ - "type":"string" - }, - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" + "singlePlacementGroup": { + "oneOf": [ + { + "type": "boolean" }, - "storageAccountEndPoint":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "storageAccountName", - "storageAccountKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "vmAccessForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "VMAccessForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + ], + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "settings":{ - "type":"object", - "properties":{ - "check_disk":{ - "type":"boolean" + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UpgradePolicy" }, - "repair_disk":{ - "type":"boolean" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - } + ], + "description": "Describes an upgrade policy - automatic or manual." }, - "protectedSettings":{ - "type":"object", - "properties":{ - "username":{ - "type":"string" - }, - "password":{ - "type":"string" - }, - "ssh_key":{ - "type":"string" - }, - "reset_ssh":{ - "type":"string" - }, - "remove_user":{ - "type":"string" + "virtualMachineProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, - "expiration":{ - "type":"string" - } - }, - "required":[ - "username", - "password", - "ssh_key", - "reset_ssh", - "remove_user", - "expiration" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "bgInfo":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Compute" - ] - }, - "type":{ - "enum":[ - "bginfo" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] - }, - "vmAccessAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Compute" - ] - }, - "type":{ - "enum":[ - "VMAccessAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "username":{ - "type":"string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "password":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - } + ], + "description": "Describes a virtual machine scale set virtual machine profile." } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] + "description": "Describes the properties of a Virtual Machine Scale Set." }, - "dscExtension":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Powershell" - ] - }, - "type":{ - "enum":[ - "DSC" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "modulesUrl":{ - "type":"string" - }, - "configurationFunction":{ - "type":"string" - }, - "properties":{ - "type":"string" - }, - "wmfVersion":{ - "type":"string" - }, - "privacy":{ - "type":"object", - "properties":{ - "dataCollection":{ - "type":"string" - } + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" } - } - }, - "required":[ - "modulesUrl", - "configurationFunction" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "dataBlobUri":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "acronisBackupLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Acronis.Backup" - ] - }, - "type":{ - "enum":[ - "AcronisBackupLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "absURL":{ - "type":"string" - } - }, - "required": [ - "absURL" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "userLogin":{ - "type":"string" - }, - "userPassword":{ - "type":"string" - } - }, - "required": [ - "userLogin", - "userPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "acronisBackup":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Acronis.Backup" - ] - }, - "type":{ - "enum":[ - "AcronisBackup" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "absURL":{ - "type":"string" - } - }, - "required": [ - "absURL" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "userLogin":{ - "type":"string" - }, - "userPassword":{ - "type":"string" - } - }, - "required": [ - "userLogin", - "userPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "linuxChefClient":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Chef.Bootstrap.WindowsAzure" - ] - }, - "type":{ - "enum":[ - "LinuxChefClient" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "bootstrap_version":{ - "type":"string" - }, - "bootstrap_options":{ - "type":"object", - "properties":{ - "chef_node_name":{ - "type": "string" - }, - "chef_server_url":{ - "type": "string" - }, - "validation_client_name":{ - "type": "string" - }, - "node_ssl_verify_mode":{ - "type": "string" - }, - "environment":{ - "type": "string" - } - }, - "required": [ - "chef_node_name", - "chef_server_url", - "validation_client_name", - "node_ssl_verify_mode", - "environment" - ] - }, - "runlist":{ - "type": "string" - }, - "client_rb":{ - "type": "string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "validation_key":{ - "type":"string" - }, - "chef_server_crt":{ - "type":"string" - }, - "secret":{ - "type":"string" - } - }, - "required": [ - "validation_key", - "chef_server_crt", - "secret" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "chefClient":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Chef.Bootstrap.WindowsAzure" - ] - }, - "type":{ - "enum":[ - "ChefClient" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "bootstrap_options":{ - "type":"object", - "properties":{ - "chef_node_name":{ - "type": "string" - }, - "chef_server_url":{ - "type": "string" - }, - "validation_client_name":{ - "type": "string" - }, - "node_ssl_verify_mode":{ - "type": "string" - }, - "environment":{ - "type": "string" - } - }, - "required": [ - "chef_node_name", - "chef_server_url", - "validation_client_name", - "node_ssl_verify_mode", - "environment" - ] - }, - "runlist":{ - "type": "string" - }, - "client_rb":{ - "type": "string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "validation_key":{ - "type":"string" - }, - "chef_server_crt":{ - "type":"string" - }, - "secret":{ - "type":"string" - } - }, - "required": [ - "validation_key", - "chef_server_crt", - "secret" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "datadogLinuxAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Datadog.Agent" - ] - }, - "type":{ - "enum":[ - "DatadogLinuxAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "api_key":{ - "type": "string" - } - }, - "required": [ - "api_key" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "datadogWindowsAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Datadog.Agent" - ] - }, - "type":{ - "enum":[ - "DatadogWindowsAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "api_key":{ - "type": "string" - } - }, - "required": [ - "api_key" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "dockerExtension":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.Extensions" - ] - }, - "type":{ - "enum":[ - "DockerExtension" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "docker":{ - "type": "object", - "properties": { - "port":{ - "type":"string" - } - }, - "required": [ - "port" - ] - } - }, - "required": [ - "docker" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "certs":{ - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - } - }, - "required": [ - "ca", - "cert", - "key" - ] - } - }, - "required": [ - "certs" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "dynatraceLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "dynatrace.ruxit" - ] - }, - "type":{ - "enum":[ - "ruxitAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "tenantId":{ - "type": "string" }, - "token": { - "type": "string" - } - }, - "required": [ - "tenantId", - "token" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "dynatraceWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "dynatrace.ruxit" - ] - }, - "type":{ - "enum":[ - "ruxitAgentWindows" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "tenantId":{ - "type": "string" - }, - "token": { - "type": "string" - } - }, - "required": [ - "tenantId", - "token" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "eset":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "ESET" - ] - }, - "type":{ - "enum":[ - "FileSecurity" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "LicenseKey":{ - "type": "string" - }, - "Install-RealtimeProtection": { - "type": "boolean" - }, - "Install-ProtocolFiltering": { - "type": "boolean" - }, - "Install-DeviceControl": { - "type": "boolean" - }, - "Enable-Cloud": { - "type": "boolean" - }, - "Enable-PUA": { - "type": "boolean" - }, - "ERAAgentCfgUrl": { - "type": "string" - } - }, - "required": [ - "LicenseKey", - "Install-RealtimeProtection", - "Install-ProtocolFiltering", - "Install-DeviceControl", - "Enable-Cloud", - "Enable-PUA", - "ERAAgentCfgUrl" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "hpeSecurityApplicationDefender":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "HPE.Security.ApplicationDefender" - ] - }, - "type":{ - "enum":[ - "DotnetAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "key": { - "type": "string" - }, - "serverURL": { - "type": "string" - } - }, - "required": [ - "key", - "serverURL" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "protectedSettings" - ] - }, - "puppetAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Puppet" - ] - }, - "type":{ - "enum":[ - "PuppetAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "PUPPET_MASTER_SERVER": { - "type": "string" - } - }, - "required": [ - "PUPPET_MASTER_SERVER" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "protectedSettings" - ] - }, - "site24x7LinuxServerExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7LinuxServerExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnlinuxserver" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "site24x7WindowsServerExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7WindowsServerExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnwindowsserver" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "site24x7ApmInsightExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7ApmInsightExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnapminsightclassic" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "trendMicroDSALinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "TrendMicro.DeepSecurity" - ] - }, - "type":{ - "enum":[ - "TrendMicroDSALinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + ], + "description": "The data disks." }, - "settings":{ - "type": "object", - "properties": { - "DSMname": { - "type": "string" - }, - "DSMport": { - "type": "string" + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" }, - "policyNameorID": { - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required": [ - "DSMname", - "DSMport" - ] + ], + "description": "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." }, - "protectedSettings":{ - "type":"object", - "properties":{ - "tenantID": { - "type": "string" + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" }, - "tenantPassword": { - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required": [ - "tenantID", - "tenantPassword" - ] + ], + "description": "Describes a virtual machine scale set operating system disk." } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] + "description": "Describes a virtual machine scale set storage profile." }, - "trendMicroDSA":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "TrendMicro.DeepSecurity" - ] - }, - "type":{ - "enum":[ - "TrendMicroDSA" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties": { - "DSMname": { - "type": "string" - }, - "DSMport": { - "type": "string" + "VirtualMachineScaleSetVMProfile": { + "type": "object", + "properties": { + "extensionProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, - "policyNameorID": { - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required": [ - "DSMname", - "DSMport" - ] + ], + "description": "Describes a virtual machine scale set extension profile." }, - "protectedSettings":{ - "type":"object", - "properties":{ - "tenantID": { - "type": "string" + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" }, - "tenantPassword": { - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required": [ - "tenantID", - "tenantPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "bmcCtmAgentLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "ctm.bmc.com" - ] - }, - "type":{ - "enum":[ - "BmcCtmAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + ], + "description": "Describes a virtual machine scale set network profile." }, - "settings":{ - "type": "object", - "properties":{ - "Control-M Server Name":{ - "type": "string" - }, - "Agent Port":{ - "type": "string" + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, - "Host Group":{ - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set OS profile." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, - "User Account":{ - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "Control-M Server Name", - "Agent Port", - "Host Group", - "User Account" - ] + ], + "description": "Describes a virtual machine scale set storage profile." } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] + "description": "Describes a virtual machine scale set virtual machine profile." }, - "bmcCtmAgentWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "bmc.ctm" - ] - }, - "type":{ - "enum":[ - "AgentWinExt" + "virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2016-04-30-preview" ] }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 + "location": { + "type": "string", + "description": "Resource location" }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + "name": { + "type": "string", + "description": "The name of the virtual machine extension." }, - "settings":{ - "type": "object", - "properties":{ - "Control-M Server Name":{ - "type": "string" + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, - "Agent Port":{ - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, - "Host Group":{ - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "Control-M Server Name", - "Agent Port", - "Host Group" + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" ] } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" }, - "OSPatchingForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "OSPatchingForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "disabled":{ - "type":"boolean" - }, - "stop":{ - "type":"boolean" - }, - "installDuration":{ - "type":"string" - }, - "intervalOfWeeks":{ - "type":"number" - }, - "dayOfWeek":{ - "type":"string" - }, - "startTime":{ - "type":"string" - }, - "rebootAfterPatch":{ - "type":"string" - }, - "category":{ - "type":"string" - }, - "oneoff":{ - "type":"boolean" - }, - "local":{ - "type":"boolean" - }, - "idleTestScript":{ - "type":"string" - }, - "healthyTestScript":{ - "type":"string" - }, - "distUpgradeList":{ - "type":"string" - }, - "distUpgradeAll":{ - "type":"boolean" + "WindowsConfiguration": { + "type": "object", + "properties": { + "additionalUnattendContent": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } }, - "vmStatusTest":{ - "type":"object" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "disabled", - "stop" - ] + ], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, - "protectedSettings":{ - "type":"object", - "properties":{ - "storageAccountName":{ - "type":"string" + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" }, - "storageAccountKey":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "VMSnapshot":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.RecoveryServices" - ] - }, - "type":{ - "enum":[ - "VMSnapshot" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + ], + "description": "Indicates whether virtual machine is enabled for automatic updates." }, - "settings":{ - "type":"object", - "properties":{ - "locale":{ - "type":"string" - }, - "taskId":{ - "type":"string" - }, - "commandToExecute":{ - "type":"string" - }, - "objectStr":{ - "type":"string" - }, - "logsBlobUri":{ - "type":"string" - }, - "statusBlobUri":{ - "type":"string" - }, - "commandStartTimeUTCTicks":{ - "type":"string" + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" }, - "vmType":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "locale", - "taskId", - "commandToExecute", - "objectStr", - "logsBlobUri", - "statusBlobUri", - "commandStartTimeUTCTicks", - "vmType" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "VMSnapshotLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.RecoveryServices" - ] - }, - "type":{ - "enum":[ - "VMSnapshotLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 + ], + "description": "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." }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" }, - "settings":{ - "type":"object", - "properties":{ - "locale":{ - "type":"string" - }, - "taskId":{ - "type":"string" - }, - "commandToExecute":{ - "type":"string" - }, - "objectStr":{ - "type":"string" - }, - "logsBlobUri":{ - "type":"string" - }, - "statusBlobUri":{ - "type":"string" - }, - "commandStartTimeUTCTicks":{ - "type":"string" + "winRM": { + "oneOf": [ + { + "$ref": "#/definitions/WinRMConfiguration" }, - "vmType":{ - "type":"string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required":[ - "locale", - "taskId", - "commandToExecute", - "objectStr", - "logsBlobUri", - "statusBlobUri", - "commandStartTimeUTCTicks", - "vmType" - ] + ], + "description": "Describes Windows Remote Management configuration of the VM" } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] + "description": "Specifies Windows operating system settings on the virtual machine." }, - "customScript": { + "WinRMConfiguration": { "type": "object", "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Extensions" - ] - }, - "type": { - "enum": [ - "CustomScript" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "fileUris": { + "listeners": { + "oneOf": [ + { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/WinRMListener" } - } - }, - "required": [ - "fileUris" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" }, - "commandToExecute": { - "type": "string" + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - }, - "required": [ - "storageAccountName", - "storageAccountKey", - "commandToExecute" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "networkWatcherAgentWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.NetworkWatcher" - ] - }, - "type":{ - "enum":[ - "NetworkWatcherAgentWindows" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + ], + "description": "The list of Windows Remote Management listeners" } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] + "description": "Describes Windows Remote Management configuration of the VM" }, - "networkWatcherAgentLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.NetworkWatcher" - ] - }, - "type":{ - "enum":[ - "NetworkWatcherAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 + "WinRMListener": { + "type": "object", + "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" }, - "autoUpgradeMinorVersion":{ - "type":"boolean" + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Http", + "Https" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." } }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" } } } diff --git a/schemas/2016-09-30/Microsoft.ContainerService.json b/schemas/2016-09-30/Microsoft.ContainerService.json index 6f3f984e1b..cd1ac4b78a 100644 --- a/schemas/2016-09-30/Microsoft.ContainerService.json +++ b/schemas/2016-09-30/Microsoft.ContainerService.json @@ -485,4 +485,4 @@ "description": "Profile for Windows VMs in the container service cluster." } } -} \ No newline at end of file +} diff --git a/schemas/2017-01-31/Microsoft.ContainerService.json b/schemas/2017-01-31/Microsoft.ContainerService.json index 8ccbce5934..29e2c1b5c5 100644 --- a/schemas/2017-01-31/Microsoft.ContainerService.json +++ b/schemas/2017-01-31/Microsoft.ContainerService.json @@ -485,4 +485,4 @@ "description": "Profile for Windows VMs in the container service cluster." } } -} \ No newline at end of file +} diff --git a/schemas/2017-03-30/Microsoft.Compute.json b/schemas/2017-03-30/Microsoft.Compute.json index bced14de7a..86d979a2be 100644 --- a/schemas/2017-03-30/Microsoft.Compute.json +++ b/schemas/2017-03-30/Microsoft.Compute.json @@ -7,15 +7,6 @@ "availabilitySets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -26,64 +17,66 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/AvailabilitySetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The instance view of a resource." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/AvailabilitySetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set" + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/availabilitySets" }, "disks": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the disk within the given subscription and resource group." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/disks" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -94,19 +87,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DiskProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Disk resource properties." }, "sku": { "oneOf": [ @@ -116,54 +110,57 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Logical zone list for Disk." + "description": "Resource tags" }, - "properties": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { "oneOf": [ { - "$ref": "#/definitions/DiskProperties" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Logical zone list for Disk." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/disks" }, "images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -174,53 +171,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of an Image." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/images" }, "snapshots": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the snapshot within the given subscription and resource group." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/snapshots" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -231,19 +230,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DiskProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Disk resource properties." }, "sku": { "oneOf": [ @@ -253,63 +253,67 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/DiskProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/snapshots" }, "virtualMachines": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ "2017-03-30" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." }, "plan": { "oneOf": [ @@ -320,7 +324,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The purchase plan when deploying virtual machine from VM Marketplace images." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "oneOf": [ @@ -330,18 +334,39 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine." }, - "identity": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] }, "zones": { "oneOf": [ @@ -356,170 +381,108 @@ } ], "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/extensionsChild" - } - ] - } } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachines" }, - "extensions": { + "virtualMachineScaleSets": { "type": "object", "properties": { - "type": { - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, "apiVersion": { + "type": "string", "enum": [ "2017-03-30" ] }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, "location": { "type": "string", "description": "Resource location" }, - "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} - ] - } - }, - "required": [ - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "virtualMachineScaleSets": { - "type": "object", - "properties": { "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-03-30" - ] - }, - "location": { "type": "string", - "description": "Resource location" + "description": "The name of the VM scale set to create or update." }, - "tags": { + "plan": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "sku": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "$ref": "#/definitions/VirtualMachineScaleSetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set sku." + "description": "Describes the properties of a Virtual Machine Scale Set." }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + } + ] + } }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku." }, - "identity": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine scale set, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] }, "zones": { "oneOf": [ @@ -533,128 +496,152 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/extensionsChild" - } - ] - } + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets" - } - }, - "definitions": { - "extensionsChild": { + }, + "virtualMachineScaleSets_extensions": { "type": "object", "properties": { - "type": { + "apiVersion": { + "type": "string", "enum": [ - "extensions" + "2017-03-30" ] }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { "apiVersion": { + "type": "string", "enum": [ "2017-03-30" ] }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" ] } }, "required": [ - "type", "apiVersion", + "location", + "name", "properties", - "location" + "type" ], - "description": "Microsoft.Compute/extensionsChild" - }, + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { "AdditionalUnattendContent": { "type": "object", "properties": { - "passName": { + "componentName": { "oneOf": [ { "type": "string", "enum": [ - "oobeSystem" + "Microsoft-Windows-Shell-Setup" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is oobeSystem." + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." }, - "componentName": { + "content": { + "type": "string", + "description": "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." + }, + "passName": { "oneOf": [ { "type": "string", "enum": [ - "Microsoft-Windows-Shell-Setup" + "OobeSystem" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "The pass name. Currently, the only allowable value is OobeSystem." }, "settingName": { "oneOf": [ @@ -669,21 +656,17 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Setting name (e.g. FirstLogonCommands, AutoLogon )." - }, - "content": { - "type": "string", - "description": "XML formatted content that is added to the unattend.xml file in the specified pass and component. The XML must be less than 4 KB and must include the root element for the setting or feature that is being inserted." + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." } }, - "description": "Additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is a applied." + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." }, "ApiEntityReference": { "type": "object", "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -691,7 +674,7 @@ "AvailabilitySetProperties": { "type": "object", "properties": { - "platformUpdateDomainCount": { + "platformFaultDomainCount": { "oneOf": [ { "type": "integer" @@ -700,9 +683,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Update Domain count." + "description": "Fault Domain count." }, - "platformFaultDomainCount": { + "platformUpdateDomainCount": { "oneOf": [ { "type": "integer" @@ -711,7 +694,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count." + "description": "Update Domain count." }, "virtualMachines": { "oneOf": [ @@ -746,10 +729,10 @@ }, "storageUri": { "type": "string", - "description": "URI of the storage account to use for placing the console output and screenshot." + "description": "Uri of the storage account to use for placing the console output and screenshot." } }, - "description": "Describes Boot Diagnostics." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." }, "CreationData": { "type": "object", @@ -772,10 +755,6 @@ ], "description": "This enumerates the possible sources of a disk's creation." }, - "storageAccountId": { - "type": "string", - "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" - }, "imageReference": { "oneOf": [ { @@ -785,15 +764,19 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information." + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." }, "sourceUri": { "type": "string", - "description": "If creationOption is Import, this is the URI of a blob to be imported into a managed disk." + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." }, - "sourceResourceId": { + "storageAccountId": { "type": "string", - "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" } }, "required": [ @@ -804,101 +787,101 @@ "DataDisk": { "type": "object", "properties": { - "lun": { + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The logical unit number." - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "vhd": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source user image virtual hard disk. This virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "Describes the uri of a disk." }, - "createOption": { + "lun": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "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." }, - "diskSizeGB": { + "managedDisk": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial disk size in GB for blank data disks, and the new desired size for resizing existing OS and data disks." + "description": "The parameters of a managed disk." }, - "managedDisk": { + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the uri of a disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a data disk." }, @@ -914,10 +897,10 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Boot Diagnostics is a debugging feature which allows the user to view console output and/or a screenshot of the virtual machine from the hypervisor." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." } }, - "description": "Describes a diagnostics profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, "DiskEncryptionSettings": { "type": "object", @@ -931,29 +914,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The disk encryption key which is a Key Vault Secret." + "description": "Describes a reference to Key Vault Secret" }, - "keyEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The key encryption key which is Key Vault Key." + "description": "Specifies whether disk encryption should be enabled on the virtual machine." }, - "enabled": { + "keyEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "Describes a reference to Key Vault Key" } }, "description": "Describes a Encryption Settings for a Disk" @@ -961,21 +944,6 @@ "DiskProperties": { "type": "object", "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The Operating System type." - }, "creationData": { "oneOf": [ { @@ -985,7 +953,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "Data used when creating a disk." }, "diskSizeGB": { "oneOf": [ @@ -1008,6 +976,21 @@ } ], "description": "Encryption settings for disk or snapshot" + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." } }, "required": [ @@ -1039,27 +1022,27 @@ "EncryptionSettings": { "type": "object", "properties": { - "enabled": { + "diskEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultAndSecretReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + "description": "Key Vault Secret Url and vault id of the encryption key " }, - "diskEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultAndSecretReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." }, "keyEncryptionKey": { "oneOf": [ @@ -1070,7 +1053,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Key Url and vault id of the key encryption key" + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" } }, "description": "Encryption settings for disk or snapshot" @@ -1186,77 +1169,75 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine size name." + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)." } }, - "description": "Describes a hardware profile." + "description": "Specifies the hardware settings for the virtual machine." }, "ImageDataDisk": { "type": "object", "properties": { - "lun": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The logical unit number." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "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." }, - "caching": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The caching type." + ] }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + ] }, "storageAccountType": { "oneOf": [ @@ -1271,7 +1252,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "required": [ @@ -1284,7 +1265,7 @@ "properties": { "id": { "type": "string", - "description": "A relative uri containing either a Platform Imgage Repository or user image reference." + "description": "A relative uri containing either a Platform Image Repository or user image reference." }, "lun": { "oneOf": [ @@ -1306,37 +1287,38 @@ "ImageOSDisk": { "type": "object", "properties": { - "osType": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "osState": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "snapshot": { + "managedDisk": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -1344,50 +1326,47 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The snapshot." + ] }, - "managedDisk": { + "osState": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "The OS State." }, - "caching": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The initial managed disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + ] }, "storageAccountType": { "oneOf": [ @@ -1402,12 +1381,12 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "required": [ - "osType", - "osState" + "osState", + "osType" ], "description": "Describes an Operating System disk." }, @@ -1422,8 +1401,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The source virtual machine from which Image is created." + ] }, "storageProfile": { "oneOf": [ @@ -1434,7 +1412,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The storage profile." + "description": "Describes a storage profile." } }, "description": "Describes the properties of an Image." @@ -1446,13 +1424,13 @@ "type": "string", "description": "Resource Id" }, - "publisher": { + "offer": { "type": "string", - "description": "The image publisher." + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, - "offer": { + "publisher": { "type": "string", - "description": "The image offer." + "description": "The image publisher." }, "sku": { "type": "string", @@ -1460,38 +1438,38 @@ }, "version": { "type": "string", - "description": "The image version. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor and Build are decimal numbers. Specify 'latest' to use the latest version of the image." + "description": "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." } }, - "description": "The image reference." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, "ImageStorageProfile": { "type": "object", "properties": { - "osDisk": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageOSDisk" + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS disk." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } + "$ref": "#/definitions/ImageOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The data disks." + "description": "Describes an Operating System disk." } }, "required": [ @@ -1506,6 +1484,10 @@ "type": "string", "description": "The status code." }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, "level": { "oneOf": [ { @@ -1522,10 +1504,6 @@ ], "description": "The level code." }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." @@ -1541,6 +1519,10 @@ "KeyVaultAndKeyReference": { "type": "object", "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, "sourceVault": { "oneOf": [ { @@ -1550,22 +1532,22 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "keyUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, "required": [ - "sourceVault", - "keyUrl" + "keyUrl", + "sourceVault" ], "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" }, "KeyVaultAndSecretReference": { "type": "object", "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, "sourceVault": { "oneOf": [ { @@ -1575,16 +1557,12 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "secretUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, "required": [ - "sourceVault", - "secretUrl" + "secretUrl", + "sourceVault" ], "description": "Key Vault Secret Url and vault id of the encryption key " }, @@ -1593,7 +1571,7 @@ "properties": { "keyUrl": { "type": "string", - "description": "The URL referencing a key in a Key Vault." + "description": "The URL referencing a key encryption key in Key Vault." }, "sourceVault": { "oneOf": [ @@ -1603,8 +1581,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the key." + ] } }, "required": [ @@ -1628,8 +1605,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the secret." + ] } }, "required": [ @@ -1661,10 +1637,10 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The SSH configuration for linux VMs." + "description": "SSH configuration for Linux based VMs running on Azure" } }, - "description": "Describes Windows configuration of the OS Profile." + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, "ManagedDiskParameters": { "type": "object", @@ -1686,7 +1662,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "description": "The parameters of a managed disk." @@ -1706,7 +1682,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a network interface reference properties." } }, "description": "Describes a network interface reference." @@ -1743,54 +1720,67 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the list of resource IDs for the network interfaces associated with the virtual machine." + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." } }, - "description": "Describes a network profile." + "description": "Specifies the network interfaces of the virtual machine." }, "OSDisk": { "type": "object", "properties": { - "osType": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The disk encryption settings." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "name": { - "type": "string", - "description": "The disk name." + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" }, - "vhd": { + "encryptionSettings": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Describes a Encryption Settings for a Disk" }, "image": { "oneOf": [ @@ -1801,125 +1791,112 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before using it to attach to the virtual machine. If SourceImage is provided, the destination virtual hard disk must not exist." + "description": "Describes the uri of a disk." }, - "caching": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "The parameters of a managed disk." }, - "createOption": { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "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**." }, - "diskSizeGB": { + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial disk size, in GB, for blank data disks, and the new desired size for resizing existing OS and data disks." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ManagedDiskParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The managed disk parameters." + "description": "Describes the uri of a disk." } }, "required": [ "createOption" ], - "description": "Describes an Operating System disk." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, "OSProfile": { "type": "object", "properties": { - "computerName": { + "adminPassword": { "type": "string", - "description": "Specifies the host OS name of the virtual machine." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", - "description": "Specifies the name of the administrator account." + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerName": { "type": "string", - "description": "Specifies the password of the administrator account." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "customData": { "type": "string", - "description": "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" + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { + "linuxConfiguration": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "$ref": "#/definitions/LinuxConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Windows configuration of the OS profile." + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "linuxConfiguration": { + "secrets": { "oneOf": [ { - "$ref": "#/definitions/LinuxConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Linux configuration of the OS profile." + "description": "Specifies set of certificates that should be installed onto the virtual machine." }, - "secrets": { + "windowsConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The list of certificates for addition to the VM." + "description": "Specifies Windows operating system settings on the virtual machine." } }, - "description": "Describes an OS profile." + "description": "Specifies the operating system settings for the virtual machine." }, "Plan": { "type": "object", @@ -1928,32 +1905,73 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", - "description": "The offer ID." + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." }, "promotionCode": { "type": "string", "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, - "description": "Plan for the resource." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "Sku": { + "RollingUpgradePolicy": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The sku name." + "maxBatchInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." }, - "tier": { - "type": "string", - "description": "The sku tier." + "maxUnhealthyInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "Sku": { + "type": "object", + "properties": { "capacity": { "oneOf": [ { @@ -1963,7 +1981,15 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The sku capacity." + "description": "Specifies the number of virtual machines in the scale set. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" } }, "description": "Describes a virtual machine scale set sku." @@ -1976,7 +2002,7 @@ "description": "Resource Id" } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "SshConfiguration": { "type": "object", @@ -2001,13 +2027,13 @@ "SshPublicKey": { "type": "object", "properties": { - "path": { + "keyData": { "type": "string", - "description": "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." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "keyData": { + "path": { "type": "string", - "description": "Certificate public key used to authenticate to the VM through SSH. The certificate must be in Pem format with or without headers." + "description": "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" } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -2015,44 +2041,44 @@ "StorageProfile": { "type": "object", "properties": { - "imageReference": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The image reference." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "osDisk": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS disk." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The data disks." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, - "description": "Describes a storage profile." + "description": "Specifies the storage settings for the virtual machine disks." }, "SubResource": { "type": "object", @@ -2066,34 +2092,57 @@ "UpgradePolicy": { "type": "object", "properties": { + "automaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + }, "mode": { "oneOf": [ { "type": "string", "enum": [ "Automatic", - "Manual" + "Manual", + "Rolling" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade mode." + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + }, + "rollingUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/RollingUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used while performing a rolling upgrade." } }, - "description": "Describes an upgrade policy - automatic or manual." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, "VaultCertificate": { "type": "object", "properties": { - "certificateUrl": { + "certificateStore": { "type": "string", - "description": "The URL referencing a secret in a Key Vault which contains a properly formatted certificate." + "description": "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." }, - "certificateStore": { + "certificateUrl": { "type": "string", - "description": "The Certificate store in LocalMachine to add the certificate to on Windows, leave empty on Linux." + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -2109,8 +2158,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The Relative URL of the Key Vault containing all of the certificates in VaultCertificates." + ] }, "vaultCertificates": { "oneOf": [ @@ -2134,7 +2182,7 @@ "properties": { "uri": { "type": "string", - "description": "The virtual hard disk's URI. Must be a valid URI to a virtual hard disk." + "description": "Specifies the virtual hard disk's uri." } }, "description": "Describes the uri of a disk." @@ -2146,15 +2194,7 @@ "type": "string", "description": "The virtual machine extension name." }, - "type": { - "type": "string", - "description": "The full type of the extension handler which includes both publisher and type." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, - "substatuses": { + "statuses": { "oneOf": [ { "type": "array", @@ -2168,7 +2208,7 @@ ], "description": "The resource status information." }, - "statuses": { + "substatuses": { "oneOf": [ { "type": "array", @@ -2181,6 +2221,14 @@ } ], "description": "The resource status information." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "The instance view of a virtual machine extension." @@ -2188,22 +2236,6 @@ "VirtualMachineExtensionProperties": { "type": "object", "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "The type of the extension handler." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, "autoUpgradeMinorVersion": { "oneOf": [ { @@ -2213,13 +2245,11 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether the extension handler should be automatically upgraded across minor versions." - }, - "settings": { - "description": "Json formatted public settings for the extension." + "description": "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." }, - "protectedSettings": { - "description": "Json formatted protected settings for the extension." + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." }, "instanceView": { "oneOf": [ @@ -2230,7 +2260,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine extension instance view." + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -2239,9 +2291,16 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." } @@ -2251,38 +2310,41 @@ "VirtualMachineProperties": { "type": "object", "properties": { - "hardwareProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The hardware profile." + ] }, - "storageProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The storage profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS profile." + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -2293,33 +2355,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network profile." + "description": "Specifies the network interfaces of the virtual machine." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The diagnostics profile." + "description": "Specifies the operating system settings for the virtual machine." }, - "availabilitySet": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The reference Id of the availability set to which the virtual machine belongs." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system." + "description": "Specifies the storage settings for the virtual machine disks." } }, "description": "Describes the properties of a Virtual Machine." @@ -2327,21 +2385,6 @@ "VirtualMachineScaleSetDataDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The logical unit number." - }, "caching": { "oneOf": [ { @@ -2356,7 +2399,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, "createOption": { "oneOf": [ @@ -2383,7 +2426,18 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." }, "managedDisk": { "oneOf": [ @@ -2394,12 +2448,16 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a virtual machine scale set data disk." }, @@ -2418,7 +2476,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, "description": "Describes a Virtual Machine Scale Set Extension." @@ -2446,22 +2505,6 @@ "VirtualMachineScaleSetExtensionProperties": { "type": "object", "properties": { - "forceUpdateTag": { - "type": "string", - "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "The type of the extension handler." - }, - "typeHandlerVersion": { - "type": "string", - "description": "The type version of the extension handler." - }, "autoUpgradeMinorVersion": { "oneOf": [ { @@ -2471,13 +2514,33 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether the extension handler should be automatically upgraded across minor versions." + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." }, "settings": { + "type": "object", + "properties": {}, "description": "Json formatted public settings for the extension." }, - "protectedSettings": { - "description": "Json formatted protected settings for the extension." + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." @@ -2486,9 +2549,16 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity." } @@ -2514,7 +2584,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, "required": [ @@ -2525,95 +2596,95 @@ "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "subnet": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/ApiEntityReference" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The subnet." + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, - "primary": { + "loadBalancerBackendAddressPools": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." }, - "publicIPAddressConfiguration": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The publicIPAddressConfiguration." + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" }, - "privateIPAddressVersion": { + "primary": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, - "applicationGatewayBackendAddressPools": { + "privateIPAddressVersion": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The application gateway backend address pools." + "description": "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'." }, - "loadBalancerBackendAddressPools": { + "publicIPAddressConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The load balancer backend address pools." + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "loadBalancerInboundNatPools": { + "subnet": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The load balancer inbound nat pools." + "description": "The API entity reference." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -2634,7 +2705,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Storage Account type." + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS." } }, "description": "Describes the parameters of a ScaleSet managed disk." @@ -2658,7 +2729,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." } }, "required": [ @@ -2689,16 +2761,16 @@ "VirtualMachineScaleSetNetworkConfigurationProperties": { "type": "object", "properties": { - "primary": { + "dnsSettings": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether this is a primary NIC on a virtual machine." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "enableAcceleratedNetworking": { "oneOf": [ @@ -2711,41 +2783,40 @@ ], "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "networkSecurityGroup": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network security group." + "description": "Specifies the IP configurations of the network interface." }, - "dnsSettings": { + "networkSecurityGroup": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The dns settings to be applied on the network interfaces." + ] }, - "ipConfigurations": { + "primary": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set IP Configuration." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." } }, "required": [ @@ -2756,6 +2827,17 @@ "VirtualMachineScaleSetNetworkProfile": { "type": "object", "properties": { + "healthProbe": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + }, "networkInterfaceConfigurations": { "oneOf": [ { @@ -2776,10 +2858,6 @@ "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, "caching": { "oneOf": [ { @@ -2794,7 +2872,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The caching type." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, "createOption": { "oneOf": [ @@ -2810,58 +2888,62 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "osType": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Describes the uri of a disk." }, - "image": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + "description": "Describes the parameters of a ScaleSet managed disk." }, - "vhdContainers": { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The list of virtual hard disk container uris." + "description": "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**." }, - "managedDisk": { + "vhdContainers": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies the container urls that are used to store operating system disks for the scale set." } }, "required": [ @@ -2872,57 +2954,57 @@ "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "computerNamePrefix": { + "adminPassword": { "type": "string", - "description": "The computer name prefix." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", - "description": "The admin user name." + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerNamePrefix": { "type": "string", - "description": "The admin user password." + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "customData": { "type": "string", - "description": "A base-64 encoded string of custom data." + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { + "linuxConfiguration": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "$ref": "#/definitions/LinuxConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Windows Configuration of the OS profile." + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "linuxConfiguration": { + "secrets": { "oneOf": [ { - "$ref": "#/definitions/LinuxConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Linux Configuration of the OS profile." + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." }, - "secrets": { + "windowsConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The List of certificates for addition to the VM." + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Describes a virtual machine scale set OS profile." @@ -2930,49 +3012,49 @@ "VirtualMachineScaleSetProperties": { "type": "object", "properties": { - "upgradePolicy": { + "overprovision": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, - "virtualMachineProfile": { + "singlePlacementGroup": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "overprovision": { + "upgradePolicy": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/UpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "singlePlacementGroup": { + "virtualMachineProfile": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + "description": "Describes a virtual machine scale set virtual machine profile." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -2992,7 +3074,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" } }, "required": [ @@ -3016,88 +3099,58 @@ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "type": "object", "properties": { - "idleTimeoutInMinutes": { + "dnsSettings": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The idle timeout of the public IP address." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, - "dnsSettings": { + "idleTimeoutInMinutes": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the publicIP addresses ." + "description": "The idle timeout of the public IP address." } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "virtualMachineScaleSets_extensions_childResource": { + "VirtualMachineScaleSetStorageProfile": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { + "dataDisks": { "oneOf": [ { - "type": "string", - "enum": [ - "2017-03-30" - ] + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "properties": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, - "VirtualMachineScaleSetStorageProfile": { - "type": "object", - "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The image reference." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, "osDisk": { "oneOf": [ @@ -3108,49 +3161,78 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS disk." + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2017-03-30" + ] }, - "dataDisks": { + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The data disks." + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] } }, - "description": "Describes a virtual machine scale set storage profile." + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "osProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set OS profile." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "storageProfile": { + "extensionProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set storage profile." + "description": "Describes a virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -3161,66 +3243,95 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set network profile." + "description": "Describes a virtual machine scale set network profile." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set diagnostics profile." + "description": "Describes a virtual machine scale set OS profile." }, - "extensionProfile": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set extension profile." - }, - "licenseType": { - "type": "string", - "description": "The license type, which is for bring your own license scenario." + "description": "Describes a virtual machine scale set storage profile." } }, "description": "Describes a virtual machine scale set virtual machine profile." }, - "WindowsConfiguration": { + "virtualMachines_extensions_childResource": { "type": "object", "properties": { - "provisionVMAgent": { + "apiVersion": { + "type": "string", + "enum": [ + "2017-03-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether the virtual machine agent should be provisioned on the Virtual Machine. If not specified, then the default behavior is to set it to true." + "description": "Describes the properties of a Virtual Machine Extension." }, - "enableAutomaticUpdates": { + "tags": { "oneOf": [ { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether Windows updates are automatically installed on the VM." + "description": "Resource tags" }, - "timeZone": { + "type": { "type": "string", - "description": "The time zone of the VM" - }, + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { "additionalUnattendContent": { "oneOf": [ { @@ -3233,7 +3344,33 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Additional base-64 encoded XML formatted information that can be included in the Unattend.xml file." + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" }, "winRM": { "oneOf": [ @@ -3244,10 +3381,10 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Windows Remote Management configuration of the VM" + "description": "Describes Windows Remote Management configuration of the VM" } }, - "description": "Describes Windows Configuration of the OS Profile." + "description": "Specifies Windows operating system settings on the virtual machine." }, "WinRMConfiguration": { "type": "object", @@ -3272,6 +3409,10 @@ "WinRMListener": { "type": "object", "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, "protocol": { "oneOf": [ { @@ -3285,2027 +3426,10 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Protocol used by the WinRM listener. Http and Https are supported." - }, - "certificateUrl": { - "type": "string", - "description": "The Certificate URL in KMS for Https listeners. Should be null for Http listeners." + "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - }, - "genericExtension": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Publisher" - }, - "type": { - "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Type" - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Type handler version" - }, - "settings": { - "oneOf": [ - { "type": "object" }, - { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Microsoft.Compute/extensions - Settings" - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "settings" - ] - }, - "iaaSDiagnostics": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Diagnostics" - ] - }, - "type": { - "enum": [ - "IaaSDiagnostics" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "xmlCfg": { - "type": "string" - }, - "StorageAccount": { - "type": "string" - } - }, - "required": [ - "xmlCfg", - "StorageAccount" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - }, - "storageAccountEndPoint": { - "type": "string" - } - }, - "required": [ - "storageAccountName", - "storageAccountKey", - "storageAccountEndPoint" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "iaaSAntimalware": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Security" - ] - }, - "type": { - "enum": [ - "IaaSAntimalware" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "AntimalwareEnabled": { - "type": "boolean" - }, - "Exclusions": { - "type": "object", - "properties": { - "Paths": { - "type": "string" - }, - "Extensions": { - "type": "string" - }, - "Processes": { - "type": "string" - } - }, - "required": [ - "Paths", - "Extensions", - "Processes" - ] - }, - "RealtimeProtectionEnabled": { - "enum": [ - "true", - "false" - ] - }, - "ScheduledScanSettings": { - "type": "object", - "properties": { - "isEnabled": { - "enum": [ - "true", - "false" - ] - }, - "scanType": { - "type": "string" - }, - "day": { - "type": "string" - }, - "time": { - "type": "string" - } - }, - "required": [ - "isEnabled", - "scanType", - "day", - "time" - ] - } - }, - "required": [ - "AntimalwareEnabled", - "Exclusions", - "RealtimeProtectionEnabled", - "ScheduledScanSettings" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "customScriptExtension": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Compute" - ] - }, - "type": { - "enum": [ - "CustomScriptExtension" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "fileUris": { - "type": "array", - "items": { - "type": "string" - } - }, - "commandToExecute": { - "type": "string" - } - }, - "required": [ - "commandToExecute" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - } - } - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "customScriptForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "CustomScriptForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "fileUris":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "commandToExecute":{ - "type":"string" - }, - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" - } - }, - "required":[ - "commandToExecute" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "linuxDiagnostic":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "LinuxDiagnostic" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "enableSyslog":{ - "type":"string" - }, - "mdsdHttpProxy":{ - "type":"string" - }, - "perCfg":{ - "type":"array" - }, - "fileCfg":{ - "type":"array" - }, - "xmlCfg":{ - "type":"string" - }, - "ladCfg":{ - "type":"object" - }, - "syslogCfg":{ - "type":"string" - }, - "eventVolume":{ - "type":"string" - }, - "mdsdCfg":{ - "type":"string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "mdsdHttpProxy":{ - "type":"string" - }, - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" - }, - "storageAccountEndPoint":{ - "type":"string" - } - }, - "required":[ - "storageAccountName", - "storageAccountKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "vmAccessForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "VMAccessForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "check_disk":{ - "type":"boolean" - }, - "repair_disk":{ - "type":"boolean" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "username":{ - "type":"string" - }, - "password":{ - "type":"string" - }, - "ssh_key":{ - "type":"string" - }, - "reset_ssh":{ - "type":"string" - }, - "remove_user":{ - "type":"string" - }, - "expiration":{ - "type":"string" - } - }, - "required":[ - "username", - "password", - "ssh_key", - "reset_ssh", - "remove_user", - "expiration" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "bgInfo":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Compute" - ] - }, - "type":{ - "enum":[ - "bginfo" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] - }, - "vmAccessAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Compute" - ] - }, - "type":{ - "enum":[ - "VMAccessAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "username":{ - "type":"string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "password":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "dscExtension":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Powershell" - ] - }, - "type":{ - "enum":[ - "DSC" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "modulesUrl":{ - "type":"string" - }, - "configurationFunction":{ - "type":"string" - }, - "properties":{ - "type":"string" - }, - "wmfVersion":{ - "type":"string" - }, - "privacy":{ - "type":"object", - "properties":{ - "dataCollection":{ - "type":"string" - } - } - } - }, - "required":[ - "modulesUrl", - "configurationFunction" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "dataBlobUri":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "acronisBackupLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Acronis.Backup" - ] - }, - "type":{ - "enum":[ - "AcronisBackupLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "absURL":{ - "type":"string" - } - }, - "required": [ - "absURL" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "userLogin":{ - "type":"string" - }, - "userPassword":{ - "type":"string" - } - }, - "required": [ - "userLogin", - "userPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "acronisBackup":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Acronis.Backup" - ] - }, - "type":{ - "enum":[ - "AcronisBackup" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "absURL":{ - "type":"string" - } - }, - "required": [ - "absURL" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "userLogin":{ - "type":"string" - }, - "userPassword":{ - "type":"string" - } - }, - "required": [ - "userLogin", - "userPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "linuxChefClient":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Chef.Bootstrap.WindowsAzure" - ] - }, - "type":{ - "enum":[ - "LinuxChefClient" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "bootstrap_version":{ - "type":"string" - }, - "bootstrap_options":{ - "type":"object", - "properties":{ - "chef_node_name":{ - "type": "string" - }, - "chef_server_url":{ - "type": "string" - }, - "validation_client_name":{ - "type": "string" - }, - "node_ssl_verify_mode":{ - "type": "string" - }, - "environment":{ - "type": "string" - } - }, - "required": [ - "chef_node_name", - "chef_server_url", - "validation_client_name", - "node_ssl_verify_mode", - "environment" - ] - }, - "runlist":{ - "type": "string" - }, - "client_rb":{ - "type": "string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "validation_key":{ - "type":"string" - }, - "chef_server_crt":{ - "type":"string" - }, - "secret":{ - "type":"string" - } - }, - "required": [ - "validation_key", - "chef_server_crt", - "secret" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "chefClient":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Chef.Bootstrap.WindowsAzure" - ] - }, - "type":{ - "enum":[ - "ChefClient" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "bootstrap_options":{ - "type":"object", - "properties":{ - "chef_node_name":{ - "type": "string" - }, - "chef_server_url":{ - "type": "string" - }, - "validation_client_name":{ - "type": "string" - }, - "node_ssl_verify_mode":{ - "type": "string" - }, - "environment":{ - "type": "string" - } - }, - "required": [ - "chef_node_name", - "chef_server_url", - "validation_client_name", - "node_ssl_verify_mode", - "environment" - ] - }, - "runlist":{ - "type": "string" - }, - "client_rb":{ - "type": "string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "validation_key":{ - "type":"string" - }, - "chef_server_crt":{ - "type":"string" - }, - "secret":{ - "type":"string" - } - }, - "required": [ - "validation_key", - "chef_server_crt", - "secret" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "datadogLinuxAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Datadog.Agent" - ] - }, - "type":{ - "enum":[ - "DatadogLinuxAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "api_key":{ - "type": "string" - } - }, - "required": [ - "api_key" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "datadogWindowsAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Datadog.Agent" - ] - }, - "type":{ - "enum":[ - "DatadogWindowsAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "api_key":{ - "type": "string" - } - }, - "required": [ - "api_key" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "dockerExtension":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.Extensions" - ] - }, - "type":{ - "enum":[ - "DockerExtension" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "docker":{ - "type": "object", - "properties": { - "port":{ - "type":"string" - } - }, - "required": [ - "port" - ] - } - }, - "required": [ - "docker" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "certs":{ - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - } - }, - "required": [ - "ca", - "cert", - "key" - ] - } - }, - "required": [ - "certs" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "dynatraceLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "dynatrace.ruxit" - ] - }, - "type":{ - "enum":[ - "ruxitAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "tenantId":{ - "type": "string" - }, - "token": { - "type": "string" - } - }, - "required": [ - "tenantId", - "token" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "dynatraceWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "dynatrace.ruxit" - ] - }, - "type":{ - "enum":[ - "ruxitAgentWindows" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "tenantId":{ - "type": "string" - }, - "token": { - "type": "string" - } - }, - "required": [ - "tenantId", - "token" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "eset":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "ESET" - ] - }, - "type":{ - "enum":[ - "FileSecurity" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "LicenseKey":{ - "type": "string" - }, - "Install-RealtimeProtection": { - "type": "boolean" - }, - "Install-ProtocolFiltering": { - "type": "boolean" - }, - "Install-DeviceControl": { - "type": "boolean" - }, - "Enable-Cloud": { - "type": "boolean" - }, - "Enable-PUA": { - "type": "boolean" - }, - "ERAAgentCfgUrl": { - "type": "string" - } - }, - "required": [ - "LicenseKey", - "Install-RealtimeProtection", - "Install-ProtocolFiltering", - "Install-DeviceControl", - "Enable-Cloud", - "Enable-PUA", - "ERAAgentCfgUrl" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "hpeSecurityApplicationDefender":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "HPE.Security.ApplicationDefender" - ] - }, - "type":{ - "enum":[ - "DotnetAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "key": { - "type": "string" - }, - "serverURL": { - "type": "string" - } - }, - "required": [ - "key", - "serverURL" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "protectedSettings" - ] - }, - "puppetAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Puppet" - ] - }, - "type":{ - "enum":[ - "PuppetAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "PUPPET_MASTER_SERVER": { - "type": "string" - } - }, - "required": [ - "PUPPET_MASTER_SERVER" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "protectedSettings" - ] - }, - "site24x7LinuxServerExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7LinuxServerExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnlinuxserver" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "site24x7WindowsServerExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7WindowsServerExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnwindowsserver" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "site24x7ApmInsightExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7ApmInsightExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnapminsightclassic" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "trendMicroDSALinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "TrendMicro.DeepSecurity" - ] - }, - "type":{ - "enum":[ - "TrendMicroDSALinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties": { - "DSMname": { - "type": "string" - }, - "DSMport": { - "type": "string" - }, - "policyNameorID": { - "type": "string" - } - }, - "required": [ - "DSMname", - "DSMport" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "tenantID": { - "type": "string" - }, - "tenantPassword": { - "type": "string" - } - }, - "required": [ - "tenantID", - "tenantPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "trendMicroDSA":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "TrendMicro.DeepSecurity" - ] - }, - "type":{ - "enum":[ - "TrendMicroDSA" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties": { - "DSMname": { - "type": "string" - }, - "DSMport": { - "type": "string" - }, - "policyNameorID": { - "type": "string" - } - }, - "required": [ - "DSMname", - "DSMport" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "tenantID": { - "type": "string" - }, - "tenantPassword": { - "type": "string" - } - }, - "required": [ - "tenantID", - "tenantPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "bmcCtmAgentLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "ctm.bmc.com" - ] - }, - "type":{ - "enum":[ - "BmcCtmAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "Control-M Server Name":{ - "type": "string" - }, - "Agent Port":{ - "type": "string" - }, - "Host Group":{ - "type": "string" - }, - "User Account":{ - "type": "string" - } - }, - "required":[ - "Control-M Server Name", - "Agent Port", - "Host Group", - "User Account" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "bmcCtmAgentWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "bmc.ctm" - ] - }, - "type":{ - "enum":[ - "AgentWinExt" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "Control-M Server Name":{ - "type": "string" - }, - "Agent Port":{ - "type": "string" - }, - "Host Group":{ - "type": "string" - } - }, - "required":[ - "Control-M Server Name", - "Agent Port", - "Host Group" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "OSPatchingForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "OSPatchingForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "disabled":{ - "type":"boolean" - }, - "stop":{ - "type":"boolean" - }, - "installDuration":{ - "type":"string" - }, - "intervalOfWeeks":{ - "type":"number" - }, - "dayOfWeek":{ - "type":"string" - }, - "startTime":{ - "type":"string" - }, - "rebootAfterPatch":{ - "type":"string" - }, - "category":{ - "type":"string" - }, - "oneoff":{ - "type":"boolean" - }, - "local":{ - "type":"boolean" - }, - "idleTestScript":{ - "type":"string" - }, - "healthyTestScript":{ - "type":"string" - }, - "distUpgradeList":{ - "type":"string" - }, - "distUpgradeAll":{ - "type":"boolean" - }, - "vmStatusTest":{ - "type":"object" - } - }, - "required":[ - "disabled", - "stop" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "VMSnapshot":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.RecoveryServices" - ] - }, - "type":{ - "enum":[ - "VMSnapshot" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "locale":{ - "type":"string" - }, - "taskId":{ - "type":"string" - }, - "commandToExecute":{ - "type":"string" - }, - "objectStr":{ - "type":"string" - }, - "logsBlobUri":{ - "type":"string" - }, - "statusBlobUri":{ - "type":"string" - }, - "commandStartTimeUTCTicks":{ - "type":"string" - }, - "vmType":{ - "type":"string" - } - }, - "required":[ - "locale", - "taskId", - "commandToExecute", - "objectStr", - "logsBlobUri", - "statusBlobUri", - "commandStartTimeUTCTicks", - "vmType" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "VMSnapshotLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.RecoveryServices" - ] - }, - "type":{ - "enum":[ - "VMSnapshotLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "locale":{ - "type":"string" - }, - "taskId":{ - "type":"string" - }, - "commandToExecute":{ - "type":"string" - }, - "objectStr":{ - "type":"string" - }, - "logsBlobUri":{ - "type":"string" - }, - "statusBlobUri":{ - "type":"string" - }, - "commandStartTimeUTCTicks":{ - "type":"string" - }, - "vmType":{ - "type":"string" - } - }, - "required":[ - "locale", - "taskId", - "commandToExecute", - "objectStr", - "logsBlobUri", - "statusBlobUri", - "commandStartTimeUTCTicks", - "vmType" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "customScript": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Extensions" - ] - }, - "type": { - "enum": [ - "CustomScript" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "fileUris": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "fileUris" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - }, - "commandToExecute": { - "type": "string" - } - }, - "required": [ - "storageAccountName", - "storageAccountKey", - "commandToExecute" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "networkWatcherAgentWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.NetworkWatcher" - ] - }, - "type":{ - "enum":[ - "NetworkWatcherAgentWindows" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] - }, - "networkWatcherAgentLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.NetworkWatcher" - ] - }, - "type":{ - "enum":[ - "NetworkWatcherAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] } } } diff --git a/schemas/2017-12-01/Microsoft.Compute.json b/schemas/2017-12-01/Microsoft.Compute.json index 2d571d86da..8ff5ede8f7 100644 --- a/schemas/2017-12-01/Microsoft.Compute.json +++ b/schemas/2017-12-01/Microsoft.Compute.json @@ -7,15 +7,6 @@ "availabilitySets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -26,63 +17,66 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/AvailabilitySetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The instance view of a resource." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/AvailabilitySetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set" + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/availabilitySets" }, "images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -93,75 +87,79 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of an Image." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/images" }, "virtualMachines": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ "2017-12-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." }, "plan": { "oneOf": [ @@ -182,18 +180,39 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine." }, - "identity": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] }, "zones": { "oneOf": [ @@ -208,203 +227,44 @@ } ], "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/extensionsChild" - } - ] - } } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachines" }, - "extensions": { - "type": "object", - "properties": { - "type": { - "enum": [ - "Microsoft.Compute/virtualMachines/extensions" - ] - }, - "apiVersion": { - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} - ] - } - }, - "required": [ - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "vmssExtensions": { - "type": "object", - "properties": { - "type": { - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/extensions" - ] - }, - "apiVersion": { - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} - ] - } - }, - "required": [ - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, "virtualMachineScaleSets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, "apiVersion": { "type": "string", "enum": [ "2017-12-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine scale set." }, - "sku": { - "oneOf": [ - { - "$ref": "#/definitions/Sku" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The virtual machine scale set sku." + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." }, "plan": { "oneOf": [ @@ -425,153 +285,282 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set." }, - "identity": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine scale set, if configured." + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set zones." + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/extensionsChild" + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" } - ] - } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets" - } - }, - "definitions": { - "extensionsChild": { + }, + "virtualMachineScaleSets_extensions": { "type": "object", "properties": { - "type": { + "apiVersion": { + "type": "string", "enum": [ - "extensions" + "2017-12-01" ] }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { "apiVersion": { + "type": "string", "enum": [ "2017-12-01" ] }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, "properties": { - "anyOf": [ - { "$ref": "#/definitions/genericExtension" }, - { "$ref": "#/definitions/iaaSDiagnostics" }, - { "$ref": "#/definitions/iaaSAntimalware" }, - { "$ref": "#/definitions/customScriptExtension" }, - { "$ref": "#/definitions/customScriptForLinux"}, - { "$ref": "#/definitions/linuxDiagnostic"}, - { "$ref": "#/definitions/vmAccessForLinux"}, - { "$ref": "#/definitions/bgInfo"}, - { "$ref": "#/definitions/vmAccessAgent"}, - { "$ref": "#/definitions/dscExtension"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/dynatraceLinux"}, - { "$ref": "#/definitions/dynatraceWindows"}, - { "$ref": "#/definitions/eset"}, - { "$ref": "#/definitions/hpeSecurityApplicationDefender"}, - { "$ref": "#/definitions/puppetAgent"}, - { "$ref": "#/definitions/site24x7LinuxServerExtn"}, - { "$ref": "#/definitions/site24x7WindowsServerExtn"}, - { "$ref": "#/definitions/site24x7ApmInsightExtn"}, - { "$ref": "#/definitions/trendMicroDSALinux"}, - { "$ref": "#/definitions/trendMicroDSA"}, - { "$ref": "#/definitions/bmcCtmAgentLinux"}, - { "$ref": "#/definitions/bmcCtmAgentWindows"}, - { "$ref": "#/definitions/OSPatchingForLinux"}, - { "$ref": "#/definitions/VMSnapshot"}, - { "$ref": "#/definitions/VMSnapshotLinux"}, - { "$ref": "#/definitions/acronisBackupLinux"}, - { "$ref": "#/definitions/acronisBackup"}, - { "$ref": "#/definitions/linuxChefClient"}, - { "$ref": "#/definitions/chefClient"}, - { "$ref": "#/definitions/datadogLinuxAgent"}, - { "$ref": "#/definitions/datadogWindowsAgent"}, - { "$ref": "#/definitions/dockerExtension"}, - { "$ref": "#/definitions/customScript" }, - { "$ref": "#/definitions/networkWatcherAgentWindows"}, - { "$ref": "#/definitions/networkWatcherAgentLinux"} + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" ] } }, "required": [ - "type", "apiVersion", + "location", + "name", "properties", - "location" + "type" ], - "description": "Microsoft.Compute/extensionsChild" + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { "AdditionalUnattendContent": { "type": "object", "properties": { - "passName": { + "componentName": { "oneOf": [ { "type": "string", "enum": [ - "OobeSystem" + "Microsoft-Windows-Shell-Setup" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." }, - "componentName": { + "content": { + "type": "string", + "description": "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." + }, + "passName": { "oneOf": [ { "type": "string", "enum": [ - "Microsoft-Windows-Shell-Setup" + "OobeSystem" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "The pass name. Currently, the only allowable value is OobeSystem." }, "settingName": { "oneOf": [ @@ -587,10 +576,6 @@ } ], "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." } }, "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." @@ -600,15 +585,32 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." }, + "AutoOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutoRollback": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, "AvailabilitySetProperties": { "type": "object", "properties": { - "platformUpdateDomainCount": { + "platformFaultDomainCount": { "oneOf": [ { "type": "integer" @@ -617,9 +619,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Update Domain count." + "description": "Fault Domain count." }, - "platformFaultDomainCount": { + "platformUpdateDomainCount": { "oneOf": [ { "type": "integer" @@ -628,7 +630,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count." + "description": "Update Domain count." }, "virtualMachines": { "oneOf": [ @@ -666,48 +668,11 @@ "description": "Uri of the storage account to use for placing the console output and screenshot." } }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." }, "DataDisk": { "type": "object", "properties": { - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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." - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." - }, - "image": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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." - }, "caching": { "oneOf": [ { @@ -724,17 +689,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -760,9 +714,31 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + "description": "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.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { "oneOf": [ { "$ref": "#/definitions/ManagedDiskParameters" @@ -771,12 +747,38 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a data disk." }, @@ -792,7 +794,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." } }, "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." @@ -809,29 +811,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + "description": "Describes a reference to Key Vault Secret" }, - "keyEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the key encryption key in Key Vault." + "description": "Specifies whether disk encryption should be enabled on the virtual machine." }, - "enabled": { + "keyEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "Describes a reference to Key Vault Key" } }, "description": "Describes a Encryption Settings for a Disk" @@ -1024,69 +1026,67 @@ "ImageDataDisk": { "type": "object", "properties": { - "lun": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "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." }, - "caching": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + ] }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -1112,37 +1112,38 @@ "ImageOSDisk": { "type": "object", "properties": { - "osType": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "osState": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "snapshot": { + "managedDisk": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -1150,50 +1151,47 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The snapshot." + ] }, - "managedDisk": { + "osState": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "The OS State." }, - "caching": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -1212,8 +1210,8 @@ } }, "required": [ - "osType", - "osState" + "osState", + "osType" ], "description": "Describes an Operating System disk." }, @@ -1228,8 +1226,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The source virtual machine from which Image is created." + ] }, "storageProfile": { "oneOf": [ @@ -1240,7 +1237,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Describes a storage profile." } }, "description": "Describes the properties of an Image." @@ -1252,14 +1249,14 @@ "type": "string", "description": "Resource Id" }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, "offer": { "type": "string", "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, "sku": { "type": "string", "description": "The image SKU." @@ -1269,35 +1266,35 @@ "description": "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." } }, - "description": "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." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, "ImageStorageProfile": { "type": "object", "properties": { - "osDisk": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageOSDisk" + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } + "$ref": "#/definitions/ImageOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Describes an Operating System disk." }, "zoneResilient": { "oneOf": [ @@ -1311,9 +1308,6 @@ "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." } }, - "required": [ - "osDisk" - ], "description": "Describes a storage profile." }, "InstanceViewStatus": { @@ -1323,6 +1317,10 @@ "type": "string", "description": "The status code." }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, "level": { "oneOf": [ { @@ -1339,10 +1337,6 @@ ], "description": "The level code." }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." @@ -1370,8 +1364,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the key." + ] } }, "required": [ @@ -1395,8 +1388,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the secret." + ] } }, "required": [ @@ -1428,7 +1420,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ssh key configuration for a Linux OS." + "description": "SSH configuration for Linux based VMs running on Azure" } }, "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." @@ -1473,7 +1465,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a network interface reference properties." } }, "description": "Describes a network interface reference." @@ -1518,122 +1511,122 @@ "OSDisk": { "type": "object", "properties": { - "osType": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "vhd": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "image": { + "encryptionSettings": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Describes a Encryption Settings for a Disk" }, - "caching": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes the uri of a disk." }, - "writeAcceleratorEnabled": { + "managedDisk": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "The parameters of a managed disk." }, - "createOption": { - "oneOf": [ - { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "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**." }, - "diskSizeGB": { + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -1644,33 +1637,22 @@ "OSProfile": { "type": "object", "properties": { - "computerName": { + "adminPassword": { "type": "string", - "description": "Specifies the host OS name of the virtual machine.

    **Max-length (Windows):** 15 characters

    **Max-length (Linux):** 64 characters.

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerName": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, "linuxConfiguration": { "oneOf": [ { @@ -1695,6 +1677,17 @@ } ], "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Specifies the operating system settings for the virtual machine." @@ -1706,10 +1699,6 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." @@ -1717,6 +1706,10 @@ "promotionCode": { "type": "string", "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." @@ -1773,14 +1766,6 @@ "Sku": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, "capacity": { "oneOf": [ { @@ -1791,9 +1776,17 @@ } ], "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" } }, - "description": "Describes a virtual machine scale set sku." + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, "SshConfiguration": { "type": "object", @@ -1818,13 +1811,13 @@ "SshPublicKey": { "type": "object", "properties": { - "path": { - "type": "string", - "description": "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" - }, "keyData": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -1832,41 +1825,41 @@ "StorageProfile": { "type": "object", "properties": { - "imageReference": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "osDisk": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, "description": "Specifies the storage settings for the virtual machine disks." @@ -1883,6 +1876,28 @@ "UpgradePolicy": { "type": "object", "properties": { + "automaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + }, + "autoOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutoOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, "mode": { "oneOf": [ { @@ -1909,17 +1924,6 @@ } ], "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgrade": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." @@ -1927,13 +1931,13 @@ "VaultCertificate": { "type": "object", "properties": { - "certificateUrl": { + "certificateStore": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + "description": "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." }, - "certificateStore": { + "certificateUrl": { "type": "string", - "description": "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 .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -1949,8 +1953,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + ] }, "vaultCertificates": { "oneOf": [ @@ -1986,15 +1989,7 @@ "type": "string", "description": "The virtual machine extension name." }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { + "statuses": { "oneOf": [ { "type": "array", @@ -2008,7 +2003,7 @@ ], "description": "The resource status information." }, - "statuses": { + "substatuses": { "oneOf": [ { "type": "array", @@ -2021,20 +2016,6 @@ } ], "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." }, "type": { "type": "string", @@ -2043,7 +2024,13 @@ "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." - }, + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { "autoUpgradeMinorVersion": { "oneOf": [ { @@ -2055,11 +2042,9 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." }, "instanceView": { "oneOf": [ @@ -2070,7 +2055,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine extension instance view." + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -2078,16 +2085,6 @@ "VirtualMachineIdentity": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "description": "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." - }, "identityIds": { "oneOf": [ { @@ -2101,6 +2098,23 @@ } ], "description": "The list of user identities associated with the Virtual Machine. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." } }, "description": "Identity for the virtual machine." @@ -2108,38 +2122,41 @@ "VirtualMachineProperties": { "type": "object", "properties": { - "hardwareProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the hardware settings for the virtual machine." + ] }, - "storageProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -2152,109 +2169,34 @@ ], "description": "Specifies the network interfaces of the virtual machine." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the operating system settings for the virtual machine." }, - "availabilitySet": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Specifies the storage settings for the virtual machine disks." } }, "description": "Describes the properties of a Virtual Machine." }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2017-12-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualMachineExtensionProperties" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, "VirtualMachineScaleSetDataDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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." - }, "caching": { "oneOf": [ { @@ -2271,17 +2213,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -2307,7 +2238,18 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." }, "managedDisk": { "oneOf": [ @@ -2318,12 +2260,27 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a virtual machine scale set data disk." }, @@ -2342,7 +2299,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, "description": "Describes a Virtual Machine Scale Set Extension." @@ -2370,14 +2328,35 @@ "VirtualMachineScaleSetExtensionProperties": { "type": "object", "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, "forceUpdateTag": { "type": "string", "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, "publisher": { "type": "string", "description": "The name of the extension handler publisher." }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, "type": { "type": "string", "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." @@ -2385,23 +2364,6 @@ "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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." - }, - "settings": { - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." @@ -2409,16 +2371,6 @@ "VirtualMachineScaleSetIdentity": { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "description": "The type of identity used for the virtual machine scale set. 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 scale set." - }, "identityIds": { "oneOf": [ { @@ -2432,6 +2384,23 @@ } ], "description": "The list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of identity used for the virtual machine scale set. 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 scale set." } }, "description": "Identity for the virtual machine scale set." @@ -2455,7 +2424,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, "required": [ @@ -2466,95 +2436,95 @@ "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "subnet": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/ApiEntityReference" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the identifier of the subnet." + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, - "primary": { + "loadBalancerBackendAddressPools": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." }, - "publicIPAddressConfiguration": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The publicIPAddressConfiguration." + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" }, - "privateIPAddressVersion": { + "primary": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, - "applicationGatewayBackendAddressPools": { + "privateIPAddressVersion": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + "description": "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'." }, - "loadBalancerBackendAddressPools": { + "publicIPAddressConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "loadBalancerInboundNatPools": { + "subnet": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + "description": "The API entity reference." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -2599,7 +2569,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." } }, "required": [ @@ -2630,16 +2601,16 @@ "VirtualMachineScaleSetNetworkConfigurationProperties": { "type": "object", "properties": { - "primary": { + "dnsSettings": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "enableAcceleratedNetworking": { "oneOf": [ @@ -2652,43 +2623,42 @@ ], "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "networkSecurityGroup": { + "enableIPForwarding": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network security group." + "description": "Whether IP forwarding enabled on this NIC." }, - "dnsSettings": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the network interfaces." + "description": "Specifies the IP configurations of the network interface." }, - "ipConfigurations": { + "networkSecurityGroup": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the IP configurations of the network interface." + ] }, - "enableIPForwarding": { + "primary": { "oneOf": [ { "type": "boolean" @@ -2697,7 +2667,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether IP forwarding enabled on this NIC." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." } }, "required": [ @@ -2717,7 +2687,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + "description": "The API entity reference." }, "networkInterfaceConfigurations": { "oneOf": [ @@ -2739,10 +2709,6 @@ "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, "caching": { "oneOf": [ { @@ -2759,17 +2725,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -2786,31 +2741,46 @@ ], "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "osType": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Describes the uri of a disk." }, - "image": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the unmanaged user image to base the scale set on." + "description": "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**." }, "vhdContainers": { "oneOf": [ @@ -2826,16 +2796,16 @@ ], "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -2846,33 +2816,22 @@ "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "computerNamePrefix": { + "adminPassword": { "type": "string", - "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerNamePrefix": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, "linuxConfiguration": { "oneOf": [ { @@ -2897,6 +2856,17 @@ } ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Describes a virtual machine scale set OS profile." @@ -2904,29 +2874,29 @@ "VirtualMachineScaleSetProperties": { "type": "object", "properties": { - "upgradePolicy": { + "overprovision": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, - "virtualMachineProfile": { + "platformFaultDomainCount": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "Fault Domain count for each placement group." }, - "overprovision": { + "singlePlacementGroup": { "oneOf": [ { "type": "boolean" @@ -2935,40 +2905,40 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "singlePlacementGroup": { + "upgradePolicy": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/UpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "zoneBalance": { + "virtualMachineProfile": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Describes a virtual machine scale set virtual machine profile." }, - "platformFaultDomainCount": { + "zoneBalance": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count for each placement group." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -2988,7 +2958,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" } }, "required": [ @@ -3012,6 +2983,17 @@ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "type": "object", "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, "idleTimeoutInMinutes": { "oneOf": [ { @@ -3022,39 +3004,65 @@ } ], "description": "The idle timeout of the public IP address." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "dnsSettings": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the publicIP addresses ." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." } }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + "description": "Describes a virtual machine scale set storage profile." }, "virtualMachineScaleSets_extensions_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, "apiVersion": { "type": "string", "enum": [ "2017-12-01" ] }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, "properties": { "oneOf": [ { @@ -3063,29 +3071,27 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" ] } }, "required": [ - "name", - "type", "apiVersion", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, "virtualMachineScaleSets_virtualmachines_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -3096,19 +3102,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "oneOf": [ @@ -3118,154 +3125,159 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, - "VirtualMachineScaleSetStorageProfile": { + "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "imageReference": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osDisk": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview." }, - "dataDisks": { + "extensionProfile": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { + "description": "Describes a virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." + "description": "Describes a virtual machine scale set network profile." }, - "storageProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Describes a virtual machine scale set OS profile." }, - "networkProfile": { + "priority": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + "type": "string", + "enum": [ + "Regular", + "Low" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." }, - "diagnosticsProfile": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "extensionProfile": { + "description": "Describes a virtual machine scale set storage profile." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetVMProperties": { + "type": "object", + "properties": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + ] }, - "priority": { + "diagnosticsProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "Regular", - "Low" - ] + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "VirtualMachineScaleSetVMProperties": { - "type": "object", - "properties": { + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, "hardwareProfile": { "oneOf": [ { @@ -3277,16 +3289,20 @@ ], "description": "Specifies the hardware settings for the virtual machine." }, - "storageProfile": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/NetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Specifies the network interfaces of the virtual machine." }, "osProfile": { "oneOf": [ @@ -3299,59 +3315,95 @@ ], "description": "Specifies the operating system settings for the virtual machine." }, - "networkProfile": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/NetworkProfile" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the network interfaces of the virtual machine." + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2017-12-01" + ] }, - "diagnosticsProfile": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Describes the properties of a Virtual Machine Extension." }, - "availabilitySet": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Resource tags" }, - "licenseType": { + "type": { "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "enum": [ + "extensions" + ] } }, - "description": "Describes the properties of a virtual machine scale set virtual machine." + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" }, "WindowsConfiguration": { "type": "object", "properties": { - "provisionVMAgent": { + "additionalUnattendContent": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, "enableAutomaticUpdates": { "oneOf": [ @@ -3364,23 +3416,20 @@ ], "description": "Indicates whether virtual machine is enabled for automatic updates." }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { + "provisionVMAgent": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" }, "winRM": { "oneOf": [ @@ -3391,7 +3440,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + "description": "Describes Windows Remote Management configuration of the VM" } }, "description": "Specifies Windows operating system settings on the virtual machine." @@ -3419,6 +3468,10 @@ "WinRMListener": { "type": "object", "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, "protocol": { "oneOf": [ { @@ -3433,2026 +3486,9 @@ } ], "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - }, - "genericExtension": { - "type": "object", - "properties": { - "publisher": { - "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Publisher" - }, - "type": { - "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Type" - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1, - "description": "Microsoft.Compute/extensions - Type handler version" - }, - "settings": { - "oneOf": [ - { "type": "object" }, - { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Microsoft.Compute/extensions - Settings" - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "settings" - ] - }, - "iaaSDiagnostics": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Diagnostics" - ] - }, - "type": { - "enum": [ - "IaaSDiagnostics" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "xmlCfg": { - "type": "string" - }, - "StorageAccount": { - "type": "string" - } - }, - "required": [ - "xmlCfg", - "StorageAccount" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - }, - "storageAccountEndPoint": { - "type": "string" - } - }, - "required": [ - "storageAccountName", - "storageAccountKey", - "storageAccountEndPoint" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "iaaSAntimalware": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Security" - ] - }, - "type": { - "enum": [ - "IaaSAntimalware" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "AntimalwareEnabled": { - "type": "boolean" - }, - "Exclusions": { - "type": "object", - "properties": { - "Paths": { - "type": "string" - }, - "Extensions": { - "type": "string" - }, - "Processes": { - "type": "string" - } - }, - "required": [ - "Paths", - "Extensions", - "Processes" - ] - }, - "RealtimeProtectionEnabled": { - "enum": [ - "true", - "false" - ] - }, - "ScheduledScanSettings": { - "type": "object", - "properties": { - "isEnabled": { - "enum": [ - "true", - "false" - ] - }, - "scanType": { - "type": "string" - }, - "day": { - "type": "string" - }, - "time": { - "type": "string" - } - }, - "required": [ - "isEnabled", - "scanType", - "day", - "time" - ] - } - }, - "required": [ - "AntimalwareEnabled", - "Exclusions", - "RealtimeProtectionEnabled", - "ScheduledScanSettings" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "customScriptExtension": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Compute" - ] - }, - "type": { - "enum": [ - "CustomScriptExtension" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "fileUris": { - "type": "array", - "items": { - "type": "string" - } - }, - "commandToExecute": { - "type": "string" - } - }, - "required": [ - "commandToExecute" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - } - } - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "customScriptForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "CustomScriptForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "fileUris":{ - "type":"array", - "items":{ - "type":"string" - } - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "commandToExecute":{ - "type":"string" - }, - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" - } - }, - "required":[ - "commandToExecute" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "linuxDiagnostic":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "LinuxDiagnostic" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "enableSyslog":{ - "type":"string" - }, - "mdsdHttpProxy":{ - "type":"string" - }, - "perCfg":{ - "type":"array" - }, - "fileCfg":{ - "type":"array" - }, - "xmlCfg":{ - "type":"string" - }, - "ladCfg":{ - "type":"object" - }, - "syslogCfg":{ - "type":"string" - }, - "eventVolume":{ - "type":"string" - }, - "mdsdCfg":{ - "type":"string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "mdsdHttpProxy":{ - "type":"string" - }, - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" - }, - "storageAccountEndPoint":{ - "type":"string" - } - }, - "required":[ - "storageAccountName", - "storageAccountKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "vmAccessForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "VMAccessForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "check_disk":{ - "type":"boolean" - }, - "repair_disk":{ - "type":"boolean" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "username":{ - "type":"string" - }, - "password":{ - "type":"string" - }, - "ssh_key":{ - "type":"string" - }, - "reset_ssh":{ - "type":"string" - }, - "remove_user":{ - "type":"string" - }, - "expiration":{ - "type":"string" - } - }, - "required":[ - "username", - "password", - "ssh_key", - "reset_ssh", - "remove_user", - "expiration" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "bgInfo":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Compute" - ] - }, - "type":{ - "enum":[ - "bginfo" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] - }, - "vmAccessAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Compute" - ] - }, - "type":{ - "enum":[ - "VMAccessAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "username":{ - "type":"string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "password":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "dscExtension":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Powershell" - ] - }, - "type":{ - "enum":[ - "DSC" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "modulesUrl":{ - "type":"string" - }, - "configurationFunction":{ - "type":"string" - }, - "properties":{ - "type":"string" - }, - "wmfVersion":{ - "type":"string" - }, - "privacy":{ - "type":"object", - "properties":{ - "dataCollection":{ - "type":"string" - } - } - } - }, - "required":[ - "modulesUrl", - "configurationFunction" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "dataBlobUri":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "acronisBackupLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Acronis.Backup" - ] - }, - "type":{ - "enum":[ - "AcronisBackupLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "absURL":{ - "type":"string" - } - }, - "required": [ - "absURL" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "userLogin":{ - "type":"string" - }, - "userPassword":{ - "type":"string" - } - }, - "required": [ - "userLogin", - "userPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "acronisBackup":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Acronis.Backup" - ] - }, - "type":{ - "enum":[ - "AcronisBackup" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "absURL":{ - "type":"string" - } - }, - "required": [ - "absURL" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "userLogin":{ - "type":"string" - }, - "userPassword":{ - "type":"string" - } - }, - "required": [ - "userLogin", - "userPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "linuxChefClient":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Chef.Bootstrap.WindowsAzure" - ] - }, - "type":{ - "enum":[ - "LinuxChefClient" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "bootstrap_version":{ - "type":"string" - }, - "bootstrap_options":{ - "type":"object", - "properties":{ - "chef_node_name":{ - "type": "string" - }, - "chef_server_url":{ - "type": "string" - }, - "validation_client_name":{ - "type": "string" - }, - "node_ssl_verify_mode":{ - "type": "string" - }, - "environment":{ - "type": "string" - } - }, - "required": [ - "chef_node_name", - "chef_server_url", - "validation_client_name", - "node_ssl_verify_mode", - "environment" - ] - }, - "runlist":{ - "type": "string" - }, - "client_rb":{ - "type": "string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "validation_key":{ - "type":"string" - }, - "chef_server_crt":{ - "type":"string" - }, - "secret":{ - "type":"string" - } - }, - "required": [ - "validation_key", - "chef_server_crt", - "secret" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "chefClient":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Chef.Bootstrap.WindowsAzure" - ] - }, - "type":{ - "enum":[ - "ChefClient" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "bootstrap_options":{ - "type":"object", - "properties":{ - "chef_node_name":{ - "type": "string" - }, - "chef_server_url":{ - "type": "string" - }, - "validation_client_name":{ - "type": "string" - }, - "node_ssl_verify_mode":{ - "type": "string" - }, - "environment":{ - "type": "string" - } - }, - "required": [ - "chef_node_name", - "chef_server_url", - "validation_client_name", - "node_ssl_verify_mode", - "environment" - ] - }, - "runlist":{ - "type": "string" - }, - "client_rb":{ - "type": "string" - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "validation_key":{ - "type":"string" - }, - "chef_server_crt":{ - "type":"string" - }, - "secret":{ - "type":"string" - } - }, - "required": [ - "validation_key", - "chef_server_crt", - "secret" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "datadogLinuxAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Datadog.Agent" - ] - }, - "type":{ - "enum":[ - "DatadogLinuxAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "api_key":{ - "type": "string" - } - }, - "required": [ - "api_key" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "datadogWindowsAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Datadog.Agent" - ] - }, - "type":{ - "enum":[ - "DatadogWindowsAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "api_key":{ - "type": "string" - } - }, - "required": [ - "api_key" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "dockerExtension":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.Extensions" - ] - }, - "type":{ - "enum":[ - "DockerExtension" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "docker":{ - "type": "object", - "properties": { - "port":{ - "type":"string" - } - }, - "required": [ - "port" - ] - } - }, - "required": [ - "docker" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "certs":{ - "type": "object", - "properties": { - "ca": { - "type": "string" - }, - "cert": { - "type": "string" - }, - "key": { - "type": "string" - } - }, - "required": [ - "ca", - "cert", - "key" - ] - } - }, - "required": [ - "certs" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "dynatraceLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "dynatrace.ruxit" - ] - }, - "type":{ - "enum":[ - "ruxitAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "tenantId":{ - "type": "string" - }, - "token": { - "type": "string" - } - }, - "required": [ - "tenantId", - "token" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "dynatraceWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "dynatrace.ruxit" - ] - }, - "type":{ - "enum":[ - "ruxitAgentWindows" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "tenantId":{ - "type": "string" - }, - "token": { - "type": "string" - } - }, - "required": [ - "tenantId", - "token" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "eset":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "ESET" - ] - }, - "type":{ - "enum":[ - "FileSecurity" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "LicenseKey":{ - "type": "string" - }, - "Install-RealtimeProtection": { - "type": "boolean" - }, - "Install-ProtocolFiltering": { - "type": "boolean" - }, - "Install-DeviceControl": { - "type": "boolean" - }, - "Enable-Cloud": { - "type": "boolean" - }, - "Enable-PUA": { - "type": "boolean" - }, - "ERAAgentCfgUrl": { - "type": "string" - } - }, - "required": [ - "LicenseKey", - "Install-RealtimeProtection", - "Install-ProtocolFiltering", - "Install-DeviceControl", - "Enable-Cloud", - "Enable-PUA", - "ERAAgentCfgUrl" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "hpeSecurityApplicationDefender":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "HPE.Security.ApplicationDefender" - ] - }, - "type":{ - "enum":[ - "DotnetAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "key": { - "type": "string" - }, - "serverURL": { - "type": "string" - } - }, - "required": [ - "key", - "serverURL" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "protectedSettings" - ] - }, - "puppetAgent":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Puppet" - ] - }, - "type":{ - "enum":[ - "PuppetAgent" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "PUPPET_MASTER_SERVER": { - "type": "string" - } - }, - "required": [ - "PUPPET_MASTER_SERVER" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "protectedSettings" - ] - }, - "site24x7LinuxServerExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7LinuxServerExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnlinuxserver" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "site24x7WindowsServerExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7WindowsServerExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnwindowsserver" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "site24x7ApmInsightExtn":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Site24x7" - ] - }, - "type":{ - "enum":[ - "Site24x7ApmInsightExtn" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "site24x7AgentType":{ - "enum":[ - "azurevmextnapminsightclassic" - ] - } - } - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "site24x7LicenseKey":{ - "type": "string" - } - }, - "required":[ - "site24x7LicenseKey" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "trendMicroDSALinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "TrendMicro.DeepSecurity" - ] - }, - "type":{ - "enum":[ - "TrendMicroDSALinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties": { - "DSMname": { - "type": "string" - }, - "DSMport": { - "type": "string" - }, - "policyNameorID": { - "type": "string" - } - }, - "required": [ - "DSMname", - "DSMport" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "tenantID": { - "type": "string" - }, - "tenantPassword": { - "type": "string" - } - }, - "required": [ - "tenantID", - "tenantPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "trendMicroDSA":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "TrendMicro.DeepSecurity" - ] - }, - "type":{ - "enum":[ - "TrendMicroDSA" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties": { - "DSMname": { - "type": "string" - }, - "DSMport": { - "type": "string" - }, - "policyNameorID": { - "type": "string" - } - }, - "required": [ - "DSMname", - "DSMport" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "tenantID": { - "type": "string" - }, - "tenantPassword": { - "type": "string" - } - }, - "required": [ - "tenantID", - "tenantPassword" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "bmcCtmAgentLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "ctm.bmc.com" - ] - }, - "type":{ - "enum":[ - "BmcCtmAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "Control-M Server Name":{ - "type": "string" - }, - "Agent Port":{ - "type": "string" - }, - "Host Group":{ - "type": "string" - }, - "User Account":{ - "type": "string" - } - }, - "required":[ - "Control-M Server Name", - "Agent Port", - "Host Group", - "User Account" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "bmcCtmAgentWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "bmc.ctm" - ] - }, - "type":{ - "enum":[ - "AgentWinExt" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type": "object", - "properties":{ - "Control-M Server Name":{ - "type": "string" - }, - "Agent Port":{ - "type": "string" - }, - "Host Group":{ - "type": "string" - } - }, - "required":[ - "Control-M Server Name", - "Agent Port", - "Host Group" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "OSPatchingForLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.OSTCExtensions" - ] - }, - "type":{ - "enum":[ - "OSPatchingForLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "disabled":{ - "type":"boolean" - }, - "stop":{ - "type":"boolean" - }, - "installDuration":{ - "type":"string" - }, - "intervalOfWeeks":{ - "type":"number" - }, - "dayOfWeek":{ - "type":"string" - }, - "startTime":{ - "type":"string" - }, - "rebootAfterPatch":{ - "type":"string" - }, - "category":{ - "type":"string" - }, - "oneoff":{ - "type":"boolean" - }, - "local":{ - "type":"boolean" - }, - "idleTestScript":{ - "type":"string" - }, - "healthyTestScript":{ - "type":"string" - }, - "distUpgradeList":{ - "type":"string" - }, - "distUpgradeAll":{ - "type":"boolean" - }, - "vmStatusTest":{ - "type":"object" - } - }, - "required":[ - "disabled", - "stop" - ] - }, - "protectedSettings":{ - "type":"object", - "properties":{ - "storageAccountName":{ - "type":"string" - }, - "storageAccountKey":{ - "type":"string" - } - } - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "VMSnapshot":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.RecoveryServices" - ] - }, - "type":{ - "enum":[ - "VMSnapshot" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "locale":{ - "type":"string" - }, - "taskId":{ - "type":"string" - }, - "commandToExecute":{ - "type":"string" - }, - "objectStr":{ - "type":"string" - }, - "logsBlobUri":{ - "type":"string" - }, - "statusBlobUri":{ - "type":"string" - }, - "commandStartTimeUTCTicks":{ - "type":"string" - }, - "vmType":{ - "type":"string" - } - }, - "required":[ - "locale", - "taskId", - "commandToExecute", - "objectStr", - "logsBlobUri", - "statusBlobUri", - "commandStartTimeUTCTicks", - "vmType" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "VMSnapshotLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.RecoveryServices" - ] - }, - "type":{ - "enum":[ - "VMSnapshotLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - }, - "settings":{ - "type":"object", - "properties":{ - "locale":{ - "type":"string" - }, - "taskId":{ - "type":"string" - }, - "commandToExecute":{ - "type":"string" - }, - "objectStr":{ - "type":"string" - }, - "logsBlobUri":{ - "type":"string" - }, - "statusBlobUri":{ - "type":"string" - }, - "commandStartTimeUTCTicks":{ - "type":"string" - }, - "vmType":{ - "type":"string" - } - }, - "required":[ - "locale", - "taskId", - "commandToExecute", - "objectStr", - "logsBlobUri", - "statusBlobUri", - "commandStartTimeUTCTicks", - "vmType" - ] - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings" - ] - }, - "customScript": { - "type": "object", - "properties": { - "publisher": { - "enum": [ - "Microsoft.Azure.Extensions" - ] - }, - "type": { - "enum": [ - "CustomScript" - ] - }, - "typeHandlerVersion": { - "type": "string", - "minLength": 1 - }, - "autoUpgradeMinorVersion": { - "type": "boolean" - }, - "settings": { - "type": "object", - "properties": { - "fileUris": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "fileUris" - ] - }, - "protectedSettings": { - "type": "object", - "properties": { - "storageAccountName": { - "type": "string" - }, - "storageAccountKey": { - "type": "string" - }, - "commandToExecute": { - "type": "string" - } - }, - "required": [ - "storageAccountName", - "storageAccountKey", - "commandToExecute" - ] - } - }, - "required": [ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion", - "settings", - "protectedSettings" - ] - }, - "networkWatcherAgentWindows":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.NetworkWatcher" - ] - }, - "type":{ - "enum":[ - "NetworkWatcherAgentWindows" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] - }, - "networkWatcherAgentLinux":{ - "type":"object", - "properties":{ - "publisher":{ - "enum":[ - "Microsoft.Azure.NetworkWatcher" - ] - }, - "type":{ - "enum":[ - "NetworkWatcherAgentLinux" - ] - }, - "typeHandlerVersion":{ - "type":"string", - "minLength":1 - }, - "autoUpgradeMinorVersion":{ - "type":"boolean" - } - }, - "required":[ - "publisher", - "type", - "typeHandlerVersion", - "autoUpgradeMinorVersion" - ] } } } diff --git a/schemas/2018-04-01/Microsoft.Compute.json b/schemas/2018-04-01/Microsoft.Compute.json index a0d673242b..32cd9df481 100644 --- a/schemas/2018-04-01/Microsoft.Compute.json +++ b/schemas/2018-04-01/Microsoft.Compute.json @@ -4,19 +4,163 @@ "title": "Microsoft.Compute", "description": "Microsoft Compute Resource Types", "resourceDefinitions": { + "availabilitySets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilitySetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a resource." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/availabilitySets" + }, "disks": { "type": "object", "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, "name": { "type": "string", "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Disk resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/DiskSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, or StandardSSD_LRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, "type": { "type": "string", "enum": [ "Microsoft.Compute/disks" ] }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logical zone list for Disk." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/disks" + }, + "images": { + "type": "object", + "properties": { "apiVersion": { "type": "string", "enum": [ @@ -27,13 +171,29 @@ "type": "string", "description": "Resource location" }, + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an Image." + }, "tags": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -41,29 +201,97 @@ ], "description": "Resource tags" }, - "sku": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/images" + }, + "proximityPlacementGroups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the proximity placement group." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/DiskSku" + "$ref": "#/definitions/ProximityPlacementGroupProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Proximity Placement Group." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Logical zone list for Disk." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/proximityPlacementGroups" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/proximityPlacementGroups" + }, + "snapshots": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." }, "properties": { "oneOf": [ @@ -73,31 +301,3379 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Disk resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/snapshots" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine zones." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" + }, + "virtualMachineScaleSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachineScaleSets_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + }, + "content": { + "type": "string", + "description": "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." + }, + "passName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "OobeSystem" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The pass name. Currently, the only allowable value is OobeSystem." + }, + "settingName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AutoOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutoRollback": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "virtualMachines": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of references to all virtual machines in the availability set." + } + }, + "description": "The instance view of a resource." + }, + "BootDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "CreationData": { + "type": "object", + "properties": { + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This enumerates the possible sources of a disk's creation." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "DataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a data disk." + }, + "DiagnosticsProfile": { + "type": "object", + "properties": { + "bootDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/BootDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Secret" + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Key" + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "DiskProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettings": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, or StandardSSD_LRS." + }, + "EncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + }, + "description": "Encryption settings for disk or snapshot" + }, + "HardwareProfile": { + "type": "object", + "properties": { + "vmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageDataDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageDiskReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "ImageOSDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The OS State." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "required": [ + "osState", + "osType" + ], + "description": "Describes an Operating System disk." + }, + "ImageProperties": { + "type": "object", + "properties": { + "sourceVirtualMachine": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ImageStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a storage profile." + } + }, + "description": "Describes the properties of an Image." + }, + "ImageReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "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." + } + }, + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "ImageStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ImageOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an Operating System disk." + }, + "zoneResilient": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "InstanceViewStatus": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "level": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Info", + "Warning", + "Error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The level code." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "KeyVaultAndKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "KeyVaultAndSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "KeyVaultKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "KeyVaultSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "LinuxConfiguration": { + "type": "object", + "properties": { + "disablePasswordAuthentication": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "oneOf": [ + { + "$ref": "#/definitions/SshConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSH configuration for Linux based VMs running on Azure" + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "ManagedDiskParameters": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "description": "The parameters of a managed disk." + }, + "NetworkInterfaceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network interface reference properties." + } + }, + "description": "Describes a network interface reference." + }, + "NetworkInterfaceReferenceProperties": { + "type": "object", + "properties": { + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "OSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "encryptionSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a Encryption Settings for a Disk" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption" + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "OSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "ProximityPlacementGroupProperties": { + "type": "object", + "properties": { + "proximityPlacementGroupType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard", + "Ultra" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "RollingUpgradePolicy": { + "type": "object", + "properties": { + "maxBatchInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "Sku": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "SnapshotSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "SourceVault": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "SshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "SshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "StorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/OSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + } + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "automaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + }, + "autoOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutoOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + }, + "rollingUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/RollingUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used while performing a rolling upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "VaultCertificate": { + "type": "object", + "properties": { + "certificateStore": { + "type": "string", + "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "properties": { + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "vaultCertificates": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "VirtualHardDisk": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "VirtualMachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "statuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "substatuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "instanceView": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineIdentity": { + "type": "object", + "properties": { + "identityIds": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of user identities associated with the Virtual Machine. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "Identity for the virtual machine." + }, + "VirtualMachineProperties": { + "type": "object", + "properties": { + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The create option." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "properties": { + "extensions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetIdentity": { + "type": "object", + "properties": { + "identityIds": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of identity used for the virtual machine scale set. 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 scale set." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "properties": { + "applicationGatewayBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "loadBalancerBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + }, + "loadBalancerInboundNatPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "privateIPAddressVersion": { + "oneOf": [ + { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "publicIPAddressConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "properties": { + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "properties": { + "dnsServers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "enableAcceleratedNetworking": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "enableIPForwarding": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether IP forwarding enabled on this NIC." + }, + "ipConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the IP configurations of the network interface." + }, + "networkSecurityGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "properties": { + "healthProbe": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + }, + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhdContainers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetProperties": { + "type": "object", + "properties": { + "overprovision": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "singlePlacementGroup": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "virtualMachineProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "zoneBalance": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "idleTimeoutInMinutes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The idle timeout of the public IP address." + }, + "ipTags": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of IP tags associated with the public IP address." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" ] } }, "required": [ - "name", - "type", "apiVersion", - "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/disks" + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, - "snapshots": { + "virtualMachineScaleSets_virtualmachines_childResource": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/snapshots" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -108,325 +3684,393 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "sku": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/SnapshotSku" + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/DiskProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/snapshots" - } - }, - "definitions": { - "CreationData": { + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "createOption": { + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "evictionPolicy": { "oneOf": [ { "type": "string", "enum": [ - "Empty", - "Attach", - "FromImage", - "Import", - "Copy", - "Restore" + "Deallocate", + "Delete" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This enumerates the possible sources of a disk's creation." - }, - "storageAccountId": { - "type": "string", - "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview." }, - "imageReference": { + "extensionProfile": { "oneOf": [ { - "$ref": "#/definitions/ImageDiskReference" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information." + "description": "Describes a virtual machine scale set extension profile." }, - "sourceUri": { + "licenseType": { "type": "string", - "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, - "sourceResourceId": { - "type": "string", - "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." - } - }, - "required": [ - "createOption" - ], - "description": "Data used when creating a disk." - }, - "DiskProperties": { - "type": "object", - "properties": { - "osType": { + "networkProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Describes a virtual machine scale set network profile." }, - "creationData": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/CreationData" + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "Describes a virtual machine scale set OS profile." }, - "diskSizeGB": { + "priority": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "Regular", + "Low" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." }, - "encryptionSettings": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSettings" + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption settings for disk or snapshot" + "description": "Describes a virtual machine scale set storage profile." } }, - "required": [ - "creationData" - ], - "description": "Disk resource properties." + "description": "Describes a virtual machine scale set virtual machine profile." }, - "DiskSku": { + "VirtualMachineScaleSetVMProperties": { "type": "object", "properties": { - "name": { + "availabilitySet": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ] + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The sku name." - } - }, - "description": "The disks sku name. Can be Standard_LRS or Premium_LRS." - }, - "EncryptionSettings": { - "type": "object", - "properties": { - "enabled": { + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + "description": "Specifies the hardware settings for the virtual machine." }, - "diskEncryptionKey": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultAndSecretReference" + "$ref": "#/definitions/NetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" + "description": "Specifies the network interfaces of the virtual machine." }, - "keyEncryptionKey": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultAndKeyReference" + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Key Url and vault id of the key encryption key" + "description": "Specifies the storage settings for the virtual machine disks." } }, - "description": "Encryption settings for disk or snapshot" + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "ImageDiskReference": { + "virtualMachines_extensions_childResource": { "type": "object", "properties": { - "id": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-04-01" + ] + }, + "location": { "type": "string", - "description": "A relative uri containing either a Platform Imgage Repository or user image reference." + "description": "Resource location" }, - "lun": { + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." - } - }, - "required": [ - "id" - ], - "description": "The source image used for creating the disk." - }, - "KeyVaultAndKeyReference": { - "type": "object", - "properties": { - "sourceVault": { + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/SourceVault" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" + "description": "Resource tags" }, - "keyUrl": { + "type": { "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "enum": [ + "extensions" + ] } }, "required": [ - "sourceVault", - "keyUrl" + "apiVersion", + "location", + "name", + "properties", + "type" ], - "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + "description": "Microsoft.Compute/virtualMachines/extensions" }, - "KeyVaultAndSecretReference": { + "WindowsConfiguration": { "type": "object", "properties": { - "sourceVault": { + "additionalUnattendContent": { "oneOf": [ { - "$ref": "#/definitions/SourceVault" + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, - "secretUrl": { + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "winRM": { + "oneOf": [ + { + "$ref": "#/definitions/WinRMConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes Windows Remote Management configuration of the VM" } }, - "required": [ - "sourceVault", - "secretUrl" - ], - "description": "Key Vault Secret Url and vault id of the encryption key " + "description": "Specifies Windows operating system settings on the virtual machine." }, - "SnapshotSku": { + "WinRMConfiguration": { "type": "object", "properties": { - "name": { + "listeners": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS", - "Standard_ZRS" - ] + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The sku name." + "description": "The list of Windows Remote Management listeners" } }, - "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + "description": "Describes Windows Remote Management configuration of the VM" }, - "SourceVault": { + "WinRMListener": { "type": "object", "properties": { - "id": { + "certificateUrl": { "type": "string", - "description": "Resource Id" + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Http", + "Https" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" } } } diff --git a/schemas/2018-06-01/Microsoft.Compute.json b/schemas/2018-06-01/Microsoft.Compute.json index 43e35653de..5ac45c12b6 100644 --- a/schemas/2018-06-01/Microsoft.Compute.json +++ b/schemas/2018-06-01/Microsoft.Compute.json @@ -7,15 +7,6 @@ "availabilitySets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -26,64 +17,66 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/AvailabilitySetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The instance view of a resource." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/AvailabilitySetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/availabilitySets" }, "disks": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/disks" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -94,19 +87,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DiskProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Disk resource properties." }, "sku": { "oneOf": [ @@ -116,54 +110,57 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Logical zone list for Disk." + "description": "Resource tags" }, - "properties": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { "oneOf": [ { - "$ref": "#/definitions/DiskProperties" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Logical zone list for Disk." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/disks" }, "galleries": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -174,19 +171,9 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." }, "properties": { "oneOf": [ @@ -196,7 +183,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Shared Image Gallery." }, "resources": { "type": "array", @@ -207,29 +195,41 @@ } ] } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries" }, "galleries_images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -240,19 +240,9 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." }, "properties": { "oneOf": [ @@ -262,7 +252,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a gallery Image Definition." }, "resources": { "type": "array", @@ -273,29 +264,41 @@ } ] } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images" }, "galleries_images_versions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries/images/versions" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -306,52 +309,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageVersionProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images/versions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images/versions" }, "images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -362,53 +368,114 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of an Image." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/images" }, - "snapshots": { + "proximityPlacementGroups": { "type": "object", "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, "name": { "type": "string", - "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + "description": "The name of the proximity placement group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProximityPlacementGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Proximity Placement Group." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" }, "type": { "type": "string", "enum": [ - "Microsoft.Compute/snapshots" + "Microsoft.Compute/proximityPlacementGroups" ] - }, + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/proximityPlacementGroups" + }, + "snapshots": { + "type": "object", + "properties": { "apiVersion": { "type": "string", "enum": [ @@ -419,19 +486,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/SnapshotProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Snapshot resource properties." }, "sku": { "oneOf": [ @@ -441,63 +509,67 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/SnapshotProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/snapshots" }, "virtualMachines": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ "2018-06-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." }, "plan": { "oneOf": [ @@ -518,18 +590,39 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine." }, - "identity": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] }, "zones": { "oneOf": [ @@ -544,105 +637,111 @@ } ], "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachines" }, "virtualMachineScaleSets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, "apiVersion": { "type": "string", "enum": [ "2018-06-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine scale set." }, - "sku": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set sku." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "plan": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "$ref": "#/definitions/VirtualMachineScaleSetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Describes the properties of a Virtual Machine Scale Set." }, - "properties": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "identity": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine scale set, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] }, "zones": { "oneOf": [ @@ -656,43 +755,60 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" - }, - { - "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" - } - ] - } + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets" }, - "virtualMachineScaleSets_virtualmachines": { + "virtualMachineScaleSets_extensions": { "type": "object", "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-06-01" + ] + }, "name": { - "type": "string" + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." }, "type": { "type": "string", "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + "Microsoft.Compute/virtualMachineScaleSets/extensions" ] - }, + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { "apiVersion": { "type": "string", "enum": [ @@ -703,13 +819,40 @@ "type": "string", "description": "Resource location" }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, "tags": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -717,36 +860,80 @@ ], "description": "Resource tags" }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Extension." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + "description": "Microsoft.Compute/virtualMachines/extensions" } }, "definitions": { @@ -770,33 +957,37 @@ "AdditionalUnattendContent": { "type": "object", "properties": { - "passName": { + "componentName": { "oneOf": [ { "type": "string", "enum": [ - "OobeSystem" + "Microsoft-Windows-Shell-Setup" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." }, - "componentName": { + "content": { + "type": "string", + "description": "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." + }, + "passName": { "oneOf": [ { "type": "string", "enum": [ - "Microsoft-Windows-Shell-Setup" + "OobeSystem" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "The pass name. Currently, the only allowable value is OobeSystem." }, "settingName": { "oneOf": [ @@ -812,10 +1003,6 @@ } ], "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." } }, "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." @@ -825,7 +1012,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -850,6 +1037,17 @@ "AvailabilitySetProperties": { "type": "object", "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, "platformUpdateDomainCount": { "oneOf": [ { @@ -861,16 +1059,15 @@ ], "description": "Update Domain count." }, - "platformFaultDomainCount": { + "proximityPlacementGroup": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Fault Domain count." + ] }, "virtualMachines": { "oneOf": [ @@ -932,10 +1129,6 @@ ], "description": "This enumerates the possible sources of a disk's creation." }, - "storageAccountId": { - "type": "string", - "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" - }, "imageReference": { "oneOf": [ { @@ -945,15 +1138,19 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information." + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." }, "sourceUri": { "type": "string", "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." }, - "sourceResourceId": { + "storageAccountId": { "type": "string", - "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" } }, "required": [ @@ -964,112 +1161,112 @@ "DataDisk": { "type": "object", "properties": { - "lun": { + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "vhd": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes the uri of a disk." }, - "writeAcceleratorEnabled": { + "lun": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "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." }, - "createOption": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "The parameters of a managed disk." }, - "diskSizeGB": { + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a data disk." }, @@ -1105,10 +1302,10 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the differencing disk settings for operating system disk." + "description": "Specifies the ephemeral disk settings for operating system disk." } }, - "description": "Describes the parameters of differencing disk settings that can be be specified for operating system disk.

    NOTE: The differencing disk settings can only be specified for managed disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, "Disallowed": { "type": "object", @@ -1142,29 +1339,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + "description": "Describes a reference to Key Vault Secret" }, - "keyEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the key encryption key in Key Vault." + "description": "Specifies whether disk encryption should be enabled on the virtual machine." }, - "enabled": { + "keyEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "Describes a reference to Key Vault Key" } }, "description": "Describes a Encryption Settings for a Disk" @@ -1172,33 +1369,29 @@ "DiskProperties": { "type": "object", "properties": { - "osType": { + "creationData": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/CreationData" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Data used when creating a disk." }, - "creationData": { + "diskIOPSReadWrite": { "oneOf": [ { - "$ref": "#/definitions/CreationData" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings)." }, - "diskSizeGB": { + "diskMBpsReadWrite": { "oneOf": [ { "type": "integer" @@ -1207,40 +1400,44 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings)." }, - "encryptionSettings": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption settings for disk or snapshot" + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." }, - "diskIOPSReadWrite": { + "encryptionSettings": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/EncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + "description": "Encryption settings for disk or snapshot" }, - "diskMBpsReadWrite": { + "osType": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + "description": "The Operating System type." } }, "required": [ @@ -1274,27 +1471,27 @@ "EncryptionSettings": { "type": "object", "properties": { - "enabled": { + "diskEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultAndSecretReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + "description": "Key Vault Secret Url and vault id of the encryption key " }, - "diskEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultAndSecretReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." }, "keyEncryptionKey": { "oneOf": [ @@ -1305,7 +1502,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Key Url and vault id of the key encryption key" + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" } }, "description": "Encryption settings for disk or snapshot" @@ -1313,15 +1510,6 @@ "galleries_images_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -1332,62 +1520,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Definition." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/galleries_images_versions_childResource" - } - ] - } + "type": { + "type": "string", + "enum": [ + "images" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images" }, "galleries_images_versions_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -1398,37 +1579,49 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageVersionProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images/versions" }, @@ -1443,7 +1636,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The managed artifact." } }, "required": [ @@ -1452,27 +1646,29 @@ "description": "The source image from which the Image Version is going to be created." }, "GalleryIdentifier": { + "type": "object", + "properties": {}, "description": "Describes the gallery unique name." }, "GalleryImageIdentifier": { "type": "object", "properties": { - "publisher": { - "type": "string", - "description": "The name of the gallery Image Definition publisher." - }, "offer": { "type": "string", "description": "The name of the gallery Image Definition offer." }, + "publisher": { + "type": "string", + "description": "The name of the gallery Image Definition publisher." + }, "sku": { "type": "string", "description": "The name of the gallery Image Definition SKU." } }, "required": [ - "publisher", "offer", + "publisher", "sku" ], "description": "This is the gallery Image Definition identifier." @@ -1482,34 +1678,38 @@ "properties": { "description": { "type": "string", - "description": "The description of this gallery Image Definition resource. This property is updateable." + "description": "The description of this gallery Image Definition resource. This property is updatable." }, - "eula": { - "type": "string", - "description": "The Eula agreement for the gallery Image Definition." + "disallowed": { + "oneOf": [ + { + "$ref": "#/definitions/Disallowed" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the disallowed disk types." }, - "privacyStatementUri": { + "endOfLifeDate": { "type": "string", - "description": "The privacy statement uri." + "format": "date-time", + "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable." }, - "releaseNoteUri": { + "eula": { "type": "string", - "description": "The release note uri." + "description": "The Eula agreement for the gallery Image Definition." }, - "osType": { + "identifier": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/GalleryImageIdentifier" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." + "description": "This is the gallery Image Definition identifier." }, "osState": { "oneOf": [ @@ -1526,56 +1726,56 @@ ], "description": "The allowed values for OS State are 'Generalized'." }, - "endOfLifeDate": { - "type": "string", - "format": "date-time", - "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updateable." - }, - "identifier": { + "osType": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageIdentifier" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." }, - "recommended": { - "oneOf": [ - { - "$ref": "#/definitions/RecommendedMachineConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." }, - "disallowed": { + "purchasePlan": { "oneOf": [ { - "$ref": "#/definitions/Disallowed" + "$ref": "#/definitions/ImagePurchasePlan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." }, - "purchasePlan": { + "recommended": { "oneOf": [ { - "$ref": "#/definitions/ImagePurchasePlan" + "$ref": "#/definitions/RecommendedMachineConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." } }, "required": [ - "osType", + "identifier", "osState", - "identifier" + "osType" ], "description": "Describes the properties of a gallery Image Definition." }, @@ -1590,7 +1790,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The publishing profile of a gallery Image Version." } }, "required": [ @@ -1601,56 +1802,57 @@ "GalleryImageVersionPublishingProfile": { "type": "object", "properties": { - "targetRegions": { + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/TargetRegion" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The target regions where the Image Version is going to be replicated to. This property is updateable." + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." }, - "source": { + "replicaCount": { "oneOf": [ { - "$ref": "#/definitions/GalleryArtifactSource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." }, - "replicaCount": { + "source": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/GalleryArtifactSource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updateable." + "description": "The source image from which the Image Version is going to be created." }, - "excludeFromLatest": { + "targetRegions": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." - }, - "endOfLifeDate": { - "type": "string", - "format": "date-time", - "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updateable." + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." } }, "required": [ @@ -1663,7 +1865,7 @@ "properties": { "description": { "type": "string", - "description": "The description of this Shared Image Gallery resource. This property is updateable." + "description": "The description of this Shared Image Gallery resource. This property is updatable." }, "identifier": { "oneOf": [ @@ -1673,7 +1875,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the gallery unique name." } }, "description": "Describes the properties of a Shared Image Gallery." @@ -1866,69 +2069,67 @@ "ImageDataDisk": { "type": "object", "properties": { - "lun": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "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." }, - "caching": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + ] }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -1980,37 +2181,38 @@ "ImageOSDisk": { "type": "object", "properties": { - "osType": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "osState": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "snapshot": { + "managedDisk": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -2018,50 +2220,47 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The snapshot." + ] }, - "managedDisk": { + "osState": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "The OS State." }, - "caching": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -2082,8 +2281,8 @@ } }, "required": [ - "osType", - "osState" + "osState", + "osType" ], "description": "Describes an Operating System disk." }, @@ -2098,8 +2297,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The source virtual machine from which Image is created." + ] }, "storageProfile": { "oneOf": [ @@ -2110,7 +2308,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Describes a storage profile." } }, "description": "Describes the properties of an Image." @@ -2122,13 +2320,13 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "The product ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." @@ -2140,14 +2338,14 @@ "type": "string", "description": "Resource Id" }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, "offer": { "type": "string", "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, "sku": { "type": "string", "description": "The image SKU." @@ -2157,35 +2355,35 @@ "description": "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." } }, - "description": "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." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, "ImageStorageProfile": { "type": "object", "properties": { - "osDisk": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageOSDisk" + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } + "$ref": "#/definitions/ImageOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Describes an Operating System disk." }, "zoneResilient": { "oneOf": [ @@ -2208,6 +2406,10 @@ "type": "string", "description": "The status code." }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, "level": { "oneOf": [ { @@ -2224,10 +2426,6 @@ ], "description": "The level code." }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." @@ -2243,6 +2441,10 @@ "KeyVaultAndKeyReference": { "type": "object", "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, "sourceVault": { "oneOf": [ { @@ -2252,22 +2454,22 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "keyUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, "required": [ - "sourceVault", - "keyUrl" + "keyUrl", + "sourceVault" ], "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" }, "KeyVaultAndSecretReference": { "type": "object", "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, "sourceVault": { "oneOf": [ { @@ -2277,16 +2479,12 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "secretUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, "required": [ - "sourceVault", - "secretUrl" + "secretUrl", + "sourceVault" ], "description": "Key Vault Secret Url and vault id of the encryption key " }, @@ -2305,8 +2503,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the key." + ] } }, "required": [ @@ -2330,8 +2527,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the secret." + ] } }, "required": [ @@ -2354,27 +2550,27 @@ ], "description": "Specifies whether password authentication should be disabled." }, - "ssh": { + "provisionVMAgent": { "oneOf": [ { - "$ref": "#/definitions/SshConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ssh key configuration for a Linux OS." + "description": "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." }, - "provisionVMAgent": { + "ssh": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SshConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "SSH configuration for Linux based VMs running on Azure" } }, "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." @@ -2434,7 +2630,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a network interface reference properties." } }, "description": "Describes a network interface reference." @@ -2479,133 +2676,133 @@ "OSDisk": { "type": "object", "properties": { - "osType": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "vhd": { + "diffDiskSettings": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/DiffDiskSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "encryptionSettings": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes a Encryption Settings for a Disk" }, - "writeAcceleratorEnabled": { + "image": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "Describes the uri of a disk." }, - "diffDiskSettings": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/DiffDiskSettings" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine." + "description": "The parameters of a managed disk." }, - "createOption": { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "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**." }, - "diskSizeGB": { + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -2616,32 +2813,32 @@ "OSProfile": { "type": "object", "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

    **Max-length (Windows):** 15 characters

    **Max-length (Linux):** 64 characters.

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, "adminPassword": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, - "customData": { + "adminUsername": { "type": "string", - "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { + "allowExtensionOperations": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies Windows operating system settings on the virtual machine." + "description": "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." + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, "linuxConfiguration": { "oneOf": [ @@ -2668,16 +2865,16 @@ ], "description": "Specifies set of certificates that should be installed onto the virtual machine." }, - "allowExtensionOperations": { + "windowsConfiguration": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Specifies the operating system settings for the virtual machine." @@ -2689,10 +2886,6 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." @@ -2700,14 +2893,39 @@ "promotionCode": { "type": "string", "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, + "ProximityPlacementGroupProperties": { + "type": "object", + "properties": { + "proximityPlacementGroupType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard", + "Ultra" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, "RecommendedMachineConfiguration": { "type": "object", "properties": { - "vCPUs": { + "memory": { "oneOf": [ { "$ref": "#/definitions/ResourceRange" @@ -2715,9 +2933,10 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the resource range." }, - "memory": { + "vCPUs": { "oneOf": [ { "$ref": "#/definitions/ResourceRange" @@ -2725,15 +2944,16 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the resource range." } }, - "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updateable." + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." }, "ResourceRange": { "type": "object", "properties": { - "min": { + "max": { "oneOf": [ { "type": "integer" @@ -2742,9 +2962,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The minimum number of the resource." + "description": "The maximum number of the resource." }, - "max": { + "min": { "oneOf": [ { "type": "integer" @@ -2753,7 +2973,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The maximum number of the resource." + "description": "The minimum number of the resource." } }, "description": "Describes the resource range." @@ -2810,14 +3030,6 @@ "Sku": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, "capacity": { "oneOf": [ { @@ -2828,28 +3040,21 @@ } ], "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" } }, - "description": "Describes a virtual machine scale set sku." + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, "SnapshotProperties": { "type": "object", "properties": { - "osType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The Operating System type." - }, "creationData": { "oneOf": [ { @@ -2859,7 +3064,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "Data used when creating a disk." }, "diskSizeGB": { "oneOf": [ @@ -2882,6 +3087,21 @@ } ], "description": "Encryption settings for disk or snapshot" + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." } }, "required": [ @@ -2919,7 +3139,7 @@ "description": "Resource Id" } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "SshConfiguration": { "type": "object", @@ -2944,13 +3164,13 @@ "SshPublicKey": { "type": "object", "properties": { - "path": { - "type": "string", - "description": "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" - }, "keyData": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -2958,41 +3178,41 @@ "StorageProfile": { "type": "object", "properties": { - "imageReference": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "osDisk": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, "description": "Specifies the storage settings for the virtual machine disks." @@ -3022,7 +3242,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The number of replicas of the Image Version to be created per region. This property is updateable." + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." } }, "required": [ @@ -3031,70 +3251,74 @@ "description": "Describes the target region information." }, "UpgradePolicy": { - "type": "object", - "properties": { - "mode": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Automatic", - "Manual", - "Rolling" - ] + "type": "object", + "properties": { + "automaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." }, - "rollingUpgradePolicy": { + "autoOSUpgradePolicy": { "oneOf": [ { - "$ref": "#/definitions/RollingUpgradePolicy" + "$ref": "#/definitions/AutoOSUpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The configuration parameters used while performing a rolling upgrade." + "description": "The configuration parameters used for performing automatic OS upgrade." }, - "automaticOSUpgrade": { + "mode": { "oneOf": [ { - "type": "boolean" + "type": "string", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." }, - "autoOSUpgradePolicy": { + "rollingUpgradePolicy": { "oneOf": [ { - "$ref": "#/definitions/AutoOSUpgradePolicy" + "$ref": "#/definitions/RollingUpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Configuration parameters used for performing automatic OS Upgrade." + "description": "The configuration parameters used while performing a rolling upgrade." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." }, + "UserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VaultCertificate": { "type": "object", "properties": { - "certificateUrl": { + "certificateStore": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + "description": "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." }, - "certificateStore": { + "certificateUrl": { "type": "string", - "description": "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 .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -3110,8 +3334,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + ] }, "vaultCertificates": { "oneOf": [ @@ -3147,15 +3370,7 @@ "type": "string", "description": "The virtual machine extension name." }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { + "statuses": { "oneOf": [ { "type": "array", @@ -3169,7 +3384,7 @@ ], "description": "The resource status information." }, - "statuses": { + "substatuses": { "oneOf": [ { "type": "array", @@ -3182,20 +3397,6 @@ } ], "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." }, "type": { "type": "string", @@ -3204,7 +3405,13 @@ "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." - }, + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { "autoUpgradeMinorVersion": { "oneOf": [ { @@ -3216,11 +3423,9 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." }, "instanceView": { "oneOf": [ @@ -3231,7 +3436,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine extension instance view." + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -3240,12 +3467,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "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." }, @@ -3254,8 +3488,9 @@ { "type": "object", "additionalProperties": { - "$ref": "#/definitions/VirtualMachineIdentityUserAssignedIdentitiesValue" - } + "$ref": "#/definitions/UserAssignedIdentitiesValue" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -3266,32 +3501,9 @@ }, "description": "Identity for the virtual machine." }, - "VirtualMachineIdentityUserAssignedIdentitiesValue": {}, "VirtualMachineProperties": { "type": "object", "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, "additionalCapabilities": { "oneOf": [ { @@ -3301,29 +3513,17 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "networkProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/NetworkProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the network interfaces of the virtual machine." + ] }, "diagnosticsProfile": { "oneOf": [ @@ -3336,197 +3536,70 @@ ], "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "availabilitySet": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies the hardware settings for the virtual machine." }, "licenseType": { "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2018-06-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" + "$ref": "#/definitions/NetworkProfile" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" + "$ref": "#/definitions/OSProfile" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine." + }, + "proximityPlacementGroup": { + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" + "$ref": "#/definitions/SubResource" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "VirtualMachineScaleSetDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." }, - "lun": { + "storageProfile": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." - }, + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "properties": { "caching": { "oneOf": [ { @@ -3543,17 +3616,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -3581,6 +3643,17 @@ ], "description": "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.

    This value cannot be larger than 1023 GB" }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, "managedDisk": { "oneOf": [ { @@ -3590,12 +3663,27 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a virtual machine scale set data disk." }, @@ -3607,113 +3695,15 @@ "description": "The name of the extension." }, "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-06-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, "description": "Describes a Virtual Machine Scale Set Extension." @@ -3741,38 +3731,56 @@ "VirtualMachineScaleSetExtensionProperties": { "type": "object", "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, "forceUpdateTag": { "type": "string", "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, - "autoUpgradeMinorVersion": { + "provisionAfterExtensions": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." }, "settings": { + "type": "object", + "properties": {}, "description": "Json formatted public settings for the extension." }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." @@ -3781,12 +3789,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of identity used for the virtual machine scale set. 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 scale set." }, @@ -3796,7 +3811,8 @@ "type": "object", "additionalProperties": { "$ref": "#/definitions/VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -3807,7 +3823,10 @@ }, "description": "Identity for the virtual machine scale set." }, - "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": {}, + "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VirtualMachineScaleSetIPConfiguration": { "type": "object", "properties": { @@ -3827,7 +3846,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, "required": [ @@ -3838,109 +3858,109 @@ "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "subnet": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/ApiEntityReference" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the identifier of the subnet." + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, - "primary": { + "applicationSecurityGroups": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Specifies an array of references to application security group." }, - "publicIPAddressConfiguration": { + "loadBalancerBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The publicIPAddressConfiguration." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." }, - "privateIPAddressVersion": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" }, - "applicationGatewayBackendAddressPools": { + "primary": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, - "applicationSecurityGroups": { + "privateIPAddressVersion": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to application security group." + "description": "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'." }, - "loadBalancerBackendAddressPools": { + "publicIPAddressConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "loadBalancerInboundNatPools": { + "subnet": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + "description": "The API entity reference." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -4001,7 +4021,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." } }, "required": [ @@ -4032,16 +4053,16 @@ "VirtualMachineScaleSetNetworkConfigurationProperties": { "type": "object", "properties": { - "primary": { + "dnsSettings": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "enableAcceleratedNetworking": { "oneOf": [ @@ -4054,43 +4075,42 @@ ], "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "networkSecurityGroup": { + "enableIPForwarding": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network security group." + "description": "Whether IP forwarding enabled on this NIC." }, - "dnsSettings": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the network interfaces." + "description": "Specifies the IP configurations of the network interface." }, - "ipConfigurations": { + "networkSecurityGroup": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the IP configurations of the network interface." + ] }, - "enableIPForwarding": { + "primary": { "oneOf": [ { "type": "boolean" @@ -4099,7 +4119,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether IP forwarding enabled on this NIC." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." } }, "required": [ @@ -4119,7 +4139,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + "description": "The API entity reference." }, "networkInterfaceConfigurations": { "oneOf": [ @@ -4141,10 +4161,6 @@ "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, "caching": { "oneOf": [ { @@ -4161,17 +4177,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -4197,7 +4202,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine scale set." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, "diskSizeGB": { "oneOf": [ @@ -4210,31 +4215,46 @@ ], "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "osType": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Describes the uri of a disk." }, - "image": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the unmanaged user image to base the scale set on." + "description": "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**." }, "vhdContainers": { "oneOf": [ @@ -4250,16 +4270,16 @@ ], "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -4270,33 +4290,22 @@ "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "computerNamePrefix": { + "adminPassword": { "type": "string", - "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerNamePrefix": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, "linuxConfiguration": { "oneOf": [ { @@ -4321,6 +4330,17 @@ } ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Describes a virtual machine scale set OS profile." @@ -4328,38 +4348,37 @@ "VirtualMachineScaleSetProperties": { "type": "object", "properties": { - "upgradePolicy": { + "overprovision": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, - "virtualMachineProfile": { + "platformFaultDomainCount": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "Fault Domain count for each placement group." }, - "overprovision": { + "proximityPlacementGroup": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + ] }, "singlePlacementGroup": { "oneOf": [ @@ -4372,27 +4391,38 @@ ], "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "zoneBalance": { + "upgradePolicy": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/UpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "platformFaultDomainCount": { + "virtualMachineProfile": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count for each placement group." + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "zoneBalance": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -4412,7 +4442,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" } }, "required": [ @@ -4436,27 +4467,27 @@ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "type": "object", "properties": { - "idleTimeoutInMinutes": { + "dnsSettings": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The idle timeout of the public IP address." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, - "dnsSettings": { + "idleTimeoutInMinutes": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the publicIP addresses ." + "description": "The idle timeout of the public IP address." }, "ipTags": { "oneOf": [ @@ -4480,30 +4511,66 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The PublicIPPrefix from which to allocate publicIP addresses." + ] } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "virtualMachineScaleSets_extensions_childResource": { + "VirtualMachineScaleSetStorageProfile": { "type": "object", "properties": { - "name": { - "type": "string" + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { "apiVersion": { "type": "string", "enum": [ "2018-06-01" ] }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, "properties": { "oneOf": [ { @@ -4512,29 +4579,27 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" ] } }, "required": [ - "name", - "type", "apiVersion", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, "virtualMachineScaleSets_virtualmachines_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -4545,19 +4610,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "oneOf": [ @@ -4567,106 +4633,94 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, - "VirtualMachineScaleSetStorageProfile": { + "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "imageReference": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "osDisk": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview." }, - "storageProfile": { + "extensionProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Describes a virtual machine scale set extension profile." }, - "additionalCapabilities": { - "oneOf": [ - { - "$ref": "#/definitions/AdditionalCapabilities" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -4677,33 +4731,18 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Describes a virtual machine scale set network profile." }, - "extensionProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Describes a virtual machine scale set OS profile." }, "priority": { "oneOf": [ @@ -4720,20 +4759,16 @@ ], "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." }, - "evictionPolicy": { + "storageProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "Deallocate", - "Delete" - ] + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview." + "description": "Describes a virtual machine scale set storage profile." } }, "description": "Describes a virtual machine scale set virtual machine profile." @@ -4741,49 +4776,52 @@ "VirtualMachineScaleSetVMProperties": { "type": "object", "properties": { - "hardwareProfile": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the hardware settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "storageProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "additionalCapabilities": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -4796,64 +4834,93 @@ ], "description": "Specifies the network interfaces of the virtual machine." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the operating system settings for the virtual machine." }, - "availabilitySet": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Specifies the storage settings for the virtual machine disks." } }, "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "WindowsConfiguration": { + "virtualMachines_extensions_childResource": { "type": "object", "properties": { - "provisionVMAgent": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Describes the properties of a Virtual Machine Extension." }, - "enableAutomaticUpdates": { + "tags": { "oneOf": [ { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether virtual machine is enabled for automatic updates." + "description": "Resource tags" }, - "timeZone": { + "type": { "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { "additionalUnattendContent": { "oneOf": [ { @@ -4868,6 +4935,32 @@ ], "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, "winRM": { "oneOf": [ { @@ -4877,7 +4970,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + "description": "Describes Windows Remote Management configuration of the VM" } }, "description": "Specifies Windows operating system settings on the virtual machine." @@ -4905,6 +4998,10 @@ "WinRMListener": { "type": "object", "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, "protocol": { "oneOf": [ { @@ -4919,10 +5016,6 @@ } ], "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" diff --git a/schemas/2018-09-30/Microsoft.Compute.json b/schemas/2018-09-30/Microsoft.Compute.json new file mode 100644 index 0000000000..706d33e9ac --- /dev/null +++ b/schemas/2018-09-30/Microsoft.Compute.json @@ -0,0 +1,573 @@ +{ + "id": "https://schema.management.azure.com/schemas/2018-09-30/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "disks": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Disk resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/DiskSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logical zone list for Disk." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/disks" + }, + "snapshots": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Snapshot resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/snapshots" + } + }, + "definitions": { + "CreationData": { + "type": "object", + "properties": { + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This enumerates the possible sources of a disk's creation." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "DiskProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "EncryptionSettingsCollection": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of encryption settings, one for each disk volume." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + }, + "description": "Encryption settings for one disk volume." + }, + "ImageDiskReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "KeyVaultAndKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "KeyVaultAndSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "SourceVault": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } +} diff --git a/schemas/2018-10-01/Microsoft.Compute.json b/schemas/2018-10-01/Microsoft.Compute.json index 7425ab5a54..1051e69d21 100644 --- a/schemas/2018-10-01/Microsoft.Compute.json +++ b/schemas/2018-10-01/Microsoft.Compute.json @@ -7,15 +7,6 @@ "availabilitySets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -26,63 +17,66 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/AvailabilitySetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The instance view of a resource." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/AvailabilitySetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/availabilitySets" }, "images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -93,52 +87,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of an Image." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/images" }, - "virtualMachines": { + "proximityPlacementGroups": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -149,13 +146,29 @@ "type": "string", "description": "Resource location" }, + "name": { + "type": "string", + "description": "The name of the proximity placement group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProximityPlacementGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Proximity Placement Group." + }, "tags": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -163,6 +176,50 @@ ], "description": "Resource tags" }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/proximityPlacementGroups" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/proximityPlacementGroups" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, "plan": { "oneOf": [ { @@ -182,18 +239,39 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine." }, - "identity": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] }, "zones": { "oneOf": [ @@ -208,56 +286,99 @@ } ], "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachines" }, "virtualMachineScaleSets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, "apiVersion": { "type": "string", "enum": [ "2018-10-01" ] }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, "location": { "type": "string", "description": "Resource location" }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, "tags": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -265,98 +386,148 @@ ], "description": "Resource tags" }, - "sku": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + }, + "zones": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set sku." + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachineScaleSets_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] }, - "plan": { + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Describes the properties of a Virtual Machine Scale Set Extension." }, - "properties": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "identity": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine scale set, if configured." + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set zones." + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" - }, - { - "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" - } - ] - } + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets" + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, - "virtualMachineScaleSets_virtualmachines": { + "virtualMachines_extensions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -367,50 +538,51 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the virtual machine extension." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Extension." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + "description": "Microsoft.Compute/virtualMachines/extensions" } }, "definitions": { @@ -434,33 +606,37 @@ "AdditionalUnattendContent": { "type": "object", "properties": { - "passName": { + "componentName": { "oneOf": [ { "type": "string", "enum": [ - "OobeSystem" + "Microsoft-Windows-Shell-Setup" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." }, - "componentName": { + "content": { + "type": "string", + "description": "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." + }, + "passName": { "oneOf": [ { "type": "string", "enum": [ - "Microsoft-Windows-Shell-Setup" + "OobeSystem" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "The pass name. Currently, the only allowable value is OobeSystem." }, "settingName": { "oneOf": [ @@ -476,10 +652,6 @@ } ], "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." } }, "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." @@ -497,7 +669,7 @@ "AutomaticOSUpgradePolicy": { "type": "object", "properties": { - "enableAutomaticOSUpgrade": { + "disableAutomaticRollback": { "oneOf": [ { "type": "boolean" @@ -506,9 +678,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. Default value is false." + "description": "Whether OS image rollback feature should be disabled. Default value is false." }, - "disableAutomaticRollback": { + "enableAutomaticOSUpgrade": { "oneOf": [ { "type": "boolean" @@ -517,25 +689,35 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether OS image rollback feature should be disabled. Default value is false." + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, recommendation is to set [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) to false." } }, "description": "The configuration parameters used for performing automatic OS upgrade." }, - "AvailabilitySetProperties": { + "AutomaticRepairsPolicy": { "type": "object", "properties": { - "platformUpdateDomainCount": { + "enabled": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Update Domain count." + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { "platformFaultDomainCount": { "oneOf": [ { @@ -547,6 +729,27 @@ ], "description": "Fault Domain count." }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, "virtualMachines": { "oneOf": [ { @@ -588,112 +791,112 @@ "DataDisk": { "type": "object", "properties": { - "lun": { + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "vhd": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes the uri of a disk." }, - "writeAcceleratorEnabled": { + "lun": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "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." }, - "createOption": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "The parameters of a managed disk." }, - "diskSizeGB": { + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a data disk." }, @@ -746,29 +949,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + "description": "Describes a reference to Key Vault Secret" }, - "keyEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the key encryption key in Key Vault." + "description": "Specifies whether disk encryption should be enabled on the virtual machine." }, - "enabled": { + "keyEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "Describes a reference to Key Vault Key" } }, "description": "Describes a Encryption Settings for a Disk" @@ -961,69 +1164,67 @@ "ImageDataDisk": { "type": "object", "properties": { - "lun": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "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." }, - "caching": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + ] }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -1051,37 +1252,38 @@ "ImageOSDisk": { "type": "object", "properties": { - "osType": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "osState": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "Generalized", - "Specialized" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "snapshot": { + "managedDisk": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -1089,50 +1291,47 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The snapshot." + ] }, - "managedDisk": { + "osState": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "The OS State." }, - "caching": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -1153,8 +1352,8 @@ } }, "required": [ - "osType", - "osState" + "osState", + "osType" ], "description": "Describes an Operating System disk." }, @@ -1169,8 +1368,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The source virtual machine from which Image is created." + ] }, "storageProfile": { "oneOf": [ @@ -1181,7 +1379,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Describes a storage profile." } }, "description": "Describes the properties of an Image." @@ -1193,14 +1391,14 @@ "type": "string", "description": "Resource Id" }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, "offer": { "type": "string", "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, "sku": { "type": "string", "description": "The image SKU." @@ -1210,35 +1408,35 @@ "description": "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." } }, - "description": "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." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, "ImageStorageProfile": { "type": "object", "properties": { - "osDisk": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageOSDisk" + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } + "$ref": "#/definitions/ImageOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Describes an Operating System disk." }, "zoneResilient": { "oneOf": [ @@ -1261,6 +1459,10 @@ "type": "string", "description": "The status code." }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, "level": { "oneOf": [ { @@ -1277,10 +1479,6 @@ ], "description": "The level code." }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." @@ -1308,8 +1506,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the key." + ] } }, "required": [ @@ -1333,8 +1530,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the secret." + ] } }, "required": [ @@ -1357,27 +1553,27 @@ ], "description": "Specifies whether password authentication should be disabled." }, - "ssh": { + "provisionVMAgent": { "oneOf": [ { - "$ref": "#/definitions/SshConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ssh key configuration for a Linux OS." + "description": "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." }, - "provisionVMAgent": { + "ssh": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SshConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "SSH configuration for Linux based VMs running on Azure" } }, "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." @@ -1424,7 +1620,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a network interface reference properties." } }, "description": "Describes a network interface reference." @@ -1469,133 +1666,133 @@ "OSDisk": { "type": "object", "properties": { - "osType": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "vhd": { + "diffDiskSettings": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/DiffDiskSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "encryptionSettings": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes a Encryption Settings for a Disk" }, - "writeAcceleratorEnabled": { + "image": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "Describes the uri of a disk." }, - "diffDiskSettings": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/DiffDiskSettings" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + "description": "The parameters of a managed disk." }, - "createOption": { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "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**." }, - "diskSizeGB": { + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -1606,32 +1803,32 @@ "OSProfile": { "type": "object", "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

    **Max-length (Windows):** 15 characters

    **Max-length (Linux):** 64 characters.

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, "adminPassword": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, - "customData": { + "adminUsername": { "type": "string", - "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { + "allowExtensionOperations": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies Windows operating system settings on the virtual machine." + "description": "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." + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, "linuxConfiguration": { "oneOf": [ @@ -1658,16 +1855,16 @@ ], "description": "Specifies set of certificates that should be installed onto the virtual machine." }, - "allowExtensionOperations": { + "windowsConfiguration": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Specifies the operating system settings for the virtual machine." @@ -1679,10 +1876,6 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." @@ -1690,10 +1883,35 @@ "promotionCode": { "type": "string", "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, + "ProximityPlacementGroupProperties": { + "type": "object", + "properties": { + "proximityPlacementGroupType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard", + "Ultra" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, "RollingUpgradePolicy": { "type": "object", "properties": { @@ -1746,14 +1964,6 @@ "Sku": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, "capacity": { "oneOf": [ { @@ -1764,9 +1974,17 @@ } ], "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" } }, - "description": "Describes a virtual machine scale set sku." + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, "SshConfiguration": { "type": "object", @@ -1791,13 +2009,13 @@ "SshPublicKey": { "type": "object", "properties": { - "path": { - "type": "string", - "description": "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" - }, "keyData": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -1805,41 +2023,41 @@ "StorageProfile": { "type": "object", "properties": { - "imageReference": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "osDisk": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, "description": "Specifies the storage settings for the virtual machine disks." @@ -1856,6 +2074,17 @@ "UpgradePolicy": { "type": "object", "properties": { + "automaticOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, "mode": { "oneOf": [ { @@ -1882,31 +2111,24 @@ } ], "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/AutomaticOSUpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Configuration parameters used for performing automatic OS Upgrade." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." }, + "UserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VaultCertificate": { "type": "object", "properties": { - "certificateUrl": { + "certificateStore": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + "description": "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." }, - "certificateStore": { + "certificateUrl": { "type": "string", - "description": "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 .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -1922,8 +2144,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + ] }, "vaultCertificates": { "oneOf": [ @@ -1959,15 +2180,7 @@ "type": "string", "description": "The virtual machine extension name." }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { + "statuses": { "oneOf": [ { "type": "array", @@ -1981,7 +2194,7 @@ ], "description": "The resource status information." }, - "statuses": { + "substatuses": { "oneOf": [ { "type": "array", @@ -1994,20 +2207,6 @@ } ], "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." }, "type": { "type": "string", @@ -2016,7 +2215,13 @@ "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." - }, + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { "autoUpgradeMinorVersion": { "oneOf": [ { @@ -2028,11 +2233,9 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." }, "instanceView": { "oneOf": [ @@ -2043,7 +2246,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine extension instance view." + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -2052,12 +2277,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "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." }, @@ -2066,8 +2298,9 @@ { "type": "object", "additionalProperties": { - "$ref": "#/definitions/VirtualMachineIdentityUserAssignedIdentitiesValue" - } + "$ref": "#/definitions/UserAssignedIdentitiesValue" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -2078,32 +2311,9 @@ }, "description": "Identity for the virtual machine." }, - "VirtualMachineIdentityUserAssignedIdentitiesValue": {}, "VirtualMachineProperties": { "type": "object", "properties": { - "hardwareProfile": { - "oneOf": [ - { - "$ref": "#/definitions/HardwareProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "oneOf": [ - { - "$ref": "#/definitions/StorageProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the storage settings for the virtual machine disks." - }, "additionalCapabilities": { "oneOf": [ { @@ -2113,29 +2323,17 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine." - }, - "osProfile": { - "oneOf": [ - { - "$ref": "#/definitions/OSProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "networkProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/NetworkProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the network interfaces of the virtual machine." + ] }, "diagnosticsProfile": { "oneOf": [ @@ -2148,197 +2346,70 @@ ], "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "availabilitySet": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies the hardware settings for the virtual machine." }, "licenseType": { "type": "string", "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2018-10-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" }, - "tags": { + "networkProfile": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" + "$ref": "#/definitions/NetworkProfile" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" + "$ref": "#/definitions/OSProfile" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine." + }, + "proximityPlacementGroup": { + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" + "$ref": "#/definitions/SubResource" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "VirtualMachineScaleSetDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." }, - "lun": { + "storageProfile": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." - }, + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "properties": { "caching": { "oneOf": [ { @@ -2355,17 +2426,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -2393,6 +2453,17 @@ ], "description": "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.

    This value cannot be larger than 1023 GB" }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, "managedDisk": { "oneOf": [ { @@ -2402,12 +2473,27 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a virtual machine scale set data disk." }, @@ -2419,113 +2505,15 @@ "description": "The name of the extension." }, "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2018-10-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, "description": "Describes a Virtual Machine Scale Set Extension." @@ -2553,22 +2541,6 @@ "VirtualMachineScaleSetExtensionProperties": { "type": "object", "properties": { - "forceUpdateTag": { - "type": "string", - "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, "autoUpgradeMinorVersion": { "oneOf": [ { @@ -2580,10 +2552,13 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." }, "protectedSettings": { + "type": "object", + "properties": {}, "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, "provisionAfterExtensions": { @@ -2599,6 +2574,23 @@ } ], "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." @@ -2607,12 +2599,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of identity used for the virtual machine scale set. 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 scale set." }, @@ -2622,7 +2621,8 @@ "type": "object", "additionalProperties": { "$ref": "#/definitions/VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -2633,7 +2633,10 @@ }, "description": "Identity for the virtual machine scale set." }, - "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": {}, + "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VirtualMachineScaleSetIPConfiguration": { "type": "object", "properties": { @@ -2653,7 +2656,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, "required": [ @@ -2664,109 +2668,109 @@ "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "subnet": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/ApiEntityReference" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the identifier of the subnet." + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, - "primary": { + "applicationSecurityGroups": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Specifies an array of references to application security group." }, - "publicIPAddressConfiguration": { + "loadBalancerBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The publicIPAddressConfiguration." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." }, - "privateIPAddressVersion": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" }, - "applicationGatewayBackendAddressPools": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "primary": { + "oneOf": [ + { + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, - "applicationSecurityGroups": { + "privateIPAddressVersion": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to application security group." + "description": "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'." }, - "loadBalancerBackendAddressPools": { + "publicIPAddressConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "loadBalancerInboundNatPools": { + "subnet": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + "description": "The API entity reference." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -2827,7 +2831,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." } }, "required": [ @@ -2858,16 +2863,16 @@ "VirtualMachineScaleSetNetworkConfigurationProperties": { "type": "object", "properties": { - "primary": { + "dnsSettings": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "enableAcceleratedNetworking": { "oneOf": [ @@ -2880,43 +2885,42 @@ ], "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "networkSecurityGroup": { + "enableIPForwarding": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network security group." + "description": "Whether IP forwarding enabled on this NIC." }, - "dnsSettings": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the network interfaces." + "description": "Specifies the IP configurations of the network interface." }, - "ipConfigurations": { + "networkSecurityGroup": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the IP configurations of the network interface." + ] }, - "enableIPForwarding": { + "primary": { "oneOf": [ { "type": "boolean" @@ -2925,7 +2929,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether IP forwarding enabled on this NIC." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." } }, "required": [ @@ -2945,7 +2949,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + "description": "The API entity reference." }, "networkInterfaceConfigurations": { "oneOf": [ @@ -2967,10 +2971,6 @@ "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, "caching": { "oneOf": [ { @@ -2987,17 +2987,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -3023,7 +3012,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, "diskSizeGB": { "oneOf": [ @@ -3036,31 +3025,46 @@ ], "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "osType": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Describes the uri of a disk." }, - "image": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the unmanaged user image to base the scale set on." + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." }, "vhdContainers": { "oneOf": [ @@ -3076,16 +3080,16 @@ ], "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -3096,33 +3100,22 @@ "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "computerNamePrefix": { + "adminPassword": { "type": "string", - "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerNamePrefix": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, "linuxConfiguration": { "oneOf": [ { @@ -3147,6 +3140,17 @@ } ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Describes a virtual machine scale set OS profile." @@ -3154,27 +3158,27 @@ "VirtualMachineScaleSetProperties": { "type": "object", "properties": { - "upgradePolicy": { + "automaticRepairsPolicy": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "$ref": "#/definitions/AutomaticRepairsPolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." }, - "virtualMachineProfile": { + "doNotRunExtensionsOnOverprovisionedVMs": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." }, "overprovision": { "oneOf": [ @@ -3187,6 +3191,27 @@ ], "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, "singlePlacementGroup": { "oneOf": [ { @@ -3198,27 +3223,38 @@ ], "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "zoneBalance": { + "upgradePolicy": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/UpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "platformFaultDomainCount": { + "virtualMachineProfile": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count for each placement group." + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "zoneBalance": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -3238,7 +3274,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" } }, "required": [ @@ -3262,27 +3299,27 @@ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "type": "object", "properties": { - "idleTimeoutInMinutes": { + "dnsSettings": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The idle timeout of the public IP address." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, - "dnsSettings": { + "idleTimeoutInMinutes": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the publicIP addresses ." + "description": "The idle timeout of the public IP address." }, "ipTags": { "oneOf": [ @@ -3306,30 +3343,66 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The PublicIPPrefix from which to allocate publicIP addresses." + ] } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "virtualMachineScaleSets_extensions_childResource": { + "VirtualMachineScaleSetStorageProfile": { "type": "object", "properties": { - "name": { - "type": "string" + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { "apiVersion": { "type": "string", "enum": [ "2018-10-01" ] }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, "properties": { "oneOf": [ { @@ -3338,29 +3411,27 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" ] } }, "required": [ - "name", - "type", "apiVersion", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, "virtualMachineScaleSets_virtualmachines_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -3371,19 +3442,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "oneOf": [ @@ -3393,106 +3465,94 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, - "VirtualMachineScaleSetStorageProfile": { + "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "imageReference": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "osDisk": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "dataDisks": { - "oneOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetVMProfile": { - "type": "object", - "properties": { - "osProfile": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview." }, - "storageProfile": { + "extensionProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Describes a virtual machine scale set extension profile." }, - "additionalCapabilities": { - "oneOf": [ - { - "$ref": "#/definitions/AdditionalCapabilities" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -3503,33 +3563,18 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." - }, - "diagnosticsProfile": { - "oneOf": [ - { - "$ref": "#/definitions/DiagnosticsProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Describes a virtual machine scale set network profile." }, - "extensionProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Describes a virtual machine scale set OS profile." }, "priority": { "oneOf": [ @@ -3546,20 +3591,16 @@ ], "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." }, - "evictionPolicy": { + "storageProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "Deallocate", - "Delete" - ] + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview." + "description": "Describes a virtual machine scale set storage profile." } }, "description": "Describes a virtual machine scale set virtual machine profile." @@ -3567,49 +3608,52 @@ "VirtualMachineScaleSetVMProperties": { "type": "object", "properties": { - "hardwareProfile": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the hardware settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "storageProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "additionalCapabilities": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -3622,64 +3666,93 @@ ], "description": "Specifies the network interfaces of the virtual machine." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the operating system settings for the virtual machine." }, - "availabilitySet": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Specifies the storage settings for the virtual machine disks." } }, "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "WindowsConfiguration": { + "virtualMachines_extensions_childResource": { "type": "object", "properties": { - "provisionVMAgent": { + "apiVersion": { + "type": "string", + "enum": [ + "2018-10-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Describes the properties of a Virtual Machine Extension." }, - "enableAutomaticUpdates": { + "tags": { "oneOf": [ { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether virtual machine is enabled for automatic updates." + "description": "Resource tags" }, - "timeZone": { + "type": { "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { "additionalUnattendContent": { "oneOf": [ { @@ -3694,6 +3767,32 @@ ], "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether virtual machine is enabled for automatic Windows updates. Default value is true.

    For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, "winRM": { "oneOf": [ { @@ -3703,7 +3802,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + "description": "Describes Windows Remote Management configuration of the VM" } }, "description": "Specifies Windows operating system settings on the virtual machine." @@ -3731,6 +3830,10 @@ "WinRMListener": { "type": "object", "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, "protocol": { "oneOf": [ { @@ -3745,10 +3848,6 @@ } ], "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" diff --git a/schemas/2019-03-01/Microsoft.Compute.json b/schemas/2019-03-01/Microsoft.Compute.json index 5cdd58de3d..42e80f3ab9 100644 --- a/schemas/2019-03-01/Microsoft.Compute.json +++ b/schemas/2019-03-01/Microsoft.Compute.json @@ -7,15 +7,6 @@ "availabilitySets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -26,63 +17,66 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/AvailabilitySetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The instance view of a resource." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/AvailabilitySetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/availabilitySets" }, - "hostGroups": { + "disks": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/hostGroups" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -93,28 +87,51 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DiskProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Disk resource properties." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/DedicatedHostGroupProperties" + "$ref": "#/definitions/DiskSku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" ] }, "zones": { @@ -129,40 +146,21 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hostGroups_hosts_childResource" - } - ] - } + "description": "The Logical zone list for Disk." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/hostGroups" + "description": "Microsoft.Compute/disks" }, - "hostGroups_hosts": { + "galleries": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/hostGroups/hosts" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -173,64 +171,68 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/DedicatedHostProperties" + "$ref": "#/definitions/GalleryProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Shared Image Gallery." }, - "sku": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_images_childResource" + }, + { + "$ref": "#/definitions/galleries_applications_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", + "name", "properties", - "sku" + "type" ], - "description": "Microsoft.Compute/hostGroups/hosts" + "description": "Microsoft.Compute/galleries" }, - "images": { + "galleries_applications": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -241,52 +243,65 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryApplicationProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Application Definition." }, - "properties": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_applications_versions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/images" + "description": "Microsoft.Compute/galleries/applications" }, - "proximityPlacementGroups": { + "galleries_applications_versions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/proximityPlacementGroups" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -297,53 +312,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryApplicationVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ProximityPlacementGroupProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Describes the properties of a Proximity Placement Group." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications/versions" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/proximityPlacementGroups" + "description": "Microsoft.Compute/galleries/applications/versions" }, - "virtualMachines": { + "galleries_images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -354,98 +371,124 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Definition." }, - "plan": { - "oneOf": [ - { - "$ref": "#/definitions/Plan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_images_versions_childResource" + } + ] + } }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images" + }, + "galleries_images_versions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" ] }, - "identity": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineIdentity" + "$ref": "#/definitions/GalleryImageVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine, if configured." + "description": "Describes the properties of a gallery Image Version." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine zones." + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images/versions" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachines" + "description": "Microsoft.Compute/galleries/images/versions" }, - "virtualMachineScaleSets": { + "hostGroups": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -456,112 +499,150 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the dedicated host group." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DedicatedHostGroupProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Dedicated Host Group Properties." }, - "sku": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/hostGroups_hosts_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set sku." + "description": "Resource tags" }, - "plan": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups" + ] + }, + "zones": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/hostGroups" + }, + "hostGroups_hosts": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host ." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" + "$ref": "#/definitions/DedicatedHostProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Properties of the dedicated host." }, - "identity": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine scale set, if configured." + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set zones." + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" - }, - { - "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" - } - ] - } + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups/hosts" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "sku", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets" + "description": "Microsoft.Compute/hostGroups/hosts" }, - "virtualMachineScaleSets_virtualmachines": { + "images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -572,57 +653,1265 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the image." }, "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of an Image." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - } - }, - "definitions": { - "AdditionalCapabilities": { + "description": "Microsoft.Compute/images" + }, + "proximityPlacementGroups": { "type": "object", "properties": { - "ultraSSDEnabled": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the proximity placement group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProximityPlacementGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Proximity Placement Group." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/proximityPlacementGroups" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/proximityPlacementGroups" + }, + "snapshots": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Snapshot resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/snapshots" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine zones." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" + }, + "virtualMachineScaleSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachineScaleSets_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { + "AdditionalCapabilities": { + "type": "object", + "properties": { + "ultraSSDEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + }, + "content": { + "type": "string", + "description": "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." + }, + "passName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "OobeSystem" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The pass name. Currently, the only allowable value is OobeSystem." + }, + "settingName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AutomaticOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutomaticRollback": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS image rollback feature should be disabled. Default value is false." + }, + "enableAutomaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "AutomaticRepairsPolicy": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "virtualMachines": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of references to all virtual machines in the availability set." + } + }, + "description": "The instance view of a resource." + }, + "BillingProfile": { + "type": "object", + "properties": { + "maxPrice": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "BootDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "CreationData": { + "type": "object", + "properties": { + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This enumerates the possible sources of a disk's creation." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription" + }, + "uploadSizeBytes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "DataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "toBeDetached": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a data disk." + }, + "DedicatedHostGroupProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 3 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of fault domains that the host group can span." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostProperties": { + "type": "object", + "properties": { + "autoReplaceOnFailure": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "licenseType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**." + }, + "platformFaultDomain": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault domain of the dedicated host within a dedicated host group." + } + }, + "description": "Properties of the dedicated host." + }, + "DiagnosticsProfile": { + "type": "object", + "properties": { + "bootDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/BootDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "DiffDiskSettings": { + "type": "object", + "properties": { + "option": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Local" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the ephemeral disk settings for operating system disk." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "Disallowed": { + "type": "object", + "properties": { + "diskTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Secret" + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Key" + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "DiskProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "EncryptionSettingsCollection": { + "type": "object", + "properties": { + "enabled": { "oneOf": [ { "type": "boolean" @@ -631,106 +1920,365 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." } }, - "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" }, - "AdditionalUnattendContent": { + "EncryptionSettingsElement": { "type": "object", "properties": { - "passName": { + "diskEncryptionKey": { "oneOf": [ { - "type": "string", - "enum": [ - "OobeSystem" - ] + "$ref": "#/definitions/KeyVaultAndSecretReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." + "description": "Key Vault Secret Url and vault id of the encryption key " }, - "componentName": { + "keyEncryptionKey": { "oneOf": [ { - "type": "string", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ] + "$ref": "#/definitions/KeyVaultAndKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + }, + "description": "Encryption settings for one disk volume." + }, + "galleries_applications_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] }, - "settingName": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "string", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ] + "$ref": "#/definitions/GalleryApplicationProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + "description": "Describes the properties of a gallery Application Definition." }, - "content": { + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { "type": "string", - "description": "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." + "enum": [ + "applications" + ] } }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications" }, - "ApiEntityReference": { + "galleries_applications_versions_childResource": { "type": "object", "properties": { - "id": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications/versions" + }, + "galleries_images_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Definition." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images" + }, + "galleries_images_versions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images/versions" + }, + "GalleryApplicationProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Application Definition resource. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Application Definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "AutomaticOSUpgradePolicy": { - "type": "object", - "properties": { - "enableAutomaticOSUpgrade": { + "description": "The release note uri." + }, + "supportedOSType": { "oneOf": [ { - "type": "boolean" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." - }, - "disableAutomaticRollback": { + "description": "This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux**." + } + }, + "required": [ + "supportedOSType" + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "GalleryApplicationVersionProperties": { + "type": "object", + "properties": { + "publishingProfile": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/GalleryApplicationVersionPublishingProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether OS image rollback feature should be disabled. Default value is false." + "description": "The publishing profile of a gallery image version." } }, - "description": "The configuration parameters used for performing automatic OS upgrade." + "required": [ + "publishingProfile" + ], + "description": "Describes the properties of a gallery Image Version." }, - "AutomaticRepairsPolicy": { + "GalleryApplicationVersionPublishingProfile": { "type": "object", "properties": { - "enabled": { + "enableHealthCheck": { "oneOf": [ { "type": "boolean" @@ -739,41 +2287,35 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + "description": "Optional. Whether or not this application reports health." }, - "gracePeriod": { + "endOfLifeDate": { "type": "string", - "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The default value is 5 minutes (PT5M)." + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." }, - "maxInstanceRepairsPercent": { + "excludeFromLatest": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The percentage (capacity of scaleset) of virtual machines that will be simultaneously repaired. The default value is 20%." - } - }, - "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." - }, - "AvailabilitySetProperties": { - "type": "object", - "properties": { - "platformUpdateDomainCount": { + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "manageActions": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/UserArtifactManage" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Update Domain count." + ] }, - "platformFaultDomainCount": { + "replicaCount": { "oneOf": [ { "type": "integer" @@ -782,236 +2324,237 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count." + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." }, - "virtualMachines": { + "source": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/UserArtifactSource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A list of references to all virtual machines in the availability set." + "description": "The source image from which the Image Version is going to be created." }, - "proximityPlacementGroup": { + "storageAccountType": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the proximity placement group that the availability set should be assigned to.

    Minimum api-version: 2018-04-01." - } - }, - "description": "The instance view of a resource." - }, - "BillingProfile": { - "type": "object", - "properties": { - "maxPrice": { + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + }, + "targetRegions": { "oneOf": [ { - "type": "number" + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01." + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." } }, - "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + "required": [ + "source" + ], + "description": "The publishing profile of a gallery image version." }, - "BootDiagnostics": { + "GalleryArtifactSource": { "type": "object", "properties": { - "enabled": { + "managedImage": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/ManagedArtifact" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + "description": "The managed artifact." + } + }, + "required": [ + "managedImage" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "GalleryIdentifier": { + "type": "object", + "properties": {}, + "description": "Describes the gallery unique name." + }, + "GalleryImageIdentifier": { + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "The name of the gallery Image Definition offer." }, - "storageUri": { + "publisher": { "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." + "description": "The name of the gallery Image Definition publisher." + }, + "sku": { + "type": "string", + "description": "The name of the gallery Image Definition SKU." } }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + "required": [ + "offer", + "publisher", + "sku" + ], + "description": "This is the gallery Image Definition identifier." }, - "DataDisk": { + "GalleryImageProperties": { "type": "object", "properties": { - "lun": { + "description": { + "type": "string", + "description": "The description of this gallery Image Definition resource. This property is updatable." + }, + "disallowed": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/Disallowed" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Describes the disallowed disk types." }, - "name": { + "endOfLifeDate": { "type": "string", - "description": "The disk name." + "format": "date-time", + "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable." }, - "vhd": { - "oneOf": [ - { - "$ref": "#/definitions/VirtualHardDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The virtual hard disk." + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Image Definition." }, - "image": { + "identifier": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/GalleryImageIdentifier" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "This is the gallery Image Definition identifier." }, - "caching": { + "osState": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Generalized", + "Specialized" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." - }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'." }, - "createOption": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." }, - "diskSizeGB": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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.

    This value cannot be larger than 1023 GB" + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." }, - "managedDisk": { + "purchasePlan": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "$ref": "#/definitions/ImagePurchasePlan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." }, - "toBeDetached": { + "recommended": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/RecommendedMachineConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." } }, "required": [ - "lun", - "createOption" + "identifier", + "osState", + "osType" ], - "description": "Describes a data disk." + "description": "Describes the properties of a gallery Image Definition." }, - "DedicatedHostGroupProperties": { + "GalleryImageVersionProperties": { "type": "object", "properties": { - "platformFaultDomainCount": { + "publishingProfile": { "oneOf": [ { - "type": "integer", - "minimum": 1, - "maximum": 3 + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Number of fault domains that the host group can span." + "description": "The publishing profile of a gallery Image Version." } }, "required": [ - "platformFaultDomainCount" + "publishingProfile" ], - "description": "Dedicated Host Group Properties." + "description": "Describes the properties of a gallery Image Version." }, - "DedicatedHostProperties": { + "GalleryImageVersionPublishingProfile": { "type": "object", "properties": { - "platformFaultDomain": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "maximum": 2 - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Fault domain of the dedicated host within a dedicated host group." + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." }, - "autoReplaceOnFailure": { + "excludeFromLatest": { "oneOf": [ { "type": "boolean" @@ -1020,102 +2563,85 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." }, - "licenseType": { - "oneOf": [ - { - "type": "string", - "enum": [ - "None", - "Windows_Server_Hybrid", - "Windows_Server_Perpetual" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**." - } - }, - "description": "Properties of the dedicated host." - }, - "DiagnosticsProfile": { - "type": "object", - "properties": { - "bootDiagnostics": { + "replicaCount": { "oneOf": [ { - "$ref": "#/definitions/BootDiagnostics" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "DiffDiskSettings": { - "type": "object", - "properties": { - "option": { + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "source": { "oneOf": [ - { - "type": "string", - "enum": [ - "Local" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the ephemeral disk settings for operating system disk." - } - }, - "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." - }, - "DiskEncryptionSettings": { - "type": "object", - "properties": { - "diskEncryptionKey": { + { + "$ref": "#/definitions/GalleryArtifactSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image from which the Image Version is going to be created." + }, + "storageAccountType": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultSecretReference" + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." }, - "keyEncryptionKey": { + "targetRegions": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the key encryption key in Key Vault." + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + } + }, + "required": [ + "source" + ], + "description": "The publishing profile of a gallery Image Version." + }, + "GalleryProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this Shared Image Gallery resource. This property is updatable." }, - "enabled": { + "identifier": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/GalleryIdentifier" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "Describes the gallery unique name." } }, - "description": "Describes a Encryption Settings for a Disk" + "description": "Describes the properties of a Shared Image Gallery." }, "HardwareProfile": { "type": "object", @@ -1305,15 +2831,6 @@ "hostGroups_hosts_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "hosts" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -1324,118 +2841,128 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DedicatedHostProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Properties of the dedicated host." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/DedicatedHostProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "hosts" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", + "name", "properties", - "sku" + "sku", + "type" ], "description": "Microsoft.Compute/hostGroups/hosts" }, "ImageDataDisk": { "type": "object", "properties": { - "lun": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "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." }, - "caching": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + ] }, - "diskSizeGB": { + "snapshot": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + ] }, "storageAccountType": { "oneOf": [ @@ -1460,49 +2987,63 @@ ], "description": "Describes a data disk." }, - "ImageOSDisk": { + "ImageDiskReference": { "type": "object", "properties": { - "osType": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "ImageOSDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." }, - "osState": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Generalized", - "Specialized" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "snapshot": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, "managedDisk": { "oneOf": [ @@ -1512,39 +3053,47 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + ] }, - "caching": { + "osState": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "Generalized", + "Specialized" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "The OS State." }, - "diskSizeGB": { + "osType": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] }, "storageAccountType": { "oneOf": [ @@ -1565,69 +3114,86 @@ } }, "required": [ - "osType", - "osState" + "osState", + "osType" ], "description": "Describes an Operating System disk." }, "ImageProperties": { "type": "object", "properties": { - "sourceVirtualMachine": { + "hyperVGeneration": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "V1", + "V2" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source virtual machine from which Image is created." + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image." }, - "storageProfile": { + "sourceVirtualMachine": { "oneOf": [ { - "$ref": "#/definitions/ImageStorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "hyperVGeneration": { + "storageProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "V1", - "V2" - ] + "$ref": "#/definitions/ImageStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image." + "description": "Describes a storage profile." } }, "description": "Describes the properties of an Image." }, - "ImageReference": { + "ImagePurchasePlan": { "type": "object", "properties": { - "id": { + "name": { "type": "string", - "description": "Resource Id" + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "The product ID." }, "publisher": { "type": "string", - "description": "The image publisher." + "description": "The publisher ID." + } + }, + "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." + }, + "ImageReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" }, "offer": { "type": "string", "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, "sku": { "type": "string", "description": "The image SKU." @@ -1637,22 +3203,11 @@ "description": "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." } }, - "description": "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." - }, - "ImageStorageProfile": { - "type": "object", - "properties": { - "osDisk": { - "oneOf": [ - { - "$ref": "#/definitions/ImageOSDisk" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "ImageStorageProfile": { + "type": "object", + "properties": { "dataDisks": { "oneOf": [ { @@ -1667,6 +3222,17 @@ ], "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ImageOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an Operating System disk." + }, "zoneResilient": { "oneOf": [ { @@ -1688,6 +3254,10 @@ "type": "string", "description": "The status code." }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, "level": { "oneOf": [ { @@ -1704,10 +3274,6 @@ ], "description": "The level code." }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." @@ -1720,6 +3286,56 @@ }, "description": "Instance view status." }, + "KeyVaultAndKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "KeyVaultAndSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, "KeyVaultKeyReference": { "type": "object", "properties": { @@ -1735,8 +3351,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the key." + ] } }, "required": [ @@ -1760,8 +3375,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the secret." + ] } }, "required": [ @@ -1784,31 +3398,44 @@ ], "description": "Specifies whether password authentication should be disabled." }, - "ssh": { + "provisionVMAgent": { "oneOf": [ { - "$ref": "#/definitions/SshConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ssh key configuration for a Linux OS." + "description": "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." }, - "provisionVMAgent": { + "ssh": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SshConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "SSH configuration for Linux based VMs running on Azure" } }, "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, + "ManagedArtifact": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The managed artifact id." + } + }, + "required": [ + "id" + ], + "description": "The managed artifact." + }, "ManagedDiskParameters": { "type": "object", "properties": { @@ -1851,7 +3478,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a network interface reference properties." } }, "description": "Describes a network interface reference." @@ -1896,133 +3524,133 @@ "OSDisk": { "type": "object", "properties": { - "osType": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "vhd": { + "diffDiskSettings": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/DiffDiskSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "encryptionSettings": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes a Encryption Settings for a Disk" }, - "writeAcceleratorEnabled": { + "image": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "Describes the uri of a disk." }, - "diffDiskSettings": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/DiffDiskSettings" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + "description": "The parameters of a managed disk." }, - "createOption": { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "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**." }, - "diskSizeGB": { + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -2033,43 +3661,54 @@ "OSProfile": { "type": "object", "properties": { - "computerName": { + "adminPassword": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "allowExtensionOperations": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "computerName": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { + "linuxConfiguration": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "$ref": "#/definitions/LinuxConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies Windows operating system settings on the virtual machine." + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "linuxConfiguration": { + "requireGuestProvisionSignal": { "oneOf": [ { - "$ref": "#/definitions/LinuxConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + "description": "Specifies whether the guest provision signal is required from the virtual machine." }, "secrets": { "oneOf": [ @@ -2085,27 +3724,16 @@ ], "description": "Specifies set of certificates that should be installed onto the virtual machine." }, - "allowExtensionOperations": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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." - }, - "requireGuestProvisionSignal": { + "windowsConfiguration": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the guest provision signal is required from the virtual machine." + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Specifies the operating system settings for the virtual machine." @@ -2117,10 +3745,6 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." @@ -2128,6 +3752,10 @@ "promotionCode": { "type": "string", "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." @@ -2148,10 +3776,66 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "RecommendedMachineConfiguration": { + "type": "object", + "properties": { + "memory": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRange" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the resource range." + }, + "vCPUs": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRange" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the resource range." + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "type": "object", + "properties": { + "max": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of the resource." + }, + "min": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum number of the resource." } }, - "description": "Describes the properties of a Proximity Placement Group." + "description": "Describes the resource range." }, "RollingUpgradePolicy": { "type": "object", @@ -2238,14 +3922,24 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies Terminate Scheduled Event related configurations." + ] } } }, "Sku": { "type": "object", "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the number of virtual machines in the scale set." + }, "name": { "type": "string", "description": "The sku name." @@ -2253,8 +3947,25 @@ "tier": { "type": "string", "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." }, - "capacity": { + "diskSizeGB": { "oneOf": [ { "type": "integer" @@ -2263,10 +3974,97 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the number of virtual machines in the scale set." + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "incremental": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "SourceVault": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" } }, - "description": "Describes a virtual machine scale set sku." + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "SshConfiguration": { "type": "object", @@ -2291,13 +4089,13 @@ "SshPublicKey": { "type": "object", "properties": { - "path": { - "type": "string", - "description": "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" - }, "keyData": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -2305,41 +4103,41 @@ "StorageProfile": { "type": "object", "properties": { - "imageReference": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "osDisk": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, "description": "Specifies the storage settings for the virtual machine disks." @@ -2353,13 +4151,48 @@ } } }, - "TerminateNotificationProfile": { + "TargetRegion": { "type": "object", "properties": { - "notBeforeTimeout": { + "name": { "type": "string", - "description": "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)" + "description": "The name of the region." + }, + "regionalReplicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { "enable": { "oneOf": [ { @@ -2370,12 +4203,27 @@ } ], "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + }, + "notBeforeTimeout": { + "type": "string", + "description": "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)" } } }, "UpgradePolicy": { "type": "object", "properties": { + "automaticOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, "mode": { "oneOf": [ { @@ -2402,31 +4250,62 @@ } ], "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/AutomaticOSUpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Configuration parameters used for performing automatic OS Upgrade." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "VaultCertificate": { + "UserArtifactManage": { "type": "object", "properties": { - "certificateUrl": { + "install": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + "description": "Required. The path and arguments to install the gallery application. This is limited to 4096 characters." + }, + "remove": { + "type": "string", + "description": "Required. The path and arguments to remove the gallery application. This is limited to 4096 characters." + }, + "update": { + "type": "string", + "description": "Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters." + } + }, + "required": [ + "install", + "remove" + ] + }, + "UserArtifactSource": { + "type": "object", + "properties": { + "defaultConfigurationLink": { + "type": "string", + "description": "Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob." }, + "mediaLink": { + "type": "string", + "description": "Required. The mediaLink of the artifact, must be a readable storage page blob." + } + }, + "required": [ + "mediaLink" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "UserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, + "VaultCertificate": { + "type": "object", + "properties": { "certificateStore": { "type": "string", "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -2442,8 +4321,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + ] }, "vaultCertificates": { "oneOf": [ @@ -2479,15 +4357,7 @@ "type": "string", "description": "The virtual machine extension name." }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { + "statuses": { "oneOf": [ { "type": "array", @@ -2501,7 +4371,7 @@ ], "description": "The resource status information." }, - "statuses": { + "substatuses": { "oneOf": [ { "type": "array", @@ -2514,20 +4384,6 @@ } ], "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." }, "type": { "type": "string", @@ -2536,7 +4392,13 @@ "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." - }, + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { "autoUpgradeMinorVersion": { "oneOf": [ { @@ -2548,11 +4410,9 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." }, "instanceView": { "oneOf": [ @@ -2563,7 +4423,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine extension instance view." + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -2572,12 +4454,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "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." }, @@ -2586,8 +4475,9 @@ { "type": "object", "additionalProperties": { - "$ref": "#/definitions/VirtualMachineIdentityUserAssignedIdentitiesValue" - } + "$ref": "#/definitions/UserAssignedIdentitiesValue" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -2598,77 +4488,79 @@ }, "description": "Identity for the virtual machine." }, - "VirtualMachineIdentityUserAssignedIdentitiesValue": {}, "VirtualMachineProperties": { "type": "object", "properties": { - "hardwareProfile": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the hardware settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "storageProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "additionalCapabilities": { + "billingProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/BillingProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." }, - "osProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "networkProfile": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/NetworkProfile" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the network interfaces of the virtual machine." + "description": "Specifies the eviction policy for the Azure Spot virtual machine. Only supported value is 'Deallocate'.

    Minimum api-version: 2019-03-01." }, - "diagnosticsProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the hardware settings for the virtual machine." }, - "availabilitySet": { + "host": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -2676,30 +4568,33 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

    This property cannot exist along with a non-null properties.virtualMachineScaleSet reference." + ] }, - "virtualMachineScaleSet": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/NetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set.

    This property cannot exist along with a non-null properties.availabilitySet reference.

    Minimum api‐version: 2019‐03‐01" + "description": "Specifies the network interfaces of the virtual machine." }, - "proximityPlacementGroup": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01." + "description": "Specifies the operating system settings for the virtual machine." }, "priority": { "oneOf": [ @@ -2717,33 +4612,7 @@ ], "description": "Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01." }, - "evictionPolicy": { - "oneOf": [ - { - "type": "string", - "enum": [ - "Deallocate", - "Delete" - ] - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the eviction policy for the Azure Spot virtual machine. Only supported value is 'Deallocate'.

    Minimum api-version: 2019-03-01." - }, - "billingProfile": { - "oneOf": [ - { - "$ref": "#/definitions/BillingProfile" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the billing related details of a Azure Spot virtual machine.

    Minimum api-version: 2019-03-01." - }, - "host": { + "proximityPlacementGroup": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -2751,189 +4620,35 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2019-03-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "storageProfile": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" - }, - "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" - } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" - }, - "VirtualMachineScaleSetDataDisk": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies the storage settings for the virtual machine disks." }, - "lun": { + "virtualMachineScaleSet": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "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." - }, + ] + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "properties": { "caching": { "oneOf": [ { @@ -2950,17 +4665,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -2988,6 +4692,17 @@ ], "description": "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.

    This value cannot be larger than 1023 GB" }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, "managedDisk": { "oneOf": [ { @@ -2997,12 +4712,27 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a virtual machine scale set data disk." }, @@ -3014,113 +4744,15 @@ "description": "The name of the extension." }, "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2019-03-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, "description": "Describes a Virtual Machine Scale Set Extension." @@ -3148,22 +4780,6 @@ "VirtualMachineScaleSetExtensionProperties": { "type": "object", "properties": { - "forceUpdateTag": { - "type": "string", - "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, "autoUpgradeMinorVersion": { "oneOf": [ { @@ -3175,10 +4791,13 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." }, "protectedSettings": { + "type": "object", + "properties": {}, "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, "provisionAfterExtensions": { @@ -3194,6 +4813,23 @@ } ], "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." @@ -3202,12 +4838,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of identity used for the virtual machine scale set. 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 scale set." }, @@ -3217,7 +4860,8 @@ "type": "object", "additionalProperties": { "$ref": "#/definitions/VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -3228,7 +4872,10 @@ }, "description": "Identity for the virtual machine scale set." }, - "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": {}, + "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VirtualMachineScaleSetIPConfiguration": { "type": "object", "properties": { @@ -3248,7 +4895,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, "required": [ @@ -3259,109 +4907,109 @@ "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "subnet": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/ApiEntityReference" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the identifier of the subnet." + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, - "primary": { + "applicationSecurityGroups": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Specifies an array of references to application security group." }, - "publicIPAddressConfiguration": { + "loadBalancerBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The publicIPAddressConfiguration." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." }, - "privateIPAddressVersion": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" }, - "applicationGatewayBackendAddressPools": { + "primary": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, - "applicationSecurityGroups": { + "privateIPAddressVersion": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to application security group." + "description": "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'." }, - "loadBalancerBackendAddressPools": { + "publicIPAddressConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "loadBalancerInboundNatPools": { + "subnet": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + "description": "The API entity reference." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -3422,7 +5070,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." } }, "required": [ @@ -3453,16 +5102,16 @@ "VirtualMachineScaleSetNetworkConfigurationProperties": { "type": "object", "properties": { - "primary": { + "dnsSettings": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "enableAcceleratedNetworking": { "oneOf": [ @@ -3475,43 +5124,42 @@ ], "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "networkSecurityGroup": { + "enableIPForwarding": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network security group." + "description": "Whether IP forwarding enabled on this NIC." }, - "dnsSettings": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the network interfaces." + "description": "Specifies the IP configurations of the network interface." }, - "ipConfigurations": { + "networkSecurityGroup": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the IP configurations of the network interface." + ] }, - "enableIPForwarding": { + "primary": { "oneOf": [ { "type": "boolean" @@ -3520,7 +5168,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether IP forwarding enabled on this NIC." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." } }, "required": [ @@ -3540,7 +5188,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + "description": "The API entity reference." }, "networkInterfaceConfigurations": { "oneOf": [ @@ -3562,10 +5210,6 @@ "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, "caching": { "oneOf": [ { @@ -3582,17 +5226,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -3618,7 +5251,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, "diskSizeGB": { "oneOf": [ @@ -3631,31 +5264,46 @@ ], "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "osType": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Describes the uri of a disk." }, - "image": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the unmanaged user image to base the scale set on." + "description": "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**." }, "vhdContainers": { "oneOf": [ @@ -3671,16 +5319,16 @@ ], "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -3691,33 +5339,22 @@ "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "computerNamePrefix": { + "adminPassword": { "type": "string", - "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerNamePrefix": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, "linuxConfiguration": { "oneOf": [ { @@ -3742,6 +5379,17 @@ } ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Describes a virtual machine scale set OS profile." @@ -3749,16 +5397,16 @@ "VirtualMachineScaleSetProperties": { "type": "object", "properties": { - "upgradePolicy": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, "automaticRepairsPolicy": { "oneOf": [ @@ -3769,18 +5417,18 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Policy for automatic repairs." + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." }, - "virtualMachineProfile": { + "doNotRunExtensionsOnOverprovisionedVMs": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." }, "overprovision": { "oneOf": [ @@ -3793,82 +5441,81 @@ ], "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, - "doNotRunExtensionsOnOverprovisionedVMs": { + "platformFaultDomainCount": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + "description": "Fault Domain count for each placement group." }, - "singlePlacementGroup": { + "proximityPlacementGroup": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + ] }, - "zoneBalance": { + "scaleInPolicy": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/ScaleInPolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Describes a scale-in policy for a virtual machine scale set." }, - "platformFaultDomainCount": { + "singlePlacementGroup": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count for each placement group." + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "proximityPlacementGroup": { + "upgradePolicy": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/UpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "additionalCapabilities": { + "virtualMachineProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "description": "Describes a virtual machine scale set virtual machine profile." }, - "scaleInPolicy": { + "zoneBalance": { "oneOf": [ { - "$ref": "#/definitions/ScaleInPolicy" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -3888,7 +5535,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" } }, "required": [ @@ -3912,27 +5560,27 @@ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "type": "object", "properties": { - "idleTimeoutInMinutes": { + "dnsSettings": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The idle timeout of the public IP address." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, - "dnsSettings": { + "idleTimeoutInMinutes": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the publicIP addresses ." + "description": "The idle timeout of the public IP address." }, "ipTags": { "oneOf": [ @@ -3956,157 +5604,161 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The PublicIPPrefix from which to allocate publicIP addresses." + ] } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "virtualMachineScaleSets_extensions_childResource": { + "VirtualMachineScaleSetStorageProfile": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2019-03-01" - ] - }, - "properties": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] - } - }, - "required": [ - "name", - "type", - "apiVersion", - "properties" - ], - "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" - }, - "virtualMachineScaleSets_virtualmachines_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2019-03-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "tags": { + "imageReference": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." }, - "properties": { + "osDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" ] }, - "plan": { + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] } }, "required": [ - "name", - "type", "apiVersion", - "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, - "VirtualMachineScaleSetStorageProfile": { + "virtualMachineScaleSets_virtualmachines_childResource": { "type": "object", "properties": { - "imageReference": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "osDisk": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "dataDisks": { + "tags": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] } }, - "description": "Describes a virtual machine scale set storage profile." + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, "VirtualMachineScaleSetVMNetworkProfileConfiguration": { "type": "object", @@ -4131,117 +5783,116 @@ "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "osProfile": { + "billingProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "$ref": "#/definitions/BillingProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." }, - "storageProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "networkProfile": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + "description": "Specifies the eviction policy for virtual machines in a Azure Spot scale set.

    Minimum api-version: 2017-10-30-preview." }, - "diagnosticsProfile": { + "extensionProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Describes a virtual machine scale set extension profile." }, - "extensionProfile": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Describes a virtual machine scale set network profile." }, - "priority": { + "osProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "Regular", - "Low", - "Spot" - ] + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." + "description": "Describes a virtual machine scale set OS profile." }, - "evictionPolicy": { + "priority": { "oneOf": [ { "type": "string", "enum": [ - "Deallocate", - "Delete" + "Regular", + "Low", + "Spot" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the eviction policy for virtual machines in a Azure Spot scale set.

    Minimum api-version: 2017-10-30-preview." + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." }, - "billingProfile": { + "scheduledEventsProfile": { "oneOf": [ { - "$ref": "#/definitions/BillingProfile" + "$ref": "#/definitions/ScheduledEventsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + ] }, - "scheduledEventsProfile": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/ScheduledEventsProfile" + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies Scheduled Event related configurations." + "description": "Describes a virtual machine scale set storage profile." } }, "description": "Describes a virtual machine scale set virtual machine profile." @@ -4249,49 +5900,52 @@ "VirtualMachineScaleSetVMProperties": { "type": "object", "properties": { - "hardwareProfile": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the hardware settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "storageProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "additionalCapabilities": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -4313,44 +5967,40 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the network profile configuration of the virtual machine." + "description": "Describes a virtual machine scale set VM network profile." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the operating system settings for the virtual machine." }, - "availabilitySet": { + "protectionPolicy": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "The protection policy of a virtual machine scale set VM." }, - "protectionPolicy": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the protection policy of the virtual machine." + "description": "Specifies the storage settings for the virtual machine disks." } }, "description": "Describes the properties of a virtual machine scale set virtual machine." @@ -4383,35 +6033,68 @@ }, "description": "The protection policy of a virtual machine scale set VM." }, - "WindowsConfiguration": { + "virtualMachines_extensions_childResource": { "type": "object", "properties": { - "provisionVMAgent": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-03-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Describes the properties of a Virtual Machine Extension." }, - "enableAutomaticUpdates": { + "tags": { "oneOf": [ { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Resource tags" }, - "timeZone": { + "type": { "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { "additionalUnattendContent": { "oneOf": [ { @@ -4426,6 +6109,32 @@ ], "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, "winRM": { "oneOf": [ { @@ -4435,7 +6144,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + "description": "Describes Windows Remote Management configuration of the VM" } }, "description": "Specifies Windows operating system settings on the virtual machine." @@ -4463,6 +6172,10 @@ "WinRMListener": { "type": "object", "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, "protocol": { "oneOf": [ { @@ -4477,10 +6190,6 @@ } ], "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" diff --git a/schemas/2019-07-01/Microsoft.Compute.json b/schemas/2019-07-01/Microsoft.Compute.json index e88fe5e1be..28a0bcb1ab 100644 --- a/schemas/2019-07-01/Microsoft.Compute.json +++ b/schemas/2019-07-01/Microsoft.Compute.json @@ -7,15 +7,6 @@ "availabilitySets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/availabilitySets" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -26,131 +17,135 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/AvailabilitySetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The instance view of a resource." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/AvailabilitySetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/availabilitySets" }, "diskEncryptionSets": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/diskEncryptionSets" - ] - }, "apiVersion": { "type": "string", "enum": [ "2019-07-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/EncryptionSetIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." }, - "identity": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSetIdentity" + "$ref": "#/definitions/EncryptionSetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ] }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSetProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/diskEncryptionSets" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/diskEncryptionSets" }, "disks": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/disks" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -161,19 +156,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DiskProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Disk resource properties." }, "sku": { "oneOf": [ @@ -183,54 +179,57 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." }, - "zones": { + "tags": { "oneOf": [ { - "type": "array", - "items": { + "type": "object", + "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Logical zone list for Disk." + "description": "Resource tags" }, - "properties": { + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { "oneOf": [ { - "$ref": "#/definitions/DiskProperties" + "type": "array", + "items": { + "type": "string" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The Logical zone list for Disk." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/disks" }, "galleries": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -241,19 +240,9 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." }, "properties": { "oneOf": [ @@ -263,43 +252,56 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Shared Image Gallery." }, "resources": { "type": "array", "items": { "oneOf": [ { - "$ref": "#/definitions/galleries_applications_childResource" + "$ref": "#/definitions/galleries_images_childResource" }, { - "$ref": "#/definitions/galleries_images_childResource" + "$ref": "#/definitions/galleries_applications_childResource" } ] } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries" }, "galleries_applications": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries/applications" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -310,19 +312,9 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." }, "properties": { "oneOf": [ @@ -332,7 +324,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a gallery Application Definition." }, "resources": { "type": "array", @@ -343,30 +336,42 @@ } ] } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/applications" }, "galleries_applications_versions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries/applications/versions" - ] - }, - "apiVersion": { + "apiVersion": { "type": "string", "enum": [ "2019-07-01" @@ -376,52 +381,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryApplicationVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryApplicationVersionProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications/versions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/applications/versions" }, "galleries_images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -432,19 +440,9 @@ "type": "string", "description": "Resource location" }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." }, "properties": { "oneOf": [ @@ -454,7 +452,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a gallery Image Definition." }, "resources": { "type": "array", @@ -465,29 +464,41 @@ } ] } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images" }, "galleries_images_versions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/galleries/images/versions" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -498,52 +509,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageVersionProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images/versions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images/versions" }, "hostGroups": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/hostGroups" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -554,28 +568,50 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the dedicated host group." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DedicatedHostGroupProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Dedicated Host Group Properties." }, - "properties": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/hostGroups_hosts_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/DedicatedHostGroupProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups" ] }, "zones": { @@ -591,39 +627,20 @@ } ], "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/hostGroups_hosts_childResource" - } - ] - } } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/hostGroups" }, "hostGroups_hosts": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/hostGroups/hosts" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -634,64 +651,67 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DedicatedHostProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Properties of the dedicated host." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/DedicatedHostProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups/hosts" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", + "name", "properties", - "sku" + "sku", + "type" ], "description": "Microsoft.Compute/hostGroups/hosts" }, "images": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -702,52 +722,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of an Image." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" - ], - "description": "Microsoft.Compute/images" + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/images" }, "proximityPlacementGroups": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/proximityPlacementGroups" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -758,54 +781,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the proximity placement group." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ProximityPlacementGroupProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a Proximity Placement Group." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/ProximityPlacementGroupProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Describes the properties of a Proximity Placement Group." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/proximityPlacementGroups" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/proximityPlacementGroups" }, "snapshots": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/snapshots" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -816,19 +840,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/SnapshotProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Snapshot resource properties." }, "sku": { "oneOf": [ @@ -838,63 +863,67 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/SnapshotProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/snapshots" }, "virtualMachines": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachines" - ] - }, "apiVersion": { "type": "string", "enum": [ "2019-07-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." }, "plan": { "oneOf": [ @@ -915,18 +944,39 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine." }, - "identity": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] }, "zones": { "oneOf": [ @@ -941,105 +991,111 @@ } ], "description": "The virtual machine zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachines_extensions_childResource" - } - ] - } } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachines" }, "virtualMachineScaleSets": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets" - ] - }, "apiVersion": { "type": "string", "enum": [ "2019-07-01" ] }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { + "identity": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Identity for the virtual machine scale set." }, - "sku": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set sku." + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, - "plan": { + "properties": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "$ref": "#/definitions/VirtualMachineScaleSetProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Describes the properties of a Virtual Machine Scale Set." }, - "properties": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "identity": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The identity of the virtual machine scale set, if configured." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] }, "zones": { "oneOf": [ @@ -1053,66 +1109,84 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine scale set zones." - }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" - }, - { - "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" - } - ] - } + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set." } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets" }, - "virtualMachineScaleSets_virtualmachines": { + "virtualMachineScaleSets_extensions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ "2019-07-01" ] }, - "location": { + "name": { "type": "string", - "description": "Resource location" + "description": "The name of the VM scale set extension." }, - "tags": { + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "oneOf": [ @@ -1122,41 +1196,53 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "plan": { + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, "virtualMachineScaleSets_virtualMachines_extensions": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -1167,13 +1253,29 @@ "type": "string", "description": "Resource location" }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, "tags": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "string" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -1181,6 +1283,39 @@ ], "description": "Resource tags" }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, "properties": { "oneOf": [ { @@ -1189,17 +1324,39 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], - "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + "description": "Microsoft.Compute/virtualMachines/extensions" } }, "definitions": { @@ -1223,33 +1380,37 @@ "AdditionalUnattendContent": { "type": "object", "properties": { - "passName": { + "componentName": { "oneOf": [ { "type": "string", "enum": [ - "OobeSystem" + "Microsoft-Windows-Shell-Setup" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The pass name. Currently, the only allowable value is OobeSystem." + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." }, - "componentName": { + "content": { + "type": "string", + "description": "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." + }, + "passName": { "oneOf": [ { "type": "string", "enum": [ - "Microsoft-Windows-Shell-Setup" + "OobeSystem" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + "description": "The pass name. Currently, the only allowable value is OobeSystem." }, "settingName": { "oneOf": [ @@ -1265,10 +1426,6 @@ } ], "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." - }, - "content": { - "type": "string", - "description": "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." } }, "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." @@ -1286,7 +1443,7 @@ "AutomaticOSUpgradePolicy": { "type": "object", "properties": { - "enableAutomaticOSUpgrade": { + "disableAutomaticRollback": { "oneOf": [ { "type": "boolean" @@ -1295,9 +1452,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + "description": "Whether OS image rollback feature should be disabled. Default value is false." }, - "disableAutomaticRollback": { + "enableAutomaticOSUpgrade": { "oneOf": [ { "type": "boolean" @@ -1306,7 +1463,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether OS image rollback feature should be disabled. Default value is false." + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." } }, "description": "The configuration parameters used for performing automatic OS upgrade." @@ -1327,18 +1484,7 @@ }, "gracePeriod": { "type": "string", - "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The default value is 5 minutes (PT5M)." - }, - "maxInstanceRepairsPercent": { - "oneOf": [ - { - "type": "integer" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The percentage (capacity of scaleset) of virtual machines that will be simultaneously repaired. The default value is 20%." + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." } }, "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." @@ -1346,7 +1492,7 @@ "AvailabilitySetProperties": { "type": "object", "properties": { - "platformUpdateDomainCount": { + "platformFaultDomainCount": { "oneOf": [ { "type": "integer" @@ -1355,9 +1501,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Update Domain count." + "description": "Fault Domain count." }, - "platformFaultDomainCount": { + "platformUpdateDomainCount": { "oneOf": [ { "type": "integer" @@ -1366,32 +1512,31 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count." + "description": "Update Domain count." }, - "virtualMachines": { + "proximityPlacementGroup": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "A list of references to all virtual machines in the availability set." + ] }, - "proximityPlacementGroup": { + "virtualMachines": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the proximity placement group that the availability set should be assigned to.

    Minimum api-version: 2018-04-01." + "description": "A list of references to all virtual machines in the availability set." } }, "description": "The instance view of a resource." @@ -1457,10 +1602,6 @@ ], "description": "This enumerates the possible sources of a disk's creation." }, - "storageAccountId": { - "type": "string", - "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." - }, "imageReference": { "oneOf": [ { @@ -1470,15 +1611,19 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information." + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." }, "sourceUri": { "type": "string", "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." }, - "sourceResourceId": { + "storageAccountId": { "type": "string", - "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." }, "uploadSizeBytes": { "oneOf": [ @@ -1500,109 +1645,109 @@ "DataDisk": { "type": "object", "properties": { - "lun": { + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "vhd": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes the uri of a disk." }, - "writeAcceleratorEnabled": { + "lun": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "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." }, - "createOption": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "The parameters of a managed disk." }, - "diskSizeGB": { + "name": { + "type": "string", + "description": "The disk name." + }, + "toBeDetached": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" }, - "managedDisk": { + "vhd": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Describes the uri of a disk." }, - "toBeDetached": { + "writeAcceleratorEnabled": { "oneOf": [ { "type": "boolean" @@ -1611,12 +1756,12 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a data disk." }, @@ -1645,19 +1790,6 @@ "DedicatedHostProperties": { "type": "object", "properties": { - "platformFaultDomain": { - "oneOf": [ - { - "type": "integer", - "minimum": 0, - "maximum": 2 - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Fault domain of the dedicated host within a dedicated host group." - }, "autoReplaceOnFailure": { "oneOf": [ { @@ -1684,6 +1816,19 @@ } ], "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**." + }, + "platformFaultDomain": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault domain of the dedicated host within a dedicated host group." } }, "description": "Properties of the dedicated host." @@ -1767,29 +1912,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + "description": "Describes a reference to Key Vault Secret" }, - "keyEncryptionKey": { + "enabled": { "oneOf": [ { - "$ref": "#/definitions/KeyVaultKeyReference" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the location of the key encryption key in Key Vault." + "description": "Specifies whether disk encryption should be enabled on the virtual machine." }, - "enabled": { + "keyEncryptionKey": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/KeyVaultKeyReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether disk encryption should be enabled on the virtual machine." + "description": "Describes a reference to Key Vault Key" } }, "description": "Describes a Encryption Settings for a Disk" @@ -1797,46 +1942,38 @@ "DiskProperties": { "type": "object", "properties": { - "osType": { + "creationData": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/CreationData" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Data used when creating a disk." }, - "hyperVGeneration": { + "diskIOPSReadWrite": { "oneOf": [ { - "type": "string", - "enum": [ - "V1", - "V2" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." }, - "creationData": { + "diskMBpsReadWrite": { "oneOf": [ { - "$ref": "#/definitions/CreationData" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." }, "diskSizeGB": { "oneOf": [ @@ -1849,49 +1986,57 @@ ], "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." }, - "encryptionSettingsCollection": { + "encryption": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSettingsCollection" + "$ref": "#/definitions/Encryption" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + "description": "Encryption at rest settings for disk or snapshot" }, - "diskIOPSReadWrite": { + "encryptionSettingsCollection": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/EncryptionSettingsCollection" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + "description": "Encryption settings for disk or snapshot" }, - "diskMBpsReadWrite": { + "hyperVGeneration": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "V1", + "V2" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." }, - "encryption": { + "osType": { "oneOf": [ { - "$ref": "#/definitions/Encryption" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + "description": "The Operating System type." } }, "required": [ @@ -1930,10 +2075,17 @@ "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." }, "type": { - "type": "string", - "enum": [ - "EncryptionAtRestWithPlatformKey", - "EncryptionAtRestWithCustomerKey" + "oneOf": [ + { + "type": "string", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of key used to encrypt the data of the disk." } @@ -1947,9 +2099,16 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported." } @@ -1968,7 +2127,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The key vault key which is currently used by this disk encryption set." + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" } } }, @@ -2022,7 +2181,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Secret Url and vault id of the disk encryption key" + "description": "Key Vault Secret Url and vault id of the encryption key " }, "keyEncryptionKey": { "oneOf": [ @@ -2033,7 +2192,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key." + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" } }, "description": "Encryption settings for one disk volume." @@ -2041,15 +2200,6 @@ "galleries_applications_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "applications" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -2060,62 +2210,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryApplicationProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Application Definition." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryApplicationProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/galleries_applications_versions_childResource" - } - ] - } + "type": { + "type": "string", + "enum": [ + "applications" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/applications" }, "galleries_applications_versions_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -2126,52 +2269,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryApplicationVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryApplicationVersionProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/applications/versions" }, "galleries_images_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "images" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -2182,62 +2328,55 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Definition." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Resource tags" }, - "resources": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/definitions/galleries_images_versions_childResource" - } - ] - } + "type": { + "type": "string", + "enum": [ + "images" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images" }, "galleries_images_versions_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "versions" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -2248,37 +2387,49 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/GalleryImageVersionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Describes the properties of a gallery Image Version." }, - "properties": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageVersionProperties" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/galleries/images/versions" }, @@ -2289,6 +2440,11 @@ "type": "string", "description": "The description of this gallery Application Definition resource. This property is updatable." }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, "eula": { "type": "string", "description": "The Eula agreement for the gallery Application Definition." @@ -2301,11 +2457,6 @@ "type": "string", "description": "The release note uri." }, - "endOfLifeDate": { - "type": "string", - "format": "date-time", - "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." - }, "supportedOSType": { "oneOf": [ { @@ -2338,7 +2489,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The publishing profile of a gallery image version." } }, "required": [ @@ -2349,19 +2501,42 @@ "GalleryApplicationVersionPublishingProfile": { "type": "object", "properties": { - "targetRegions": { + "enableHealthCheck": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/TargetRegion" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + "description": "Optional. Whether or not this application reports health." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "manageActions": { + "oneOf": [ + { + "$ref": "#/definitions/UserArtifactManage" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] }, "replicaCount": { "oneOf": [ @@ -2374,21 +2549,16 @@ ], "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." }, - "excludeFromLatest": { + "source": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/UserArtifactSource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." - }, - "endOfLifeDate": { - "type": "string", - "format": "date-time", - "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + "description": "The source image from which the Image Version is going to be created." }, "storageAccountType": { "oneOf": [ @@ -2405,36 +2575,25 @@ ], "description": "Specifies the storage account type to be used to store the image. This property is not updatable." }, - "source": { - "oneOf": [ - { - "$ref": "#/definitions/UserArtifactSource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] - }, - "contentType": { - "type": "string", - "description": "Optional. May be used to help process this file. The type of file contained in the source, e.g. zip, json, etc." - }, - "enableHealthCheck": { + "targetRegions": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Optional. Whether or not this application reports health." + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." } }, "required": [ "source" ], - "description": "The publishing profile of a gallery Image Version." + "description": "The publishing profile of a gallery image version." }, "GalleryArtifactVersionSource": { "type": "object", @@ -2444,9 +2603,6 @@ "description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image." } }, - "required": [ - "id" - ], "description": "The gallery artifact version source." }, "GalleryDataDiskImage": { @@ -2468,26 +2624,27 @@ ], "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'." }, - "source": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/GalleryArtifactVersionSource" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." }, - "lun": { + "source": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/GalleryArtifactVersionSource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + "description": "The gallery artifact version source." } }, "required": [ @@ -2496,27 +2653,29 @@ "description": "This is the data disk image." }, "GalleryIdentifier": { + "type": "object", + "properties": {}, "description": "Describes the gallery unique name." }, "GalleryImageIdentifier": { "type": "object", "properties": { - "publisher": { - "type": "string", - "description": "The name of the gallery Image Definition publisher." - }, "offer": { "type": "string", "description": "The name of the gallery Image Definition offer." }, + "publisher": { + "type": "string", + "description": "The name of the gallery Image Definition publisher." + }, "sku": { "type": "string", "description": "The name of the gallery Image Definition SKU." } }, "required": [ - "publisher", "offer", + "publisher", "sku" ], "description": "This is the gallery Image Definition identifier." @@ -2528,32 +2687,51 @@ "type": "string", "description": "The description of this gallery Image Definition resource. This property is updatable." }, - "eula": { - "type": "string", - "description": "The Eula agreement for the gallery Image Definition." + "disallowed": { + "oneOf": [ + { + "$ref": "#/definitions/Disallowed" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the disallowed disk types." }, - "privacyStatementUri": { + "endOfLifeDate": { "type": "string", - "description": "The privacy statement uri." + "format": "date-time", + "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable." }, - "releaseNoteUri": { + "eula": { "type": "string", - "description": "The release note uri." + "description": "The Eula agreement for the gallery Image Definition." }, - "osType": { + "hyperVGeneration": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "V1", + "V2" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "identifier": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageIdentifier" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the gallery Image Definition identifier." }, "osState": { "oneOf": [ @@ -2570,35 +2748,35 @@ ], "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'." }, - "hyperVGeneration": { + "osType": { "oneOf": [ { "type": "string", "enum": [ - "V1", - "V2" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." }, - "endOfLifeDate": { + "privacyStatementUri": { "type": "string", - "format": "date-time", - "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable." + "description": "The privacy statement uri." }, - "identifier": { + "purchasePlan": { "oneOf": [ { - "$ref": "#/definitions/GalleryImageIdentifier" + "$ref": "#/definitions/ImagePurchasePlan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." }, "recommended": { "oneOf": [ @@ -2608,33 +2786,18 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] - }, - "disallowed": { - "oneOf": [ - { - "$ref": "#/definitions/Disallowed" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] + ], + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." }, - "purchasePlan": { - "oneOf": [ - { - "$ref": "#/definitions/ImagePurchasePlan" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ] + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." } }, "required": [ - "osType", + "identifier", "osState", - "identifier" + "osType" ], "description": "Describes the properties of a gallery Image Definition." }, @@ -2649,7 +2812,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The publishing profile of a gallery Image Version." }, "storageProfile": { "oneOf": [ @@ -2659,7 +2823,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "This is the storage profile of a Gallery Image Version." } }, "required": [ @@ -2670,19 +2835,21 @@ "GalleryImageVersionPublishingProfile": { "type": "object", "properties": { - "targetRegions": { + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/TargetRegion" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." }, "replicaCount": { "oneOf": [ @@ -2695,36 +2862,34 @@ ], "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." }, - "excludeFromLatest": { + "storageAccountType": { "oneOf": [ { - "type": "boolean" + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." - }, - "endOfLifeDate": { - "type": "string", - "format": "date-time", - "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." }, - "storageAccountType": { + "targetRegions": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_ZRS" - ] + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." } }, "description": "The publishing profile of a gallery Image Version." @@ -2732,15 +2897,19 @@ "GalleryImageVersionStorageProfile": { "type": "object", "properties": { - "source": { + "dataDiskImages": { "oneOf": [ { - "$ref": "#/definitions/GalleryArtifactVersionSource" + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "A list of data disk images." }, "osDiskImage": { "oneOf": [ @@ -2750,21 +2919,19 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "This is the OS disk image." }, - "dataDiskImages": { + "source": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/GalleryDataDiskImage" - } + "$ref": "#/definitions/GalleryArtifactVersionSource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A list of data disk images." + "description": "The gallery artifact version source." } }, "description": "This is the storage profile of a Gallery Image Version." @@ -2796,7 +2963,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "The gallery artifact version source." } }, "description": "This is the OS disk image." @@ -2816,7 +2984,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the gallery unique name." } }, "description": "Describes the properties of a Shared Image Gallery." @@ -3009,15 +3178,6 @@ "hostGroups_hosts_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "hosts" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -3028,98 +3188,110 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/DedicatedHostProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Properties of the dedicated host." }, - "properties": { + "sku": { "oneOf": [ { - "$ref": "#/definitions/DedicatedHostProperties" + "$ref": "#/definitions/Sku" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, - "sku": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Sku" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "hosts" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", + "name", "properties", - "sku" + "sku", + "type" ], "description": "Microsoft.Compute/hostGroups/hosts" }, "ImageDataDisk": { "type": "object", "properties": { - "snapshot": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The snapshot." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "managedDisk": { + "diskEncryptionSet": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/DiskEncryptionSetParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." }, - "caching": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "diskSizeGB": { + "lun": { "oneOf": [ { "type": "integer" @@ -3128,46 +3300,44 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + "description": "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." }, - "storageAccountType": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS", - "StandardSSD_LRS", - "UltraSSD_LRS" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "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." + ] }, - "diskEncryptionSet": { + "snapshot": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSetParameters" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the customer managed disk encryption set resource id for the managed image disk." + ] }, - "lun": { + "storageAccountType": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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." } }, "required": [ @@ -3202,28 +3372,6 @@ "ImageOSDisk": { "type": "object", "properties": { - "snapshot": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The snapshot." - }, - "managedDisk": { - "oneOf": [ - { - "$ref": "#/definitions/SubResource" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "The managedDisk." - }, "blobUri": { "type": "string", "description": "The Virtual Hard Disk." @@ -3244,6 +3392,17 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, "diskSizeGB": { "oneOf": [ { @@ -3255,33 +3414,30 @@ ], "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "storageAccountType": { + "managedDisk": { "oneOf": [ { - "type": "string", - "enum": [ - "Standard_LRS", - "Premium_LRS", - "StandardSSD_LRS", - "UltraSSD_LRS" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "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." + ] }, - "diskEncryptionSet": { + "osState": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSetParameters" + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the customer managed disk encryption set resource id for the managed image disk." + "description": "The OS State." }, "osType": { "oneOf": [ @@ -3298,67 +3454,78 @@ ], "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." }, - "osState": { + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { "oneOf": [ { "type": "string", "enum": [ - "Generalized", - "Specialized" + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The OS State." + "description": "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." } }, "required": [ - "osType", - "osState" + "osState", + "osType" ], "description": "Describes an Operating System disk." }, "ImageProperties": { "type": "object", "properties": { - "sourceVirtualMachine": { + "hyperVGeneration": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "string", + "enum": [ + "V1", + "V2" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The source virtual machine from which Image is created." + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image." }, - "storageProfile": { + "sourceVirtualMachine": { "oneOf": [ { - "$ref": "#/definitions/ImageStorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "hyperVGeneration": { + "storageProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "V1", - "V2" - ] + "$ref": "#/definitions/ImageStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image." + "description": "Describes a storage profile." } }, "description": "Describes the properties of an Image." @@ -3370,13 +3537,13 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "The product ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." @@ -3388,14 +3555,14 @@ "type": "string", "description": "Resource Id" }, - "publisher": { - "type": "string", - "description": "The image publisher." - }, "offer": { "type": "string", "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, "sku": { "type": "string", "description": "The image SKU." @@ -3405,35 +3572,35 @@ "description": "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." } }, - "description": "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." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set" }, "ImageStorageProfile": { "type": "object", "properties": { - "osDisk": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageOSDisk" + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - } + "$ref": "#/definitions/ImageOSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Describes an Operating System disk." }, "zoneResilient": { "oneOf": [ @@ -3456,6 +3623,10 @@ "type": "string", "description": "The status code." }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, "level": { "oneOf": [ { @@ -3472,10 +3643,6 @@ ], "description": "The level code." }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, "message": { "type": "string", "description": "The detailed status message, including for alerts and error messages." @@ -3491,6 +3658,10 @@ "KeyVaultAndKeyReference": { "type": "object", "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, "sourceVault": { "oneOf": [ { @@ -3500,22 +3671,22 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "keyUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, "required": [ - "sourceVault", - "keyUrl" + "keyUrl", + "sourceVault" ], "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" }, "KeyVaultAndSecretReference": { "type": "object", "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, "sourceVault": { "oneOf": [ { @@ -3525,16 +3696,12 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource id of the KeyVault containing the key or secret" - }, - "secretUrl": { - "type": "string", - "description": "Url pointing to a key or secret in KeyVault" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" } }, "required": [ - "sourceVault", - "secretUrl" + "secretUrl", + "sourceVault" ], "description": "Key Vault Secret Url and vault id of the encryption key " }, @@ -3553,8 +3720,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the key." + ] } }, "required": [ @@ -3578,8 +3744,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing the secret." + ] } }, "required": [ @@ -3602,27 +3767,27 @@ ], "description": "Specifies whether password authentication should be disabled." }, - "ssh": { + "provisionVMAgent": { "oneOf": [ { - "$ref": "#/definitions/SshConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ssh key configuration for a Linux OS." + "description": "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." }, - "provisionVMAgent": { + "ssh": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SshConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "SSH configuration for Linux based VMs running on Azure" } }, "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." @@ -3630,6 +3795,17 @@ "ManagedDiskParameters": { "type": "object", "properties": { + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, "id": { "type": "string", "description": "Resource Id" @@ -3650,17 +3826,6 @@ } ], "description": "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." - }, - "diskEncryptionSet": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSetParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the customer managed disk encryption set resource id for the managed disk." } }, "description": "The parameters of a managed disk." @@ -3680,7 +3845,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a network interface reference properties." } }, "description": "Describes a network interface reference." @@ -3725,133 +3891,133 @@ "OSDisk": { "type": "object", "properties": { - "osType": { + "caching": { "oneOf": [ { "type": "string", "enum": [ - "Windows", - "Linux" + "None", + "ReadOnly", + "ReadWrite" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "encryptionSettings": { + "createOption": { "oneOf": [ { - "$ref": "#/definitions/DiskEncryptionSettings" + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, - "vhd": { + "diffDiskSettings": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/DiffDiskSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual hard disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, - "image": { + "diskSizeGB": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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.

    This value cannot be larger than 1023 GB" }, - "caching": { + "encryptionSettings": { "oneOf": [ { - "type": "string", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ] + "$ref": "#/definitions/DiskEncryptionSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "Describes a Encryption Settings for a Disk" }, - "writeAcceleratorEnabled": { + "image": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "Describes the uri of a disk." }, - "diffDiskSettings": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/DiffDiskSettings" + "$ref": "#/definitions/ManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + "description": "The parameters of a managed disk." }, - "createOption": { + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { "oneOf": [ { "type": "string", "enum": [ - "FromImage", - "Empty", - "Attach" + "Windows", + "Linux" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + "description": "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**." }, - "diskSizeGB": { + "vhd": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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.

    This value cannot be larger than 1023 GB" + "description": "Describes the uri of a disk." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/ManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -3862,32 +4028,32 @@ "OSProfile": { "type": "object", "properties": { - "computerName": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, "adminPassword": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, - "customData": { + "adminUsername": { "type": "string", - "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + "description": "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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { + "allowExtensionOperations": { "oneOf": [ { - "$ref": "#/definitions/WindowsConfiguration" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies Windows operating system settings on the virtual machine." + "description": "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." + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://docs.microsoft.com/azure/virtual-machines/custom-data)

    For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, "linuxConfiguration": { "oneOf": [ @@ -3900,44 +4066,44 @@ ], "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." }, - "secrets": { + "requireGuestProvisionSignal": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies set of certificates that should be installed onto the virtual machine." + "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine." }, - "allowExtensionOperations": { + "secrets": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies set of certificates that should be installed onto the virtual machine." }, - "requireGuestProvisionSignal": { + "windowsConfiguration": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/WindowsConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether the guest provision signal is required from the virtual machine." + "description": "Specifies Windows operating system settings on the virtual machine." } }, - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." }, "Plan": { "type": "object", @@ -3946,10 +4112,6 @@ "type": "string", "description": "The plan ID." }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, "product": { "type": "string", "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." @@ -3957,6 +4119,10 @@ "promotionCode": { "type": "string", "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." } }, "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." @@ -3964,6 +4130,17 @@ "ProximityPlacementGroupProperties": { "type": "object", "properties": { + "colocationStatus": { + "oneOf": [ + { + "$ref": "#/definitions/InstanceViewStatus" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Instance view status." + }, "proximityPlacementGroupType": { "oneOf": [ { @@ -3985,7 +4162,7 @@ "RecommendedMachineConfiguration": { "type": "object", "properties": { - "vCPUs": { + "memory": { "oneOf": [ { "$ref": "#/definitions/ResourceRange" @@ -3993,9 +4170,10 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the resource range." }, - "memory": { + "vCPUs": { "oneOf": [ { "$ref": "#/definitions/ResourceRange" @@ -4003,7 +4181,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the resource range." } }, "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." @@ -4011,7 +4190,7 @@ "ResourceRange": { "type": "object", "properties": { - "min": { + "max": { "oneOf": [ { "type": "integer" @@ -4020,9 +4199,9 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The minimum number of the resource." + "description": "The maximum number of the resource." }, - "max": { + "min": { "oneOf": [ { "type": "integer" @@ -4031,7 +4210,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The maximum number of the resource." + "description": "The minimum number of the resource." } }, "description": "Describes the resource range." @@ -4121,22 +4300,13 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies Terminate Scheduled Event related configurations." + ] } } }, "Sku": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, "capacity": { "oneOf": [ { @@ -4147,75 +4317,79 @@ } ], "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" } }, - "description": "Describes a virtual machine scale set sku." + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." }, "SnapshotProperties": { "type": "object", "properties": { - "osType": { + "creationData": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/CreationData" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The Operating System type." + "description": "Data used when creating a disk." }, - "hyperVGeneration": { + "diskSizeGB": { "oneOf": [ { - "type": "string", - "enum": [ - "V1", - "V2" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." }, - "creationData": { + "encryption": { "oneOf": [ { - "$ref": "#/definitions/CreationData" + "$ref": "#/definitions/Encryption" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + "description": "Encryption at rest settings for disk or snapshot" }, - "diskSizeGB": { + "encryptionSettingsCollection": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/EncryptionSettingsCollection" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + "description": "Encryption settings for disk or snapshot" }, - "encryptionSettingsCollection": { + "hyperVGeneration": { "oneOf": [ { - "$ref": "#/definitions/EncryptionSettingsCollection" + "type": "string", + "enum": [ + "V1", + "V2" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." }, "incremental": { "oneOf": [ @@ -4228,16 +4402,20 @@ ], "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." }, - "encryption": { + "osType": { "oneOf": [ { - "$ref": "#/definitions/Encryption" + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + "description": "The Operating System type." } }, "required": [ @@ -4300,13 +4478,13 @@ "SshPublicKey": { "type": "object", "properties": { - "path": { - "type": "string", - "description": "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" - }, "keyData": { "type": "string", "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" } }, "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." @@ -4314,41 +4492,41 @@ "StorageProfile": { "type": "object", "properties": { - "imageReference": { + "dataDisks": { "oneOf": [ { - "$ref": "#/definitions/ImageReference" + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "osDisk": { + "imageReference": { "oneOf": [ { - "$ref": "#/definitions/OSDisk" + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set" }, - "dataDisks": { + "osDisk": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - } + "$ref": "#/definitions/OSDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." } }, "description": "Specifies the storage settings for the virtual machine disks." @@ -4404,10 +4582,6 @@ "TerminateNotificationProfile": { "type": "object", "properties": { - "notBeforeTimeout": { - "type": "string", - "description": "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)" - }, "enable": { "oneOf": [ { @@ -4418,12 +4592,27 @@ } ], "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + }, + "notBeforeTimeout": { + "type": "string", + "description": "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)" } } }, "UpgradePolicy": { "type": "object", "properties": { + "automaticOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, "mode": { "oneOf": [ { @@ -4450,49 +4639,62 @@ } ], "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgradePolicy": { - "oneOf": [ - { - "$ref": "#/definitions/AutomaticOSUpgradePolicy" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Configuration parameters used for performing automatic OS Upgrade." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." }, + "UserArtifactManage": { + "type": "object", + "properties": { + "install": { + "type": "string", + "description": "Required. The path and arguments to install the gallery application. This is limited to 4096 characters." + }, + "remove": { + "type": "string", + "description": "Required. The path and arguments to remove the gallery application. This is limited to 4096 characters." + }, + "update": { + "type": "string", + "description": "Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters." + } + }, + "required": [ + "install", + "remove" + ] + }, "UserArtifactSource": { "type": "object", "properties": { - "fileName": { + "defaultConfigurationLink": { "type": "string", - "description": "Required. The fileName of the artifact." + "description": "Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob." }, "mediaLink": { "type": "string", - "description": "Required. The mediaLink of the artifact, must be a readable storage blob." + "description": "Required. The mediaLink of the artifact, must be a readable storage page blob." } }, "required": [ - "fileName", "mediaLink" ], "description": "The source image from which the Image Version is going to be created." }, + "UserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VaultCertificate": { "type": "object", "properties": { - "certificateUrl": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" - }, "certificateStore": { "type": "string", "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -4508,8 +4710,7 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + ] }, "vaultCertificates": { "oneOf": [ @@ -4545,15 +4746,7 @@ "type": "string", "description": "The virtual machine extension name." }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { + "statuses": { "oneOf": [ { "type": "array", @@ -4567,7 +4760,7 @@ ], "description": "The resource status information." }, - "statuses": { + "substatuses": { "oneOf": [ { "type": "array", @@ -4580,20 +4773,6 @@ } ], "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "type": "object", - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." }, "type": { "type": "string", @@ -4602,7 +4781,13 @@ "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." - }, + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { "autoUpgradeMinorVersion": { "oneOf": [ { @@ -4614,11 +4799,9 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." }, "instanceView": { "oneOf": [ @@ -4629,7 +4812,29 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine extension instance view." + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -4638,12 +4843,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "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." }, @@ -4652,8 +4864,9 @@ { "type": "object", "additionalProperties": { - "$ref": "#/definitions/VirtualMachineIdentityUserAssignedIdentitiesValue" - } + "$ref": "#/definitions/UserAssignedIdentitiesValue" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -4664,77 +4877,79 @@ }, "description": "Identity for the virtual machine." }, - "VirtualMachineIdentityUserAssignedIdentitiesValue": {}, "VirtualMachineProperties": { "type": "object", "properties": { - "hardwareProfile": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the hardware settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "storageProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "additionalCapabilities": { + "billingProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/BillingProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." }, - "osProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "networkProfile": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/NetworkProfile" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the network interfaces of the virtual machine." + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." }, - "diagnosticsProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the hardware settings for the virtual machine." }, - "availabilitySet": { + "host": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -4742,30 +4957,33 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

    This property cannot exist along with a non-null properties.virtualMachineScaleSet reference." + ] }, - "virtualMachineScaleSet": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/NetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set.

    This property cannot exist along with a non-null properties.availabilitySet reference.

    Minimum api‐version: 2019‐03‐01" + "description": "Specifies the network interfaces of the virtual machine." }, - "proximityPlacementGroup": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01." + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." }, "priority": { "oneOf": [ @@ -4783,33 +5001,28 @@ ], "description": "Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01." }, - "evictionPolicy": { + "proximityPlacementGroup": { "oneOf": [ { - "type": "string", - "enum": [ - "Deallocate", - "Delete" - ] + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the eviction policy for the Azure Spot virtual machine. Only supported value is 'Deallocate'.

    Minimum api-version: 2019-03-01." + ] }, - "billingProfile": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/BillingProfile" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the billing related details of a Azure Spot virtual machine.

    Minimum api-version: 2019-03-01." + "description": "Specifies the storage settings for the virtual machine disks." }, - "host": { + "virtualMachineScaleSet": { "oneOf": [ { "$ref": "#/definitions/SubResource" @@ -4817,231 +5030,67 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "virtualMachines_extensions_childResource": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, - "apiVersion": { - "type": "string", - "enum": [ - "2019-07-01" - ] - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "oneOf": [ - { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Resource tags" - }, - "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" - } ] } }, - "required": [ - "name", - "type", - "apiVersion", - "location", - "properties" - ], - "description": "Microsoft.Compute/virtualMachines/extensions" + "description": "Describes the properties of a Virtual Machine." }, "VirtualMachineScaleSetDataDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { + "caching": { "oneOf": [ { - "type": "integer" + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "caching": { + "createOption": { "oneOf": [ { "type": "string", "enum": [ - "None", - "ReadOnly", - "ReadWrite" + "FromImage", + "Empty", + "Attach" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + "description": "The create option." }, - "writeAcceleratorEnabled": { + "diskIOPSReadWrite": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." }, - "createOption": { + "diskMBpsReadWrite": { "oneOf": [ { - "type": "string", - "enum": [ - "FromImage", - "Empty", - "Attach" - ] + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The create option." + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." }, "diskSizeGB": { "oneOf": [ @@ -5054,43 +5103,47 @@ ], "description": "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.

    This value cannot be larger than 1023 GB" }, - "managedDisk": { + "lun": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "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." }, - "diskIOPSReadWrite": { + "managedDisk": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + "description": "Describes the parameters of a ScaleSet managed disk." }, - "diskMBpsReadWrite": { + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ - "lun", - "createOption" + "createOption", + "lun" ], "description": "Describes a virtual machine scale set data disk." }, @@ -5102,113 +5155,15 @@ "description": "The name of the extension." }, "properties": { - "anyOf": [ - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/genericExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/iaaSDiagnostics" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/iaaSAntimalware" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/customScriptExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/customScriptForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/linuxDiagnostic" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/bgInfo" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/vmAccessAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dscExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackupLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/acronisBackup" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/linuxChefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/chefClient" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/datadogLinuxAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/datadogWindowsAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dockerExtension" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/dynatraceWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/eset" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/hpeSecurityApplicationDefender" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/puppetAgent" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/site24x7LinuxServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/site24x7WindowsServerExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/site24x7ApmInsightExtn" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSALinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/trendMicroDSA" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/bmcCtmAgentWindows" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/OSPatchingForLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshot" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/VMSnapshotLinux" - }, - { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/customScript" - }, + "oneOf": [ { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentWindows" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" }, { - "$ref": "https://schema.management.azure.com/schemas/2019-07-01/Microsoft.Compute.Extensions.json#/definitions/networkWatcherAgentLinux" + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." } }, "description": "Describes a Virtual Machine Scale Set Extension." @@ -5236,22 +5191,6 @@ "VirtualMachineScaleSetExtensionProperties": { "type": "object", "properties": { - "forceUpdateTag": { - "type": "string", - "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, "autoUpgradeMinorVersion": { "oneOf": [ { @@ -5263,10 +5202,13 @@ ], "description": "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." }, - "settings": { - "description": "Json formatted public settings for the extension." + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." }, "protectedSettings": { + "type": "object", + "properties": {}, "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, "provisionAfterExtensions": { @@ -5282,6 +5224,23 @@ } ], "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." @@ -5290,12 +5249,19 @@ "type": "object", "properties": { "type": { - "type": "string", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], "description": "The type of identity used for the virtual machine scale set. 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 scale set." }, @@ -5305,7 +5271,8 @@ "type": "object", "additionalProperties": { "$ref": "#/definitions/VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue" - } + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" @@ -5316,7 +5283,10 @@ }, "description": "Identity for the virtual machine scale set." }, - "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": {}, + "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, "VirtualMachineScaleSetIPConfiguration": { "type": "object", "properties": { @@ -5336,7 +5306,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." } }, "required": [ @@ -5347,109 +5318,109 @@ "VirtualMachineScaleSetIPConfigurationProperties": { "type": "object", "properties": { - "subnet": { + "applicationGatewayBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/ApiEntityReference" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the identifier of the subnet." + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, - "primary": { + "applicationSecurityGroups": { "oneOf": [ { - "type": "boolean" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Specifies an array of references to application security group." }, - "publicIPAddressConfiguration": { + "loadBalancerBackendAddressPools": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The publicIPAddressConfiguration." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." }, - "privateIPAddressVersion": { + "loadBalancerInboundNatPools": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" }, - "applicationGatewayBackendAddressPools": { + "primary": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, - "applicationSecurityGroups": { + "privateIPAddressVersion": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to application security group." + "description": "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'." }, - "loadBalancerBackendAddressPools": { + "publicIPAddressConfiguration": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, - "loadBalancerInboundNatPools": { + "subnet": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - } + "$ref": "#/definitions/ApiEntityReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + "description": "The API entity reference." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." @@ -5471,6 +5442,17 @@ "VirtualMachineScaleSetManagedDiskParameters": { "type": "object", "properties": { + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, "storageAccountType": { "oneOf": [ { @@ -5487,17 +5469,6 @@ } ], "description": "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." - }, - "diskEncryptionSet": { - "oneOf": [ - { - "$ref": "#/definitions/DiskEncryptionSetParameters" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies the customer managed disk encryption set resource id for the managed disk." } }, "description": "Describes the parameters of a ScaleSet managed disk." @@ -5521,7 +5492,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." } }, "required": [ @@ -5552,16 +5524,16 @@ "VirtualMachineScaleSetNetworkConfigurationProperties": { "type": "object", "properties": { - "primary": { + "dnsSettings": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "enableAcceleratedNetworking": { "oneOf": [ @@ -5574,43 +5546,42 @@ ], "description": "Specifies whether the network interface is accelerated networking-enabled." }, - "networkSecurityGroup": { + "enableIPForwarding": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The network security group." + "description": "Whether IP forwarding enabled on this NIC." }, - "dnsSettings": { + "ipConfigurations": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the network interfaces." + "description": "Specifies the IP configurations of the network interface." }, - "ipConfigurations": { + "networkSecurityGroup": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - } + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the IP configurations of the network interface." + ] }, - "enableIPForwarding": { + "primary": { "oneOf": [ { "type": "boolean" @@ -5619,7 +5590,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether IP forwarding enabled on this NIC." + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." } }, "required": [ @@ -5639,7 +5610,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + "description": "The API entity reference." }, "networkInterfaceConfigurations": { "oneOf": [ @@ -5661,10 +5632,6 @@ "VirtualMachineScaleSetOSDisk": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, "caching": { "oneOf": [ { @@ -5681,17 +5648,6 @@ ], "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." }, - "writeAcceleratorEnabled": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, "createOption": { "oneOf": [ { @@ -5717,7 +5673,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." }, "diskSizeGB": { "oneOf": [ @@ -5730,31 +5686,46 @@ ], "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" }, - "osType": { + "image": { "oneOf": [ { - "type": "string", - "enum": [ - "Windows", - "Linux" - ] + "$ref": "#/definitions/VirtualHardDisk" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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**." + "description": "Describes the uri of a disk." }, - "image": { + "managedDisk": { "oneOf": [ { - "$ref": "#/definitions/VirtualHardDisk" + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the unmanaged user image to base the scale set on." + "description": "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**." }, "vhdContainers": { "oneOf": [ @@ -5770,16 +5741,16 @@ ], "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, - "managedDisk": { + "writeAcceleratorEnabled": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The managed disk parameters." + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } }, "required": [ @@ -5790,33 +5761,22 @@ "VirtualMachineScaleSetOSProfile": { "type": "object", "properties": { - "computerNamePrefix": { + "adminPassword": { "type": "string", - "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "adminPassword": { + "computerNamePrefix": { "type": "string", - "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "customData": { "type": "string", "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" }, - "windowsConfiguration": { - "oneOf": [ - { - "$ref": "#/definitions/WindowsConfiguration" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "Specifies Windows operating system settings on the virtual machine." - }, "linuxConfiguration": { "oneOf": [ { @@ -5841,6 +5801,17 @@ } ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." } }, "description": "Describes a virtual machine scale set OS profile." @@ -5848,16 +5819,16 @@ "VirtualMachineScaleSetProperties": { "type": "object", "properties": { - "upgradePolicy": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/UpgradePolicy" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The upgrade policy." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, "automaticRepairsPolicy": { "oneOf": [ @@ -5868,18 +5839,18 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Policy for automatic repairs." + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." }, - "virtualMachineProfile": { + "doNotRunExtensionsOnOverprovisionedVMs": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The virtual machine profile." + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." }, "overprovision": { "oneOf": [ @@ -5892,82 +5863,81 @@ ], "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, - "doNotRunExtensionsOnOverprovisionedVMs": { + "platformFaultDomainCount": { "oneOf": [ { - "type": "boolean" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + "description": "Fault Domain count for each placement group." }, - "singlePlacementGroup": { + "proximityPlacementGroup": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + ] }, - "zoneBalance": { + "scaleInPolicy": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/ScaleInPolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Describes a scale-in policy for a virtual machine scale set." }, - "platformFaultDomainCount": { + "singlePlacementGroup": { "oneOf": [ { - "type": "integer" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Fault Domain count for each placement group." + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." }, - "proximityPlacementGroup": { + "upgradePolicy": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/UpgradePolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + "description": "Describes an upgrade policy - automatic, manual, or rolling." }, - "additionalCapabilities": { + "virtualMachineProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "description": "Describes a virtual machine scale set virtual machine profile." }, - "scaleInPolicy": { + "zoneBalance": { "oneOf": [ { - "$ref": "#/definitions/ScaleInPolicy" + "type": "boolean" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." } }, "description": "Describes the properties of a Virtual Machine Scale Set." @@ -5987,7 +5957,8 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" } }, "required": [ @@ -6011,27 +5982,27 @@ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "type": "object", "properties": { - "idleTimeoutInMinutes": { + "dnsSettings": { "oneOf": [ { - "type": "integer" + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The idle timeout of the public IP address." + "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, - "dnsSettings": { + "idleTimeoutInMinutes": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + "type": "integer" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "The dns settings to be applied on the publicIP addresses ." + "description": "The idle timeout of the public IP address." }, "ipTags": { "oneOf": [ @@ -6047,6 +6018,21 @@ ], "description": "The list of IP tags associated with the public IP address." }, + "publicIPAddressVersion": { + "oneOf": [ + { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, "publicIPPrefix": { "oneOf": [ { @@ -6055,45 +6041,66 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ] + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } ], - "description": "The PublicIPPrefix from which to allocate publicIP addresses." + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." }, - "publicIPAddressVersion": { + "imageReference": { "oneOf": [ { - "type": "string", - "enum": [ - "IPv4", - "IPv6" - ] + "$ref": "#/definitions/ImageReference" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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'." + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set" + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." } }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + "description": "Describes a virtual machine scale set storage profile." }, "virtualMachineScaleSets_extensions_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "extensions" - ] - }, "apiVersion": { "type": "string", "enum": [ "2019-07-01" ] }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, "properties": { "oneOf": [ { @@ -6102,29 +6109,27 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" ] } }, "required": [ - "name", - "type", "apiVersion", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" }, "virtualMachineScaleSets_virtualmachines_childResource": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "enum": [ - "virtualmachines" - ] - }, "apiVersion": { "type": "string", "enum": [ @@ -6135,19 +6140,20 @@ "type": "string", "description": "Resource location" }, - "tags": { + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { "oneOf": [ { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/Plan" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Resource tags" + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "oneOf": [ @@ -6157,70 +6163,98 @@ { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ] + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." }, - "plan": { + "tags": { "oneOf": [ { - "$ref": "#/definitions/Plan" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] } }, "required": [ - "name", - "type", "apiVersion", "location", - "properties" + "name", + "properties", + "type" ], "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" }, - "VirtualMachineScaleSetStorageProfile": { + "virtualMachineScaleSets_virtualMachines_extensions_childResource": { "type": "object", "properties": { - "imageReference": { - "oneOf": [ - { - "$ref": "#/definitions/ImageReference" - }, - { - "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" - } - ], - "description": "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." + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] }, - "osDisk": { + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Describes the properties of a Virtual Machine Extension." }, - "dataDisks": { + "tags": { "oneOf": [ { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - } + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] } }, - "description": "Describes a virtual machine scale set storage profile." + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" }, "VirtualMachineScaleSetVMNetworkProfileConfiguration": { "type": "object", @@ -6245,117 +6279,116 @@ "VirtualMachineScaleSetVMProfile": { "type": "object", "properties": { - "osProfile": { + "billingProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + "$ref": "#/definitions/BillingProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machines in the scale set." + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." }, - "storageProfile": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the storage settings for the virtual machine disks." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "networkProfile": { + "evictionPolicy": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." }, - "diagnosticsProfile": { + "extensionProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Describes a virtual machine scale set extension profile." }, - "extensionProfile": { + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "Describes a virtual machine scale set network profile." }, - "priority": { + "osProfile": { "oneOf": [ { - "type": "string", - "enum": [ - "Regular", - "Low", - "Spot" - ] + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." + "description": "Describes a virtual machine scale set OS profile." }, - "evictionPolicy": { + "priority": { "oneOf": [ { "type": "string", "enum": [ - "Deallocate", - "Delete" + "Regular", + "Low", + "Spot" ] }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the eviction policy for virtual machines in a Azure Spot scale set.

    Minimum api-version: 2017-10-30-preview." + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." }, - "billingProfile": { + "scheduledEventsProfile": { "oneOf": [ { - "$ref": "#/definitions/BillingProfile" + "$ref": "#/definitions/ScheduledEventsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + ] }, - "scheduledEventsProfile": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/ScheduledEventsProfile" + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies Scheduled Event related configurations." + "description": "Describes a virtual machine scale set storage profile." } }, "description": "Describes a virtual machine scale set virtual machine profile." @@ -6363,49 +6396,52 @@ "VirtualMachineScaleSetVMProperties": { "type": "object", "properties": { - "hardwareProfile": { + "additionalCapabilities": { "oneOf": [ { - "$ref": "#/definitions/HardwareProfile" + "$ref": "#/definitions/AdditionalCapabilities" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the hardware settings for the virtual machine." + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, - "storageProfile": { + "availabilitySet": { "oneOf": [ { - "$ref": "#/definitions/StorageProfile" + "$ref": "#/definitions/SubResource" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } - ], - "description": "Specifies the storage settings for the virtual machine disks." + ] }, - "additionalCapabilities": { + "diagnosticsProfile": { "oneOf": [ { - "$ref": "#/definitions/AdditionalCapabilities" + "$ref": "#/definitions/DiagnosticsProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." }, - "osProfile": { + "hardwareProfile": { "oneOf": [ { - "$ref": "#/definitions/OSProfile" + "$ref": "#/definitions/HardwareProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the operating system settings for the virtual machine." + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" }, "networkProfile": { "oneOf": [ @@ -6427,44 +6463,40 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the network profile configuration of the virtual machine." + "description": "Describes a virtual machine scale set VM network profile." }, - "diagnosticsProfile": { + "osProfile": { "oneOf": [ { - "$ref": "#/definitions/DiagnosticsProfile" + "$ref": "#/definitions/OSProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." }, - "availabilitySet": { + "protectionPolicy": { "oneOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + "description": "The protection policy of a virtual machine scale set VM." }, - "protectionPolicy": { + "storageProfile": { "oneOf": [ { - "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy" + "$ref": "#/definitions/StorageProfile" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the protection policy of the virtual machine." + "description": "Specifies the storage settings for the virtual machine disks." } }, "description": "Describes the properties of a virtual machine scale set virtual machine." @@ -6497,35 +6529,68 @@ }, "description": "The protection policy of a virtual machine scale set VM." }, - "WindowsConfiguration": { + "virtualMachines_extensions_childResource": { "type": "object", "properties": { - "provisionVMAgent": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-07-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { "oneOf": [ { - "type": "boolean" + "$ref": "#/definitions/VirtualMachineExtensionProperties" }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Describes the properties of a Virtual Machine Extension." }, - "enableAutomaticUpdates": { + "tags": { "oneOf": [ { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} }, { "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "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." + "description": "Resource tags" }, - "timeZone": { + "type": { "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { "additionalUnattendContent": { "oneOf": [ { @@ -6540,6 +6605,32 @@ ], "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, "winRM": { "oneOf": [ { @@ -6549,7 +6640,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + "description": "Describes Windows Remote Management configuration of the VM" } }, "description": "Specifies Windows operating system settings on the virtual machine." @@ -6577,6 +6668,10 @@ "WinRMListener": { "type": "object", "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, "protocol": { "oneOf": [ { @@ -6590,11 +6685,7 @@ "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" } ], - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**." - }, - "certificateUrl": { - "type": "string", - "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + "description": "Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https**." } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" diff --git a/schemas/2019-11-01/Microsoft.Compute.json b/schemas/2019-11-01/Microsoft.Compute.json new file mode 100644 index 0000000000..8baa546e00 --- /dev/null +++ b/schemas/2019-11-01/Microsoft.Compute.json @@ -0,0 +1,795 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-11-01/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "diskEncryptionSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-11-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/diskEncryptionSets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/diskEncryptionSets" + }, + "disks": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-11-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Disk resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/DiskSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logical zone list for Disk." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/disks" + }, + "snapshots": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-11-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Snapshot resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/snapshots" + } + }, + "definitions": { + "CreationData": { + "type": "object", + "properties": { + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This enumerates the possible sources of a disk's creation." + }, + "galleryImageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "uploadSizeBytes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "DiskProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskIOPSReadOnly": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/Encryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "maxShares": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "Encryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of key used to encrypt the data of the disk." + } + }, + "description": "Encryption at rest settings for disk or snapshot" + }, + "EncryptionSetIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported." + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "EncryptionSetProperties": { + "type": "object", + "properties": { + "activeKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + } + }, + "EncryptionSettingsCollection": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + }, + "description": "Encryption settings for one disk volume." + }, + "ImageDiskReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "KeyVaultAndKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "KeyVaultAndSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/Encryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "incremental": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "SourceVault": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } +} diff --git a/schemas/2019-12-01/Microsoft.Compute.json b/schemas/2019-12-01/Microsoft.Compute.json new file mode 100644 index 0000000000..903aa91da1 --- /dev/null +++ b/schemas/2019-12-01/Microsoft.Compute.json @@ -0,0 +1,6113 @@ +{ + "id": "https://schema.management.azure.com/schemas/2019-12-01/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "availabilitySets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilitySetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a resource." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/availabilitySets" + }, + "galleries": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Shared Image Gallery." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_images_childResource" + }, + { + "$ref": "#/definitions/galleries_applications_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries" + }, + "galleries_applications": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_applications_versions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications" + }, + "galleries_applications_versions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications/versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications/versions" + }, + "galleries_images": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Definition." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_images_versions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images" + }, + "galleries_images_versions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images/versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images/versions" + }, + "hostGroups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Dedicated Host Group Properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/hostGroups_hosts_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/hostGroups" + }, + "hostGroups_hosts": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DedicatedHostProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the dedicated host." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups/hosts" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "sku", + "type" + ], + "description": "Microsoft.Compute/hostGroups/hosts" + }, + "images": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an Image." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/images" + }, + "proximityPlacementGroups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the proximity placement group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProximityPlacementGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Proximity Placement Group." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/proximityPlacementGroups" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/proximityPlacementGroups" + }, + "sshPublicKeys": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the SSH public key." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SshPublicKeyResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the SSH public key." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/sshPublicKeys" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/sshPublicKeys" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine zones." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" + }, + "virtualMachineScaleSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set" + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachineScaleSets_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualMachines_extensions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachineScaleSets_virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + } + }, + "definitions": { + "AdditionalCapabilities": { + "type": "object", + "properties": { + "ultraSSDEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + }, + "content": { + "type": "string", + "description": "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." + }, + "passName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "OobeSystem" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The pass name. Currently, the only allowable value is OobeSystem." + }, + "settingName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AutomaticOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutomaticRollback": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS image rollback feature should be disabled. Default value is false." + }, + "enableAutomaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "AutomaticRepairsPolicy": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "virtualMachines": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of references to all virtual machines in the availability set." + } + }, + "description": "The instance view of a resource." + }, + "BillingProfile": { + "type": "object", + "properties": { + "maxPrice": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "BootDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "toBeDetached": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a data disk." + }, + "DataDiskImageEncryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "required": [ + "lun" + ], + "description": "Contains encryption settings for a data disk image." + }, + "DedicatedHostGroupProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1, + "maximum": 3 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of fault domains that the host group can span." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostProperties": { + "type": "object", + "properties": { + "autoReplaceOnFailure": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "licenseType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**." + }, + "platformFaultDomain": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 2 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault domain of the dedicated host within a dedicated host group." + } + }, + "description": "Properties of the dedicated host." + }, + "DiagnosticsProfile": { + "type": "object", + "properties": { + "bootDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/BootDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "DiffDiskSettings": { + "type": "object", + "properties": { + "option": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Local" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "oneOf": [ + { + "type": "string", + "enum": [ + "CacheDisk", + "ResourceDisk" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the ephemeral disk placement for operating system disk.

    Possible values are:

    **CacheDisk**

    **ResourceDisk**

    Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.

    Refer to VM size documentation for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "Disallowed": { + "type": "object", + "properties": { + "diskTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "DiskEncryptionSetParameters": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Secret" + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Key" + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "EncryptionImages": { + "type": "object", + "properties": { + "dataDiskImages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImageEncryption" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of encryption specifications for data disk images." + }, + "osDiskImage": { + "oneOf": [ + { + "$ref": "#/definitions/OSDiskImageEncryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains encryption settings for an OS disk image." + } + }, + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "galleries_applications_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "applications" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications" + }, + "galleries_applications_versions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications/versions" + }, + "galleries_images_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Definition." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images" + }, + "galleries_images_versions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Image Version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images/versions" + }, + "GalleryApplicationProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Application Definition resource. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Application Definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "supportedOSType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux**." + } + }, + "required": [ + "supportedOSType" + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "GalleryApplicationVersionProperties": { + "type": "object", + "properties": { + "publishingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionPublishingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The publishing profile of a gallery image version." + } + }, + "required": [ + "publishingProfile" + ], + "description": "Describes the properties of a gallery Image Version." + }, + "GalleryApplicationVersionPublishingProfile": { + "type": "object", + "properties": { + "enableHealthCheck": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional. Whether or not this application reports health." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "manageActions": { + "oneOf": [ + { + "$ref": "#/definitions/UserArtifactManage" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/UserArtifactSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image from which the Image Version is going to be created." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + }, + "targetRegions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + } + }, + "required": [ + "source" + ], + "description": "The publishing profile of a gallery image version." + }, + "GalleryArtifactVersionSource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, or user image." + } + }, + "description": "The gallery artifact version source." + }, + "GalleryDataDiskImage": { + "type": "object", + "properties": { + "hostCaching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery artifact version source." + } + }, + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "GalleryIdentifier": { + "type": "object", + "properties": {}, + "description": "Describes the gallery unique name." + }, + "GalleryImageIdentifier": { + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "The name of the gallery Image Definition offer." + }, + "publisher": { + "type": "string", + "description": "The name of the gallery Image Definition publisher." + }, + "sku": { + "type": "string", + "description": "The name of the gallery Image Definition SKU." + } + }, + "required": [ + "offer", + "publisher", + "sku" + ], + "description": "This is the gallery Image Definition identifier." + }, + "GalleryImageProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Image Definition resource. This property is updatable." + }, + "disallowed": { + "oneOf": [ + { + "$ref": "#/definitions/Disallowed" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the disallowed disk types." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Image Definition." + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "identifier": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageIdentifier" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the gallery Image Definition identifier." + }, + "osState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "purchasePlan": { + "oneOf": [ + { + "$ref": "#/definitions/ImagePurchasePlan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." + }, + "recommended": { + "oneOf": [ + { + "$ref": "#/definitions/RecommendedMachineConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + } + }, + "required": [ + "identifier", + "osState", + "osType" + ], + "description": "Describes the properties of a gallery Image Definition." + }, + "GalleryImageVersionProperties": { + "type": "object", + "properties": { + "publishingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The publishing profile of a gallery Image Version." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the storage profile of a Gallery Image Version." + } + }, + "required": [ + "storageProfile" + ], + "description": "Describes the properties of a gallery Image Version." + }, + "GalleryImageVersionPublishingProfile": { + "type": "object", + "properties": { + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + }, + "targetRegions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + } + }, + "description": "The publishing profile of a gallery Image Version." + }, + "GalleryImageVersionStorageProfile": { + "type": "object", + "properties": { + "dataDiskImages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of data disk images." + }, + "osDiskImage": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryOSDiskImage" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the OS disk image." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery artifact version source." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "GalleryOSDiskImage": { + "type": "object", + "properties": { + "hostCaching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery artifact version source." + } + }, + "description": "This is the OS disk image." + }, + "GalleryProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this Shared Image Gallery resource. This property is updatable." + }, + "identifier": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryIdentifier" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the gallery unique name." + } + }, + "description": "Describes the properties of a Shared Image Gallery." + }, + "HardwareProfile": { + "type": "object", + "properties": { + "vmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "hostGroups_hosts_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DedicatedHostProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the dedicated host." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "hosts" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "sku", + "type" + ], + "description": "Microsoft.Compute/hostGroups/hosts" + }, + "ImageDataDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageOSDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The OS State." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "osState", + "osType" + ], + "description": "Describes an Operating System disk." + }, + "ImageProperties": { + "type": "object", + "properties": { + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image." + }, + "sourceVirtualMachine": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ImageStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a storage profile." + } + }, + "description": "Describes the properties of an Image." + }, + "ImagePurchasePlan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "The product ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Describes the gallery Image Definition purchase plan. This is used by marketplace images." + }, + "ImageReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "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." + } + }, + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "ImageStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ImageOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an Operating System disk." + }, + "zoneResilient": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "InstanceViewStatus": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "level": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Info", + "Warning", + "Error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The level code." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "KeyVaultKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "KeyVaultSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "LinuxConfiguration": { + "type": "object", + "properties": { + "disablePasswordAuthentication": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether password authentication should be disabled." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "ssh": { + "oneOf": [ + { + "$ref": "#/definitions/SshConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSH configuration for Linux based VMs running on Azure" + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "ManagedDiskParameters": { + "type": "object", + "properties": { + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "id": { + "type": "string", + "description": "Resource Id" + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "The parameters of a managed disk." + }, + "NetworkInterfaceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network interface reference properties." + } + }, + "description": "Describes a network interface reference." + }, + "NetworkInterfaceReferenceProperties": { + "type": "object", + "properties": { + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "OSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None** for Standard storage. **ReadOnly** for Premium storage." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiffDiskSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "encryptionSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a Encryption Settings for a Disk" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption" + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "OSDiskImageEncryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + } + }, + "description": "Contains encryption settings for an OS disk image." + }, + "OSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "allowExtensionOperations": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "requireGuestProvisionSignal": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "ProximityPlacementGroupProperties": { + "type": "object", + "properties": { + "colocationStatus": { + "oneOf": [ + { + "$ref": "#/definitions/InstanceViewStatus" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Instance view status." + }, + "proximityPlacementGroupType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard", + "Ultra" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "RecommendedMachineConfiguration": { + "type": "object", + "properties": { + "memory": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRange" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the resource range." + }, + "vCPUs": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRange" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the resource range." + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "type": "object", + "properties": { + "max": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of the resource." + }, + "min": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "RollingUpgradePolicy": { + "type": "object", + "properties": { + "maxBatchInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ScaleInPolicy": { + "type": "object", + "properties": { + "rules": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "OldestVM", + "NewestVM" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The rules to be followed when scaling-in a virtual machine scale set.

    Possible values are:

    **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

    **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

    **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    " + } + }, + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "oneOf": [ + { + "$ref": "#/definitions/TerminateNotificationProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + } + }, + "Sku": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "SshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "SshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshPublicKeyResourceProperties": { + "type": "object", + "properties": { + "publicKey": { + "type": "string", + "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format." + } + }, + "description": "Properties of the SSH public key." + }, + "StorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/OSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + } + }, + "TargetRegion": { + "type": "object", + "properties": { + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionImages" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "name": { + "type": "string", + "description": "The name of the region." + }, + "regionalReplicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { + "enable": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + }, + "notBeforeTimeout": { + "type": "string", + "description": "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)" + } + } + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "automaticOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + }, + "rollingUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/RollingUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used while performing a rolling upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "UserArtifactManage": { + "type": "object", + "properties": { + "install": { + "type": "string", + "description": "Required. The path and arguments to install the gallery application. This is limited to 4096 characters." + }, + "remove": { + "type": "string", + "description": "Required. The path and arguments to remove the gallery application. This is limited to 4096 characters." + }, + "update": { + "type": "string", + "description": "Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters." + } + }, + "required": [ + "install", + "remove" + ] + }, + "UserArtifactSource": { + "type": "object", + "properties": { + "defaultConfigurationLink": { + "type": "string", + "description": "Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob." + }, + "mediaLink": { + "type": "string", + "description": "Required. The mediaLink of the artifact, must be a readable storage page blob." + } + }, + "required": [ + "mediaLink" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "UserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, + "VaultCertificate": { + "type": "object", + "properties": { + "certificateStore": { + "type": "string", + "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "properties": { + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "vaultCertificates": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "VirtualHardDisk": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "VirtualMachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "statuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "substatuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "instanceView": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "userAssignedIdentities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentitiesValue" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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}'." + } + }, + "description": "Identity for the virtual machine." + }, + "VirtualMachineProperties": { + "type": "object", + "properties": { + "additionalCapabilities": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalCapabilities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "billingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/BillingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "evictionPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "host": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "priority": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Regular", + "Low", + "Spot" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + }, + "virtualMachineScaleSet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The create option." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "properties": { + "extensions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisionAfterExtensions": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of identity used for the virtual machine scale set. 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 scale set." + }, + "userAssignedIdentities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "properties": { + "applicationGatewayBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + }, + "loadBalancerInboundNatPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "privateIPAddressVersion": { + "oneOf": [ + { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "publicIPAddressConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "properties": { + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "properties": { + "dnsServers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "enableAcceleratedNetworking": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "enableIPForwarding": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether IP forwarding enabled on this NIC." + }, + "ipConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the IP configurations of the network interface." + }, + "networkSecurityGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "properties": { + "healthProbe": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + }, + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiffDiskSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhdContainers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetProperties": { + "type": "object", + "properties": { + "additionalCapabilities": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalCapabilities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "automaticRepairsPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticRepairsPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "overprovision": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "scaleInPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ScaleInPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "singlePlacementGroup": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "virtualMachineProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "zoneBalance": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "idleTimeoutInMinutes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The idle timeout of the public IP address." + }, + "ipTags": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPAddressVersion": { + "oneOf": [ + { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "publicIPPrefix": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachineScaleSets_virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "type": "object", + "properties": { + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProfile": { + "type": "object", + "properties": { + "billingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/BillingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "evictionPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "extensionProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set OS profile." + }, + "priority": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Regular", + "Low", + "Spot" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." + }, + "scheduledEventsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ScheduledEventsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set storage profile." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetVMProperties": { + "type": "object", + "properties": { + "additionalCapabilities": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalCapabilities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set VM network profile." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "protectionPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The protection policy of a virtual machine scale set VM." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "type": "object", + "properties": { + "protectFromScaleIn": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2019-12-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { + "additionalUnattendContent": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "winRM": { + "oneOf": [ + { + "$ref": "#/definitions/WinRMConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes Windows Remote Management configuration of the VM" + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "WinRMConfiguration": { + "type": "object", + "properties": { + "listeners": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WinRMListener": { + "type": "object", + "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Http", + "Https" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https**." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + } + } +} diff --git a/schemas/2020-05-01/Microsoft.Compute.json b/schemas/2020-05-01/Microsoft.Compute.json new file mode 100644 index 0000000000..8621f61864 --- /dev/null +++ b/schemas/2020-05-01/Microsoft.Compute.json @@ -0,0 +1,910 @@ +{ + "id": "https://schema.management.azure.com/schemas/2020-05-01/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "diskAccesses": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-05-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskAccessProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/diskAccesses" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/diskAccesses" + }, + "diskEncryptionSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-05-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/diskEncryptionSets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/diskEncryptionSets" + }, + "disks": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-05-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Disk resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/DiskSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logical zone list for Disk." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/disks" + }, + "snapshots": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-05-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Snapshot resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/snapshots" + } + }, + "definitions": { + "CreationData": { + "type": "object", + "properties": { + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This enumerates the possible sources of a disk's creation." + }, + "galleryImageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "uploadSizeBytes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "DiskAccessProperties": { + "type": "object", + "properties": {} + }, + "DiskProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "diskIOPSReadOnly": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/Encryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "maxShares": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "networkAccessPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "Encryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Encryption at rest settings for disk or snapshot" + }, + "EncryptionSetIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported." + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "EncryptionSetProperties": { + "type": "object", + "properties": { + "activeKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "encryptionType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + } + }, + "EncryptionSettingsCollection": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + }, + "description": "Encryption settings for one disk volume." + }, + "ImageDiskReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "KeyVaultAndKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "KeyVaultAndSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/Encryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "incremental": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "networkAccessPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "SourceVault": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } +} diff --git a/schemas/2020-06-01/Microsoft.Compute.json b/schemas/2020-06-01/Microsoft.Compute.json new file mode 100644 index 0000000000..0ee65cb9cd --- /dev/null +++ b/schemas/2020-06-01/Microsoft.Compute.json @@ -0,0 +1,5215 @@ +{ + "id": "https://schema.management.azure.com/schemas/2020-06-01/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "availabilitySets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the availability set." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/AvailabilitySetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a resource." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/availabilitySets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/availabilitySets" + }, + "hostGroups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Dedicated Host Group Properties." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/hostGroups_hosts_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/hostGroups" + }, + "hostGroups_hosts": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DedicatedHostProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the dedicated host." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/hostGroups/hosts" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "sku", + "type" + ], + "description": "Microsoft.Compute/hostGroups/hosts" + }, + "images": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the image." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of an Image." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/images" + }, + "proximityPlacementGroups": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the proximity placement group." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/ProximityPlacementGroupProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Proximity Placement Group." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/proximityPlacementGroups" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/proximityPlacementGroups" + }, + "sshPublicKeys": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the SSH public key." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SshPublicKeyResourceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the SSH public key." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/sshPublicKeys" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/sshPublicKeys" + }, + "virtualMachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachines_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachines_runCommands_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine zones." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines" + }, + "virtualMachineScaleSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Identity for the virtual machine scale set." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualmachines_childResource" + } + ] + } + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set" + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets" + }, + "virtualMachineScaleSets_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualMachines_extensions_childResource" + }, + { + "$ref": "#/definitions/virtualMachineScaleSets_virtualMachines_runCommands_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachineScaleSets_virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + }, + "virtualMachineScaleSets_virtualMachines_runCommands": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine run command." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine run command." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands" + }, + "virtualMachines_extensions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "virtualMachines_runCommands": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine run command." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine run command." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/virtualMachines/runCommands" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/runCommands" + } + }, + "definitions": { + "AdditionalCapabilities": { + "type": "object", + "properties": { + "ultraSSDEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "type": "object", + "properties": { + "componentName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup." + }, + "content": { + "type": "string", + "description": "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." + }, + "passName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "OobeSystem" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The pass name. Currently, the only allowable value is OobeSystem." + }, + "settingName": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "AutomaticOSUpgradePolicy": { + "type": "object", + "properties": { + "disableAutomaticRollback": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether OS image rollback feature should be disabled. Default value is false." + }, + "enableAutomaticOSUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "AutomaticRepairsPolicy": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "AvailabilitySetProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count." + }, + "platformUpdateDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Update Domain count." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "virtualMachines": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of references to all virtual machines in the availability set." + } + }, + "description": "The instance view of a resource." + }, + "BillingProfile": { + "type": "object", + "properties": { + "maxPrice": { + "oneOf": [ + { + "type": "number" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "BootDiagnostics": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "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." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "toBeDetached": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a data disk." + }, + "DedicatedHostGroupProperties": { + "type": "object", + "properties": { + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer", + "minimum": 1 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Number of fault domains that the host group can span." + }, + "supportAutomaticPlacement": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.

    Minimum api-version: 2020-06-01." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostProperties": { + "type": "object", + "properties": { + "autoReplaceOnFailure": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "licenseType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**." + }, + "platformFaultDomain": { + "oneOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault domain of the dedicated host within a dedicated host group." + } + }, + "description": "Properties of the dedicated host." + }, + "DiagnosticsProfile": { + "type": "object", + "properties": { + "bootDiagnostics": { + "oneOf": [ + { + "$ref": "#/definitions/BootDiagnostics" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "DiffDiskSettings": { + "type": "object", + "properties": { + "option": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Local" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "oneOf": [ + { + "type": "string", + "enum": [ + "CacheDisk", + "ResourceDisk" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the ephemeral disk placement for operating system disk.

    Possible values are:

    **CacheDisk**

    **ResourceDisk**

    Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.

    Refer to VM size documentation for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "DiskEncryptionSetParameters": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "DiskEncryptionSettings": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Secret" + }, + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a reference to Key Vault Key" + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "HardwareProfile": { + "type": "object", + "properties": { + "vmSize": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region]( https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).

    This list of sizes is no longer updated and the **VirtualMachineSizeTypes** string constants will be removed from the subsequent REST API specification. Use [List all available virtual machine sizes in a region]( https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list) to get the latest sizes." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "hostGroups_hosts_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the dedicated host ." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DedicatedHostProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Properties of the dedicated host." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/Sku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "hosts" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "sku", + "type" + ], + "description": "Microsoft.Compute/hostGroups/hosts" + }, + "ImageDataDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageOSDisk": { + "type": "object", + "properties": { + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The OS State." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**." + }, + "snapshot": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "required": [ + "osState", + "osType" + ], + "description": "Describes an Operating System disk." + }, + "ImageProperties": { + "type": "object", + "properties": { + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image." + }, + "sourceVirtualMachine": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ImageStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a storage profile." + } + }, + "description": "Describes the properties of an Image." + }, + "ImageReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "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." + } + }, + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "ImageStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ImageOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an Operating System disk." + }, + "zoneResilient": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "InstanceViewStatus": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "level": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Info", + "Warning", + "Error" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The level code." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "KeyVaultKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "KeyVaultSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "LinuxConfiguration": { + "type": "object", + "properties": { + "disablePasswordAuthentication": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether password authentication should be disabled." + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "ssh": { + "oneOf": [ + { + "$ref": "#/definitions/SshConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "SSH configuration for Linux based VMs running on Azure" + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "ManagedDiskParameters": { + "type": "object", + "properties": { + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "id": { + "type": "string", + "description": "Resource Id" + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "The parameters of a managed disk." + }, + "NetworkInterfaceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a network interface reference properties." + } + }, + "description": "Describes a network interface reference." + }, + "NetworkInterfaceReferenceProperties": { + "type": "object", + "properties": { + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "OSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None** for Standard storage. **ReadOnly** for Premium storage." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiffDiskSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "encryptionSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a Encryption Settings for a Disk" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/ManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters of a managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhd": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption" + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "OSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "allowExtensionOperations": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "computerName": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "customData": { + "type": "string", + "description": "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.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "requireGuestProvisionSignal": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.**" + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "PatchSettings": { + "type": "object", + "properties": { + "patchMode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mode of in-guest patching to IaaS virtual machine.

    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." + } + } + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "ProximityPlacementGroupProperties": { + "type": "object", + "properties": { + "colocationStatus": { + "oneOf": [ + { + "$ref": "#/definitions/InstanceViewStatus" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Instance view status." + }, + "proximityPlacementGroupType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard", + "Ultra" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "RollingUpgradePolicy": { + "type": "object", + "properties": { + "maxBatchInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 5, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "oneOf": [ + { + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "RunCommandInputParameter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes the properties of a run command parameter." + }, + "ScaleInPolicy": { + "type": "object", + "properties": { + "rules": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "OldestVM", + "NewestVM" + ] + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The rules to be followed when scaling-in a virtual machine scale set.

    Possible values are:

    **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

    **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

    **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    " + } + }, + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "oneOf": [ + { + "$ref": "#/definitions/TerminateNotificationProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + } + }, + "SecurityProfile": { + "type": "object", + "properties": { + "encryptionAtHost": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource." + } + }, + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "Sku": { + "type": "object", + "properties": { + "capacity": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the number of virtual machines in the scale set." + }, + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "SshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "SshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "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](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "path": { + "type": "string", + "description": "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" + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshPublicKeyResourceProperties": { + "type": "object", + "properties": { + "publicKey": { + "type": "string", + "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format." + } + }, + "description": "Properties of the SSH public key." + }, + "StorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/OSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { + "enable": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + }, + "notBeforeTimeout": { + "type": "string", + "description": "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)" + } + } + }, + "UpgradePolicy": { + "type": "object", + "properties": { + "automaticOSUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticOSUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "mode": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time." + }, + "rollingUpgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/RollingUpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The configuration parameters used while performing a rolling upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "UserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, + "VaultCertificate": { + "type": "object", + "properties": { + "certificateStore": { + "type": "string", + "description": "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." + }, + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "properties": { + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "vaultCertificates": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "VirtualHardDisk": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "VirtualMachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "statuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "substatuses": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The resource status information." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "enableAutomaticUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "instanceView": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The instance view of a virtual machine extension." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "userAssignedIdentities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentitiesValue" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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}'." + } + }, + "description": "Identity for the virtual machine." + }, + "VirtualMachineProperties": { + "type": "object", + "properties": { + "additionalCapabilities": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalCapabilities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "billingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/BillingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "evictionPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "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 api-version: 2020-06-01" + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "host": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "hostGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "licenseType": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "priority": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Regular", + "Low", + "Spot" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "securityProfile": { + "oneOf": [ + { + "$ref": "#/definitions/SecurityProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + }, + "virtualMachineScaleSet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachineRunCommandProperties": { + "type": "object", + "properties": { + "asyncExecution": { + "oneOf": [ + { + "type": "boolean", + "default": false + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete." + }, + "errorBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script error stream will be uploaded." + }, + "outputBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script output stream will be uploaded." + }, + "parameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters used by the script." + }, + "protectedParameters": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The parameters used by the script." + }, + "runAsPassword": { + "type": "string", + "description": "Specifies the user account password on the VM when executing the run command." + }, + "runAsUser": { + "type": "string", + "description": "Specifies the user account on the VM when executing the run command." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineRunCommandScriptSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the script sources for run command." + }, + "timeoutInSeconds": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The timeout in seconds to execute the run command." + } + }, + "description": "Describes the properties of a Virtual Machine run command." + }, + "VirtualMachineRunCommandScriptSource": { + "type": "object", + "properties": { + "commandId": { + "type": "string", + "description": "Specifies a commandId of predefined built-in script." + }, + "script": { + "type": "string", + "description": "Specifies the script content to be executed on the VM." + }, + "scriptUri": { + "type": "string", + "description": "Specifies the script download location." + } + }, + "description": "Describes the script sources for run command." + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The create option." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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.

    This value cannot be larger than 1023 GB" + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption", + "lun" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "properties": { + "extensions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The virtual machine scale set child extension resources." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "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 api-version: 2020-06-01" + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "properties": { + "autoUpgradeMinorVersion": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "enableAutomaticUpgrade": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "protectedSettings": { + "type": "object", + "properties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisionAfterExtensions": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "settings": { + "type": "object", + "properties": {}, + "description": "Json formatted public settings for the extension." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of identity used for the virtual machine scale set. 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 scale set." + }, + "userAssignedIdentities": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue": { + "type": "object", + "properties": {} + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "properties": { + "applicationGatewayBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + }, + "loadBalancerInboundNatPools": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "privateIPAddressVersion": { + "oneOf": [ + { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "publicIPAddressConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "subnet": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "properties": { + "diskEncryptionSet": { + "oneOf": [ + { + "$ref": "#/definitions/DiskEncryptionSetParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "properties": { + "dnsServers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "enableAcceleratedNetworking": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "enableFpga": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "enableIPForwarding": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether IP forwarding enabled on this NIC." + }, + "ipConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the IP configurations of the network interface." + }, + "networkSecurityGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "primary": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "properties": { + "healthProbe": { + "oneOf": [ + { + "$ref": "#/definitions/ApiEntityReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The API entity reference." + }, + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "properties": { + "caching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**." + }, + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "FromImage", + "Empty", + "Attach" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "oneOf": [ + { + "$ref": "#/definitions/DiffDiskSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualHardDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the uri of a disk." + }, + "managedDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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**." + }, + "vhdContainers": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "writeAcceleratorEnabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "customData": { + "type": "string", + "description": "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.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "linuxConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/LinuxConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + }, + "windowsConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/WindowsConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies Windows operating system settings on the virtual machine." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetProperties": { + "type": "object", + "properties": { + "additionalCapabilities": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalCapabilities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "automaticRepairsPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/AutomaticRepairsPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "hostGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "overprovision": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "platformFaultDomainCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "scaleInPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/ScaleInPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "singlePlacementGroup": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "upgradePolicy": { + "oneOf": [ + { + "$ref": "#/definitions/UpgradePolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "virtualMachineProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "zoneBalance": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "properties": { + "dnsSettings": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "idleTimeoutInMinutes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The idle timeout of the public IP address." + }, + "ipTags": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPAddressVersion": { + "oneOf": [ + { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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'." + }, + "publicIPPrefix": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "properties": { + "dataDisks": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "osDisk": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set operating system disk." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "virtualMachineScaleSets_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the VM scale set extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/extensions" + }, + "virtualMachineScaleSets_virtualmachines_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The instance ID of the virtual machine." + }, + "plan": { + "oneOf": [ + { + "$ref": "#/definitions/Plan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "virtualmachines" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines" + }, + "virtualMachineScaleSets_virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions" + }, + "virtualMachineScaleSets_virtualMachines_runCommands_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine run command." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine run command." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "runCommands" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands" + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "type": "object", + "properties": { + "networkInterfaceConfigurations": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProfile": { + "type": "object", + "properties": { + "billingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/BillingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "evictionPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Deallocate", + "Delete" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "extensionProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set network profile." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set OS profile." + }, + "priority": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Regular", + "Low", + "Spot" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview." + }, + "scheduledEventsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/ScheduledEventsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "securityProfile": { + "oneOf": [ + { + "$ref": "#/definitions/SecurityProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set storage profile." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetVMProperties": { + "type": "object", + "properties": { + "additionalCapabilities": { + "oneOf": [ + { + "$ref": "#/definitions/AdditionalCapabilities" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "availabilitySet": { + "oneOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "diagnosticsProfile": { + "oneOf": [ + { + "$ref": "#/definitions/DiagnosticsProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "hardwareProfile": { + "oneOf": [ + { + "$ref": "#/definitions/HardwareProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the hardware settings for the virtual machine." + }, + "licenseType": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

    [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

    Minimum api-version: 2015-06-15" + }, + "networkProfile": { + "oneOf": [ + { + "$ref": "#/definitions/NetworkProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes a virtual machine scale set VM network profile." + }, + "osProfile": { + "oneOf": [ + { + "$ref": "#/definitions/OSProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "protectionPolicy": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The protection policy of a virtual machine scale set VM." + }, + "securityProfile": { + "oneOf": [ + { + "$ref": "#/definitions/SecurityProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/StorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage settings for the virtual machine disks." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "type": "object", + "properties": { + "protectFromScaleIn": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "virtualMachines_extensions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineExtensionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine Extension." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "extensions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/extensions" + }, + "virtualMachines_runCommands_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-01" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the virtual machine run command." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Virtual Machine run command." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "runCommands" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/virtualMachines/runCommands" + }, + "WindowsConfiguration": { + "type": "object", + "properties": { + "additionalUnattendContent": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "enableAutomaticUpdates": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "patchSettings": { + "oneOf": [ + { + "$ref": "#/definitions/PatchSettings" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "provisionVMAgent": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "winRM": { + "oneOf": [ + { + "$ref": "#/definitions/WinRMConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes Windows Remote Management configuration of the VM" + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "WinRMConfiguration": { + "type": "object", + "properties": { + "listeners": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WinRMListener": { + "type": "object", + "properties": { + "certificateUrl": { + "type": "string", + "description": "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](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). 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\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, + "protocol": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Http", + "Https" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https**." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + } + } +} diff --git a/schemas/2020-06-30/Microsoft.Compute.json b/schemas/2020-06-30/Microsoft.Compute.json new file mode 100644 index 0000000000..2ade6083c3 --- /dev/null +++ b/schemas/2020-06-30/Microsoft.Compute.json @@ -0,0 +1,962 @@ +{ + "id": "https://schema.management.azure.com/schemas/2020-06-30/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "diskAccesses": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskAccessProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/diskAccesses" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/diskAccesses" + }, + "diskEncryptionSets": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-30" + ] + }, + "identity": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSetProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/diskEncryptionSets" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/diskEncryptionSets" + }, + "disks": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/DiskProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Disk resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/DiskSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/disks" + ] + }, + "zones": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Logical zone list for Disk." + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/disks" + }, + "snapshots": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-06-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Snapshot resource properties." + }, + "sku": { + "oneOf": [ + { + "$ref": "#/definitions/SnapshotSku" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/snapshots" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/snapshots" + } + }, + "definitions": { + "CreationData": { + "type": "object", + "properties": { + "createOption": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This enumerates the possible sources of a disk's creation." + }, + "galleryImageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "imageReference": { + "oneOf": [ + { + "$ref": "#/definitions/ImageDiskReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image used for creating the disk." + }, + "logicalSectorSize": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "uploadSizeBytes": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "DiskAccessProperties": { + "type": "object", + "properties": {} + }, + "DiskProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "diskIOPSReadOnly": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskIOPSReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskMBpsReadWrite": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Unattached", + "Attached", + "Reserved", + "ActiveSAS", + "ReadyToUpload", + "ActiveUpload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The state of the disk." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/Encryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "maxShares": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "networkAccessPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + }, + "tier": { + "type": "string", + "description": "Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "DiskSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "Encryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + }, + "description": "Encryption at rest settings for disk or snapshot" + }, + "EncryptionSetIdentity": { + "type": "object", + "properties": { + "type": { + "oneOf": [ + { + "type": "string", + "enum": [ + "SystemAssigned" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported." + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "EncryptionSetProperties": { + "type": "object", + "properties": { + "activeKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "encryptionType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + } + } + }, + "EncryptionSettingsCollection": { + "type": "object", + "properties": { + "enabled": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "type": "object", + "properties": { + "diskEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndSecretReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "keyEncryptionKey": { + "oneOf": [ + { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + } + }, + "description": "Encryption settings for one disk volume." + }, + "ImageDiskReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "KeyVaultAndKeyReference": { + "type": "object", + "properties": { + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "KeyVaultAndSecretReference": { + "type": "object", + "properties": { + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + }, + "sourceVault": { + "oneOf": [ + { + "$ref": "#/definitions/SourceVault" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "oneOf": [ + { + "$ref": "#/definitions/CreationData" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Data used when creating a disk." + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + }, + "diskSizeGB": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Unattached", + "Attached", + "Reserved", + "ActiveSAS", + "ReadyToUpload", + "ActiveUpload" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The state of the snapshot." + }, + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/Encryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption at rest settings for disk or snapshot" + }, + "encryptionSettingsCollection": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionSettingsCollection" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Encryption settings for disk or snapshot" + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "incremental": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "networkAccessPolicy": { + "oneOf": [ + { + "type": "string", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The Operating System type." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "SnapshotSku": { + "type": "object", + "properties": { + "name": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The sku name." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "SourceVault": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } +} diff --git a/schemas/2020-09-30/Microsoft.Compute.json b/schemas/2020-09-30/Microsoft.Compute.json new file mode 100644 index 0000000000..4174d7d6fb --- /dev/null +++ b/schemas/2020-09-30/Microsoft.Compute.json @@ -0,0 +1,1445 @@ +{ + "id": "https://schema.management.azure.com/schemas/2020-09-30/Microsoft.Compute.json#", + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Microsoft.Compute", + "description": "Microsoft Compute Resource Types", + "resourceDefinitions": { + "galleries": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a Shared Image Gallery." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_images_childResource" + }, + { + "$ref": "#/definitions/galleries_applications_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries" + }, + "galleries_applications": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_applications_versions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications" + }, + "galleries_applications_versions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery image version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/applications/versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications/versions" + }, + "galleries_images": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery image definition." + }, + "resources": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/definitions/galleries_images_versions_childResource" + } + ] + } + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images" + }, + "galleries_images_versions": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery image version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Compute/galleries/images/versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images/versions" + } + }, + "definitions": { + "DataDiskImageEncryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "required": [ + "lun" + ], + "description": "Contains encryption settings for a data disk image." + }, + "Disallowed": { + "type": "object", + "properties": { + "diskTypes": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "EncryptionImages": { + "type": "object", + "properties": { + "dataDiskImages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImageEncryption" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of encryption specifications for data disk images." + }, + "osDiskImage": { + "oneOf": [ + { + "$ref": "#/definitions/OSDiskImageEncryption" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Contains encryption settings for an OS disk image." + } + }, + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "galleries_applications_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "applications" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications" + }, + "galleries_applications_versions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery image version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/applications/versions" + }, + "galleries_images_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery image definition." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "images" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images" + }, + "galleries_images_versions_childResource": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "enum": [ + "2020-09-30" + ] + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "name": { + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + "properties": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionProperties" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the properties of a gallery image version." + }, + "tags": { + "oneOf": [ + { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "properties": {} + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Resource tags" + }, + "type": { + "type": "string", + "enum": [ + "versions" + ] + } + }, + "required": [ + "apiVersion", + "location", + "name", + "properties", + "type" + ], + "description": "Microsoft.Compute/galleries/images/versions" + }, + "GalleryApplicationProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Application Definition resource. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Application Definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "supportedOSType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux**." + } + }, + "required": [ + "supportedOSType" + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "GalleryApplicationVersionProperties": { + "type": "object", + "properties": { + "publishingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryApplicationVersionPublishingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The publishing profile of a gallery image version." + } + }, + "required": [ + "publishingProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryApplicationVersionPublishingProfile": { + "type": "object", + "properties": { + "enableHealthCheck": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional. Whether or not this application reports health." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "manageActions": { + "oneOf": [ + { + "$ref": "#/definitions/UserArtifactManage" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ] + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/UserArtifactSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The source image from which the Image Version is going to be created." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + }, + "targetRegions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + } + }, + "required": [ + "source" + ], + "description": "The publishing profile of a gallery image version." + }, + "GalleryArtifactVersionSource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource." + }, + "uri": { + "type": "string", + "description": "The uri of the gallery artifact version source. Currently used to specify vhd/blob source." + } + }, + "description": "The gallery artifact version source." + }, + "GalleryDataDiskImage": { + "type": "object", + "properties": { + "hostCaching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'." + }, + "lun": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery artifact version source." + } + }, + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "GalleryIdentifier": { + "type": "object", + "properties": {}, + "description": "Describes the gallery unique name." + }, + "GalleryImageFeature": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery image feature." + }, + "value": { + "type": "string", + "description": "The value of the gallery image feature." + } + }, + "description": "A feature for gallery image." + }, + "GalleryImageIdentifier": { + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "offer", + "publisher", + "sku" + ], + "description": "This is the gallery image definition identifier." + }, + "GalleryImageProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery image definition resource. This property is updatable." + }, + "disallowed": { + "oneOf": [ + { + "$ref": "#/definitions/Disallowed" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the disallowed disk types." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery image definition." + }, + "features": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageFeature" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of gallery image features." + }, + "hyperVGeneration": { + "oneOf": [ + { + "type": "string", + "enum": [ + "V1", + "V2" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only." + }, + "identifier": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageIdentifier" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the gallery image definition identifier." + }, + "osState": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'." + }, + "osType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Windows", + "Linux" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "purchasePlan": { + "oneOf": [ + { + "$ref": "#/definitions/ImagePurchasePlan" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the gallery image definition purchase plan. This is used by marketplace images." + }, + "recommended": { + "oneOf": [ + { + "$ref": "#/definitions/RecommendedMachineConfiguration" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + } + }, + "required": [ + "identifier", + "osState", + "osType" + ], + "description": "Describes the properties of a gallery image definition." + }, + "GalleryImageVersionProperties": { + "type": "object", + "properties": { + "publishingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The publishing profile of a gallery image Version." + }, + "storageProfile": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryImageVersionStorageProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the storage profile of a Gallery Image Version." + } + }, + "required": [ + "storageProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryImageVersionPublishingProfile": { + "type": "object", + "properties": { + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "oneOf": [ + { + "type": "boolean" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "replicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + }, + "targetRegions": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + } + }, + "description": "The publishing profile of a gallery image Version." + }, + "GalleryImageVersionStorageProfile": { + "type": "object", + "properties": { + "dataDiskImages": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + } + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "A list of data disk images." + }, + "osDiskImage": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryOSDiskImage" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This is the OS disk image." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery artifact version source." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "GalleryOSDiskImage": { + "type": "object", + "properties": { + "hostCaching": { + "oneOf": [ + { + "type": "string", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'." + }, + "source": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The gallery artifact version source." + } + }, + "description": "This is the OS disk image." + }, + "GalleryProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of this Shared Image Gallery resource. This property is updatable." + }, + "identifier": { + "oneOf": [ + { + "$ref": "#/definitions/GalleryIdentifier" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the gallery unique name." + }, + "sharingProfile": { + "oneOf": [ + { + "$ref": "#/definitions/SharingProfile" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Profile for gallery sharing to subscription or tenant" + } + }, + "description": "Describes the properties of a Shared Image Gallery." + }, + "ImagePurchasePlan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "The product ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Describes the gallery image definition purchase plan. This is used by marketplace images." + }, + "OSDiskImageEncryption": { + "type": "object", + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + } + }, + "description": "Contains encryption settings for an OS disk image." + }, + "RecommendedMachineConfiguration": { + "type": "object", + "properties": { + "memory": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRange" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the resource range." + }, + "vCPUs": { + "oneOf": [ + { + "$ref": "#/definitions/ResourceRange" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Describes the resource range." + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "type": "object", + "properties": { + "max": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The maximum number of the resource." + }, + "min": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The minimum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "SharingProfile": { + "type": "object", + "properties": { + "permissions": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Private", + "Groups" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "This property allows you to specify the permission of sharing gallery.

    Possible values are:

    **Private**

    **Groups**." + } + }, + "description": "Profile for gallery sharing to subscription or tenant" + }, + "TargetRegion": { + "type": "object", + "properties": { + "encryption": { + "oneOf": [ + { + "$ref": "#/definitions/EncryptionImages" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "name": { + "type": "string", + "description": "The name of the region." + }, + "regionalReplicaCount": { + "oneOf": [ + { + "type": "integer" + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." + }, + "storageAccountType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ] + }, + { + "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression" + } + ], + "description": "Specifies the storage account type to be used to store the image. This property is not updatable." + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "UserArtifactManage": { + "type": "object", + "properties": { + "install": { + "type": "string", + "description": "Required. The path and arguments to install the gallery application. This is limited to 4096 characters." + }, + "remove": { + "type": "string", + "description": "Required. The path and arguments to remove the gallery application. This is limited to 4096 characters." + }, + "update": { + "type": "string", + "description": "Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters." + } + }, + "required": [ + "install", + "remove" + ] + }, + "UserArtifactSource": { + "type": "object", + "properties": { + "defaultConfigurationLink": { + "type": "string", + "description": "Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob." + }, + "mediaLink": { + "type": "string", + "description": "Required. The mediaLink of the artifact, must be a readable storage page blob." + } + }, + "required": [ + "mediaLink" + ], + "description": "The source image from which the Image Version is going to be created." + } + } +} diff --git a/schemas/2020-10-01-preview/Microsoft.Compute.json b/schemas/2020-10-01-preview/Microsoft.Compute.json index 2272e5c9c7..42d93b1b6f 100644 --- a/schemas/2020-10-01-preview/Microsoft.Compute.json +++ b/schemas/2020-10-01-preview/Microsoft.Compute.json @@ -609,4 +609,4 @@ } } } -} \ No newline at end of file +}