{ "description": "Generator information:\n- Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-03-01/virtualMachine.json\n- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "properties": { "additionalCapabilities": { "description": "AdditionalCapabilities: Specifies additional capabilities enabled or disabled on the virtual machine.", "properties": { "hibernationEnabled": { "description": "HibernationEnabled: The flag that enables or disables hibernation capability on the VM.", "type": "boolean" }, "ultraSSDEnabled": { "description": "UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS\nstorage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual\nmachine or virtual machine scale set only if this property is enabled.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "applicationProfile": { "description": "ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS", "properties": { "galleryApplications": { "description": "GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS", "items": { "description": "Specifies the required information to reference a compute gallery application version", "properties": { "configurationReference": { "description": "ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the\npackage if provided", "type": "string" }, "enableAutomaticUpgrade": { "description": "EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be\nautomatically updated for the VM/VMSS", "type": "boolean" }, "order": { "description": "Order: Optional, Specifies the order in which the packages have to be installed", "type": "integer" }, "packageReferenceReference": { "description": "PackageReferenceReference: Specifies the GalleryApplicationVersion resource id on the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false }, "tags": { "description": "Tags: Optional, Specifies a passthrough value for more generic context.", "type": "string" }, "treatFailureAsDeploymentFailure": { "description": "TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the\ndeployment", "type": "boolean" } }, "required": [ "packageReferenceReference" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "availabilitySet": { "description": "AvailabilitySet: Specifies information about the availability set that the virtual machine should be assigned to.\nVirtual machines specified in the same availability set are allocated to different nodes to maximize availability. For\nmore information about availability sets, see [Availability sets\noverview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).\nFor more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in\nAzure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates)\nCurrently, a VM can only be added to availability set at creation time. The availability set to which the VM is being\nadded should be under the same resource group as the availability set resource. An existing VM cannot be added to an\navailability set.\nThis property cannot exist along with a non-null properties.virtualMachineScaleSet reference.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "azureName": { "description": "AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it\ndoesn't have to be.", "type": "string" }, "billingProfile": { "description": "BillingProfile: Specifies the billing related details of a Azure Spot virtual machine.\nMinimum api-version: 2019-03-01.", "properties": { "maxPrice": { "description": "MaxPrice: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.\nThis price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time\nof create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current\nAzure Spot price.\nThe maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the\nmaxPrice after creation of VM/VMSS.\nPossible values are:\n- Any decimal value greater than zero. Example: 0.01538\n-1 \u2013 indicates default price to be up-to on-demand.\nYou can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also,\nthe default max price is -1 if it is not provided by you.\nMinimum api-version: 2019-03-01.", "type": "number" } }, "type": "object", "additionalProperties": false }, "capacityReservation": { "description": "CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine.\nMinimum api-version: 2021-04-01.", "properties": { "capacityReservationGroup": { "description": "CapacityReservationGroup: Specifies the capacity reservation group resource id that should be used for allocating the\nvirtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to\nhttps://aka.ms/CapacityReservation for more details.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "diagnosticsProfile": { "description": "DiagnosticsProfile: Specifies the boot diagnostic settings state.\nMinimum api-version: 2015-06-15.", "properties": { "bootDiagnostics": { "description": "BootDiagnostics: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to\ndiagnose VM status.\nNOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as\nthe VM.\nYou can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor.", "properties": { "enabled": { "description": "Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.", "type": "boolean" }, "storageUri": { "description": "StorageUri: Uri of the storage account to use for placing the console output and screenshot.\nIf storageUri is not specified while enabling boot diagnostics, managed storage will be used.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "evictionPolicy": { "description": "EvictionPolicy: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.\nFor Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.\nFor Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is\n2017-10-30-preview.", "enum": [ "Deallocate", "Delete" ], "type": "string" }, "extendedLocation": { "description": "ExtendedLocation: The extended location of the Virtual Machine.", "properties": { "name": { "description": "Name: The name of the extended location.", "type": "string" }, "type": { "description": "Type: The type of the extended location.", "enum": [ "EdgeZone" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "extensionsTimeBudget": { "description": "ExtensionsTimeBudget: Specifies the time alloted for all extensions to start. The time duration should be between 15\nminutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes\n(PT1H30M).\nMinimum api-version: 2020-06-01", "type": "string" }, "hardwareProfile": { "description": "HardwareProfile: Specifies the hardware settings for the virtual machine.", "properties": { "vmSize": { "description": "VmSize: Specifies the size of the virtual machine.\nThe enum data type is currently deprecated and will be removed by December 23rd 2023.\nRecommended way to get the list of available sizes is using these APIs:\n[List all available virtual machine sizes in an availability\nset](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)\n[List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list)\n[List all available virtual machine sizes for\nresizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about\nvirtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).\nThe available VM sizes depend on region and availability set.", "type": "string" }, "vmSizeProperties": { "description": "VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version:\n2021-07-01.\nThis feature is still in preview mode and is not supported for VirtualMachineScaleSet.\nPlease follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details.", "properties": { "vCPUsAvailable": { "description": "VCPUsAvailable: Specifies the number of vCPUs available for the VM.\nWhen this property is not specified in the request body the default behavior is to set it to the value of vCPUs\navailable for that VM size exposed in api response of [List all available virtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) .", "type": "integer" }, "vCPUsPerCore": { "description": "VCPUsPerCore: Specifies the vCPU to physical core ratio.\nWhen this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the\nVM Size exposed in api response of [List all available virtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)\nSetting this property to 1 also means that hyper-threading is disabled.", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "host": { "description": "Host: Specifies information about the dedicated host that the virtual machine resides in.\nMinimum api-version: 2018-10-01.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "hostGroup": { "description": "HostGroup: Specifies information about the dedicated host group that the virtual machine resides in.\nMinimum api-version: 2020-06-01.\nNOTE: User cannot specify both host and hostGroup properties.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "identity": { "description": "Identity: The identity of the virtual machine, if configured.", "properties": { "type": { "description": "Type: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an\nimplicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the\nvirtual machine.", "enum": [ "None", "SystemAssigned", "SystemAssigned, UserAssigned", "UserAssigned" ], "type": "string" }, "userAssignedIdentities": { "description": "UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary\nkey references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", "items": { "description": "Information about the user assigned identity for the resource", "properties": { "reference": { "description": "ResourceReference represents a resource reference, either to a Kubernetes resource or directly to an Azure resource via ARMID", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "licenseType": { "description": "LicenseType: Specifies that the image or disk that is being used was licensed on-premises.\nPossible values for Windows Server operating system are:\nWindows_Client\nWindows_Server\nPossible values for Linux Server operating system are:\nRHEL_BYOS (for RHEL)\nSLES_BYOS (for SUSE)\nFor more information, see [Azure Hybrid Use Benefit for Windows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n[Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\nMinimum api-version: 2015-06-15", "type": "string" }, "location": { "description": "Location: Resource location", "type": "string" }, "networkProfile": { "description": "NetworkProfile: Specifies the network interfaces of the virtual machine.", "properties": { "networkApiVersion": { "description": "NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network\nInterface Configurations", "enum": [ "2020-11-01" ], "type": "string" }, "networkInterfaceConfigurations": { "description": "NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine\nnetworking resources.", "items": { "description": "Describes a virtual machine network interface configurations.", "properties": { "deleteOption": { "description": "DeleteOption: Specify what happens to the network interface when the VM is deleted", "enum": [ "Delete", "Detach" ], "type": "string" }, "dnsSettings": { "description": "DnsSettings: The dns settings to be applied on the network interfaces.", "properties": { "dnsServers": { "description": "DnsServers: List of DNS servers IP addresses", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "dscpConfiguration": { "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "enableAcceleratedNetworking": { "description": "EnableAcceleratedNetworking: Specifies whether the network interface is accelerated networking-enabled.", "type": "boolean" }, "enableFpga": { "description": "EnableFpga: Specifies whether the network interface is FPGA networking-enabled.", "type": "boolean" }, "enableIPForwarding": { "description": "EnableIPForwarding: Whether IP forwarding enabled on this NIC.", "type": "boolean" }, "ipConfigurations": { "description": "IpConfigurations: Specifies the IP configurations of the network interface.", "items": { "description": "Describes a virtual machine network profile's IP configuration.", "properties": { "applicationGatewayBackendAddressPools": { "description": "ApplicationGatewayBackendAddressPools: Specifies an array of references to backend address pools of application\ngateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual\nmachines cannot use the same application gateway.", "items": { "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" }, "applicationSecurityGroups": { "description": "ApplicationSecurityGroups: Specifies an array of references to application security group.", "items": { "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" }, "loadBalancerBackendAddressPools": { "description": "LoadBalancerBackendAddressPools: Specifies an array of references to backend address pools of load balancers. A virtual\nmachine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines\ncannot use the same basic sku load balancer].", "items": { "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The IP configuration name.", "type": "string" }, "primary": { "description": "Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.", "type": "boolean" }, "privateIPAddressVersion": { "description": "PrivateIPAddressVersion: Available from Api-Version 2017-03-30 onwards, it represents whether the specific\nipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "enum": [ "IPv4", "IPv6" ], "type": "string" }, "publicIPAddressConfiguration": { "description": "PublicIPAddressConfiguration: The publicIPAddressConfiguration.", "properties": { "deleteOption": { "description": "DeleteOption: Specify what happens to the public IP address when the VM is deleted", "enum": [ "Delete", "Detach" ], "type": "string" }, "dnsSettings": { "description": "DnsSettings: The dns settings to be applied on the publicIP addresses .", "properties": { "domainNameLabel": { "description": "DomainNameLabel: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name\nlabel is the concatenation of the domain name label and vm network profile unique ID.", "type": "string" } }, "required": [ "domainNameLabel" ], "type": "object", "additionalProperties": false }, "idleTimeoutInMinutes": { "description": "IdleTimeoutInMinutes: The idle timeout of the public IP address.", "type": "integer" }, "ipTags": { "description": "IpTags: The list of IP tags associated with the public IP address.", "items": { "description": "Contains the IP tag associated with the public IP address.", "properties": { "ipTagType": { "description": "IpTagType: IP tag type. Example: FirstPartyUsage.", "type": "string" }, "tag": { "description": "Tag: IP tag associated with the public IP. Example: SQL, Storage etc.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The publicIP address configuration name.", "type": "string" }, "publicIPAddressVersion": { "description": "PublicIPAddressVersion: Available from Api-Version 2019-07-01 onwards, it represents whether the specific\nipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "enum": [ "IPv4", "IPv6" ], "type": "string" }, "publicIPAllocationMethod": { "description": "PublicIPAllocationMethod: Specify the public IP allocation type", "enum": [ "Dynamic", "Static" ], "type": "string" }, "publicIPPrefix": { "description": "PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "sku": { "description": "Sku: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.", "properties": { "name": { "description": "Name: Specify public IP sku name", "enum": [ "Basic", "Standard" ], "type": "string" }, "tier": { "description": "Tier: Specify public IP sku tier", "enum": [ "Global", "Regional" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "subnet": { "description": "Subnet: Specifies the identifier of the subnet.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The network interface configuration name.", "type": "string" }, "networkSecurityGroup": { "description": "NetworkSecurityGroup: The network security group.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "primary": { "description": "Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.", "type": "boolean" } }, "required": [ "ipConfigurations", "name" ], "type": "object", "additionalProperties": false }, "type": "array" }, "networkInterfaces": { "description": "NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.", "items": { "description": "Describes a network interface reference.", "properties": { "deleteOption": { "description": "DeleteOption: Specify what happens to the network interface when the VM is deleted", "enum": [ "Delete", "Detach" ], "type": "string" }, "primary": { "description": "Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.", "type": "boolean" }, "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "operatorSpec": { "description": "OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not\npassed directly to Azure", "properties": { "configMapExpressions": { "description": "ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).", "items": { "description": "DestinationExpression is a CEL expression and a destination to store the result in. The destination may\nbe a secret or a configmap. The value of the expression is stored at the specified location in\nthe destination.", "properties": { "key": { "description": "Key is the key in the ConfigMap or Secret being written to. If the CEL expression in Value returns a string\nthis is required to identify what key to write to. If the CEL expression in Value returns a map[string]string\nKey must not be set, instead the keys written will be determined dynamically based on the keys of the resulting\nmap[string]string.", "type": "string" }, "name": { "description": "Name is the name of the Kubernetes configmap or secret to write to.\nThe configmap or secret will be created in the same namespace as the resource.", "type": "string" }, "value": { "description": "Value is a CEL expression. The CEL expression may return a string or a map[string]string. For more information\non CEL in ASO see https://azure.github.io/azure-service-operator/guide/expressions/", "type": "string" } }, "required": [ "name", "value" ], "type": "object", "additionalProperties": false }, "type": "array" }, "secretExpressions": { "description": "SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).", "items": { "description": "DestinationExpression is a CEL expression and a destination to store the result in. The destination may\nbe a secret or a configmap. The value of the expression is stored at the specified location in\nthe destination.", "properties": { "key": { "description": "Key is the key in the ConfigMap or Secret being written to. If the CEL expression in Value returns a string\nthis is required to identify what key to write to. If the CEL expression in Value returns a map[string]string\nKey must not be set, instead the keys written will be determined dynamically based on the keys of the resulting\nmap[string]string.", "type": "string" }, "name": { "description": "Name is the name of the Kubernetes configmap or secret to write to.\nThe configmap or secret will be created in the same namespace as the resource.", "type": "string" }, "value": { "description": "Value is a CEL expression. The CEL expression may return a string or a map[string]string. For more information\non CEL in ASO see https://azure.github.io/azure-service-operator/guide/expressions/", "type": "string" } }, "required": [ "name", "value" ], "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "osProfile": { "description": "OsProfile: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot\nbe changed once VM is provisioned.", "properties": { "adminPassword": { "description": "AdminPassword: Specifies the password of the administrator account.\nMinimum-length (Windows): 8 characters\nMinimum-length (Linux): 6 characters\nMax-length (Windows): 123 characters\nMax-length (Linux): 72 characters\nComplexity requirements: 3 out of 4 conditions below need to be fulfilled\nHas lower characters\nHas upper characters\nHas a digit\nHas a special character (Regex match [\\W_])\nDisallowed values: \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\"\nFor resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows\nVM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\nFor resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess\nExtension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", "properties": { "key": { "description": "Key is the key in the Kubernetes secret being referenced", "type": "string" }, "name": { "description": "Name is the name of the Kubernetes secret being referenced.\nThe secret must be in the same namespace as the resource", "type": "string" } }, "required": [ "key", "name" ], "type": "object", "additionalProperties": false }, "adminUsername": { "description": "AdminUsername: Specifies the name of the administrator account.\nThis property cannot be updated after the VM is created.\nWindows-only restriction: Cannot end in \".\"\nDisallowed values: \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\",\n\"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\",\n\"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".\nMinimum-length (Linux): 1 character\nMax-length (Linux): 64 characters\nMax-length (Windows): 20 characters.", "type": "string" }, "allowExtensionOperations": { "description": "AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine.\nThis may only be set to False when no extensions are present on the virtual machine.", "type": "boolean" }, "computerName": { "description": "ComputerName: Specifies the host OS name of the virtual machine.\nThis name cannot be updated after the VM is created.\nMax-length (Windows): 15 characters\nMax-length (Linux): 64 characters.\nFor naming conventions and restrictions see [Azure infrastructure services implementation\nguidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules).", "type": "string" }, "customData": { "description": "CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array\nthat is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.\nNote: Do not pass any secrets or passwords in customData property\nThis property cannot be updated after the VM is created.\ncustomData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure\nVMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)\nFor using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)", "type": "string" }, "linuxConfiguration": { "description": "LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine.\nFor a list of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", "properties": { "disablePasswordAuthentication": { "description": "DisablePasswordAuthentication: Specifies whether password authentication should be disabled.", "type": "boolean" }, "patchSettings": { "description": "PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Linux.", "properties": { "assessmentMode": { "description": "AssessmentMode: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.\nPossible values are:\nImageDefault - You control the timing of patch assessments on a virtual machine.\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.", "enum": [ "AutomaticByPlatform", "ImageDefault" ], "type": "string" }, "automaticByPlatformSettings": { "description": "AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on\nLinux.", "properties": { "rebootSetting": { "description": "RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", "enum": [ "Always", "IfRequired", "Never", "Unknown" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "patchMode": { "description": "PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual\nmachine scale set with OrchestrationMode as Flexible.\nPossible values are:\nImageDefault - The virtual machine's default patching configuration is used.\nAutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent\nmust be true", "enum": [ "AutomaticByPlatform", "ImageDefault" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "provisionVMAgent": { "description": "ProvisionVMAgent: Indicates whether virtual machine agent should be provisioned on the virtual machine.\nWhen this property is not specified in the request body, default behavior is to set it to true. This will ensure that\nVM Agent is installed on the VM so that extensions can be added to the VM later.", "type": "boolean" }, "ssh": { "description": "Ssh: Specifies the ssh key configuration for a Linux OS.", "properties": { "publicKeys": { "description": "PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.", "items": { "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.", "properties": { "keyData": { "description": "KeyData: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit\nand in ssh-rsa format.\nFor creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).", "type": "string" }, "path": { "description": "Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the\nspecified key is appended to the file. Example: /home/user/.ssh/authorized_keys", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "requireGuestProvisionSignal": { "description": "RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.", "type": "boolean" }, "secrets": { "description": "Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a\nvirtual machine it is recommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual\nmachine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "items": { "description": "Describes a set of certificates which are all in the same Key Vault.", "properties": { "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "vaultCertificates": { "description": "VaultCertificates: The list of key vault references in SourceVault which contain certificates.", "items": { "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.", "properties": { "certificateStore": { "description": "CertificateStore: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate\nshould be added. The specified certificate store is implicitly in the LocalMachine account.\nFor Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name\n<UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both\nof these files are .pem formatted.", "type": "string" }, "certificateUrl": { "description": "CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to\nthe Key Vault, see [Add a key or secret to the key\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to\nbe It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:\n{\n\"data\":\"\",\n\"dataType\":\"pfx\",\n\"password\":\"\"\n}\nTo install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual\nmachine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "windowsConfiguration": { "description": "WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.", "properties": { "additionalUnattendContent": { "description": "AdditionalUnattendContent: Specifies additional base-64 encoded XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup.", "items": { "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows\nSetup. Contents are defined by setting name, component name, and the pass in which the content is applied.", "properties": { "componentName": { "description": "ComponentName: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", "enum": [ "Microsoft-Windows-Shell-Setup" ], "type": "string" }, "content": { "description": "Content: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and\ncomponent. The XML must be less than 4KB and must include the root element for the setting or feature that is being\ninserted.", "type": "string" }, "passName": { "description": "PassName: The pass name. Currently, the only allowable value is OobeSystem.", "enum": [ "OobeSystem" ], "type": "string" }, "settingName": { "description": "SettingName: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and\nAutoLogon.", "enum": [ "AutoLogon", "FirstLogonCommands" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "enableAutomaticUpdates": { "description": "EnableAutomaticUpdates: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is\ntrue.\nFor virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.", "type": "boolean" }, "patchSettings": { "description": "PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Windows.", "properties": { "assessmentMode": { "description": "AssessmentMode: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.\nPossible values are:\nImageDefault - You control the timing of patch assessments on a virtual machine.\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.", "enum": [ "AutomaticByPlatform", "ImageDefault" ], "type": "string" }, "automaticByPlatformSettings": { "description": "AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on\nWindows.", "properties": { "rebootSetting": { "description": "RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", "enum": [ "Always", "IfRequired", "Never", "Unknown" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "enableHotpatching": { "description": "EnableHotpatching: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the\n'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.", "type": "boolean" }, "patchMode": { "description": "PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual\nmachine scale set with OrchestrationMode as Flexible.\nPossible values are:\nManual - You control the application of patches to a virtual machine. You do this by applying patches manually inside\nthe VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be\nfalse\nAutomaticByOS - The virtual machine will automatically be updated by the OS. The property\nWindowsConfiguration.enableAutomaticUpdates must be true.\nAutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent\nand WindowsConfiguration.enableAutomaticUpdates must be true", "enum": [ "AutomaticByOS", "AutomaticByPlatform", "Manual" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "provisionVMAgent": { "description": "ProvisionVMAgent: Indicates whether virtual machine agent should be provisioned on the virtual machine.\nWhen this property is not specified in the request body, default behavior is to set it to true. This will ensure that\nVM Agent is installed on the VM so that extensions can be added to the VM later.", "type": "boolean" }, "timeZone": { "description": "TimeZone: Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time\nzones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones).", "type": "string" }, "winRM": { "description": "WinRM: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.", "properties": { "listeners": { "description": "Listeners: The list of Windows Remote Management listeners", "items": { "description": "Describes Protocol and thumbprint of Windows Remote Management listener", "properties": { "certificateUrl": { "description": "CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to\nthe Key Vault, see [Add a key or secret to the key\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to\nbe It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:\n{\n\"data\":\"\",\n\"dataType\":\"pfx\",\n\"password\":\"\"\n}\nTo install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual\nmachine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "type": "string" }, "protocol": { "description": "Protocol: Specifies the protocol of WinRM listener.\nPossible values are:\nhttp\nhttps", "enum": [ "Http", "Https" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "owner": { "description": "Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also\ncontrols the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a\nreference to a resources.azure.com/ResourceGroup resource", "properties": { "armId": { "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "name": { "description": "This is the name of the Kubernetes resource to reference.", "type": "string" } }, "type": "object", "additionalProperties": false }, "plan": { "description": "Plan: Specifies information about the marketplace image used to create the virtual machine. This element is only used\nfor marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic\nuse. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy\nprogrammatically, Get Started ->. Enter any required information and then click Save.", "properties": { "name": { "description": "Name: The plan ID.", "type": "string" }, "product": { "description": "Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the\nimageReference element.", "type": "string" }, "promotionCode": { "description": "PromotionCode: The promotion code.", "type": "string" }, "publisher": { "description": "Publisher: The publisher ID.", "type": "string" } }, "type": "object", "additionalProperties": false }, "platformFaultDomain": { "description": "PlatformFaultDomain: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By\ndefault, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across\navailable fault domains.\n
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual\nMachine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated\nonce the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.\nMinimum api\u2010version: 2020\u201012\u201001", "type": "integer" }, "priority": { "description": "Priority: Specifies the priority for the virtual machine.\nMinimum api-version: 2019-03-01", "enum": [ "Low", "Regular", "Spot" ], "type": "string" }, "proximityPlacementGroup": { "description": "ProximityPlacementGroup: Specifies information about the proximity placement group that the virtual machine should be\nassigned to.\nMinimum api-version: 2018-04-01.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "scheduledEventsProfile": { "description": "ScheduledEventsProfile: Specifies Scheduled Event related configurations.", "properties": { "terminateNotificationProfile": { "description": "TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.", "properties": { "enable": { "description": "Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.", "type": "boolean" }, "notBeforeTimeout": { "description": "NotBeforeTimeout: Configurable length of time a Virtual Machine being deleted will have to potentially approve the\nTerminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601\nformat, the default value is 5 minutes (PT5M)", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "securityProfile": { "description": "SecurityProfile: Specifies the Security related profile settings for the virtual machine.", "properties": { "encryptionAtHost": { "description": "EncryptionAtHost: This property can be used by user in the request to enable or disable the Host Encryption for the\nvirtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp\ndisk at host itself.\nDefault: The Encryption at host will be disabled unless this property is set to true for the resource.", "type": "boolean" }, "securityType": { "description": "SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable\nUefiSettings.\nDefault: UefiSettings will not be enabled unless this property is set.", "enum": [ "ConfidentialVM", "TrustedLaunch" ], "type": "string" }, "uefiSettings": { "description": "UefiSettings: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.\nMinimum api-version: 2020-12-01", "properties": { "secureBootEnabled": { "description": "SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine.\nMinimum api-version: 2020-12-01", "type": "boolean" }, "vTpmEnabled": { "description": "VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine.\nMinimum api-version: 2020-12-01", "type": "boolean" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "storageProfile": { "description": "StorageProfile: Specifies the storage settings for the virtual machine disks.", "properties": { "dataDisks": { "description": "DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine.\nFor more information about disks, see [About disks and VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", "items": { "description": "Describes a data disk.", "properties": { "caching": { "description": "Caching: Specifies the caching requirements.\nPossible values are:\nNone\nReadOnly\nReadWrite\nDefault: None for Standard storage. ReadOnly for Premium storage", "enum": [ "None", "ReadOnly", "ReadWrite" ], "type": "string" }, "createOption": { "description": "CreateOption: Specifies how the virtual machine should be created.\nPossible values are:\nAttach \\u2013 This value is used when you are using a specialized disk to create the virtual machine.\nFromImage \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a\nplatform image, you also use the imageReference element described above. If you are using a marketplace image, you also\nuse the plan element previously described.", "enum": [ "Attach", "Empty", "FromImage" ], "type": "string" }, "deleteOption": { "description": "DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion.\nPossible values:\nDelete If this value is used, the data disk is deleted when VM is deleted.\nDetach If this value is used, the data disk is retained after VM is deleted.\nThe default value is set to detach", "enum": [ "Delete", "Detach" ], "type": "string" }, "detachOption": { "description": "DetachOption: Specifies the detach behavior to be used while detaching a disk or which is already in the process of\ndetachment from the virtual machine. Supported values: ForceDetach.\ndetachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk\ndid not complete due to an unexpected failure from the virtual machine and the disk is still not released then use\nforce-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed\nwhen using this detach behavior.\nThis feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk\nupdate toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.", "enum": [ "ForceDetach" ], "type": "string" }, "diskSizeGB": { "description": "DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the\ndisk in a virtual machine image.\nThis value cannot be larger than 1023 GB", "type": "integer" }, "image": { "description": "Image: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the\nvirtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "lun": { "description": "Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and\ntherefore must be unique for each data disk attached to a VM.", "type": "integer" }, "managedDisk": { "description": "ManagedDisk: The managed disk parameters.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false }, "securityProfile": { "description": "SecurityProfile: Specifies the security profile for the managed disk.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for\nCustomer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "securityEncryptionType": { "description": "SecurityEncryptionType: Specifies the EncryptionType of the managed disk.\nIt is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly\nfor encryption of just the VMGuestState blob.\nNOTE: It can be set for only Confidential VMs.", "enum": [ "DiskWithVMGuestState", "VMGuestStateOnly" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "storageAccountType": { "description": "StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with\ndata disks, it cannot be used with OS Disk.", "enum": [ "PremiumV2_LRS", "Premium_LRS", "Premium_ZRS", "StandardSSD_LRS", "StandardSSD_ZRS", "Standard_LRS", "UltraSSD_LRS" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "name": { "description": "Name: The disk name.", "type": "string" }, "toBeDetached": { "description": "ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset", "type": "boolean" }, "vhd": { "description": "Vhd: The virtual hard disk.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "writeAcceleratorEnabled": { "description": "WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.", "type": "boolean" } }, "required": [ "createOption", "lun" ], "type": "object", "additionalProperties": false }, "type": "array" }, "imageReference": { "description": "ImageReference: Specifies information about the image to use. You can specify information about platform images,\nmarketplace images, or virtual machine images. This element is required when you want to use a platform image,\nmarketplace image, or virtual machine image, but is not used in other creation operations.", "properties": { "communityGalleryImageId": { "description": "CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from\ncommunity gallery image GET call.", "type": "string" }, "offer": { "description": "Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.", "type": "string" }, "publisher": { "description": "Publisher: The image publisher.", "type": "string" }, "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false }, "sharedGalleryImageId": { "description": "SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared\ngallery image GET call.", "type": "string" }, "sku": { "description": "Sku: The image SKU.", "type": "string" }, "version": { "description": "Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The\nallowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use\nthe latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically\nupdate after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image\ndeployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just\nset\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\nin the 'id' field without version input.", "type": "string" } }, "type": "object", "additionalProperties": false }, "osDisk": { "description": "OsDisk: Specifies information about the operating system disk used by the virtual machine.\nFor more information about disks, see [About disks and VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", "properties": { "caching": { "description": "Caching: Specifies the caching requirements.\nPossible values are:\nNone\nReadOnly\nReadWrite\nDefault: None for Standard storage. ReadOnly for Premium storage.", "enum": [ "None", "ReadOnly", "ReadWrite" ], "type": "string" }, "createOption": { "description": "CreateOption: Specifies how the virtual machine should be created.\nPossible values are:\nAttach \\u2013 This value is used when you are using a specialized disk to create the virtual machine.\nFromImage \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a\nplatform image, you also use the imageReference element described above. If you are using a marketplace image, you also\nuse the plan element previously described.", "enum": [ "Attach", "Empty", "FromImage" ], "type": "string" }, "deleteOption": { "description": "DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion.\nPossible values:\nDelete If this value is used, the OS disk is deleted when VM is deleted.\nDetach If this value is used, the os disk is retained after VM is deleted.\nThe default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the\ndelete option for ephemeral OS Disk.", "enum": [ "Delete", "Detach" ], "type": "string" }, "diffDiskSettings": { "description": "DiffDiskSettings: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "properties": { "option": { "description": "Option: Specifies the ephemeral disk settings for operating system disk.", "enum": [ "Local" ], "type": "string" }, "placement": { "description": "Placement: Specifies the ephemeral disk placement for operating system disk.\nPossible values are:\nCacheDisk\nResourceDisk\nDefault: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used.\nRefer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and\nLinux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.", "enum": [ "CacheDisk", "ResourceDisk" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "diskSizeGB": { "description": "DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the\ndisk in a virtual machine image.\nThis value cannot be larger than 1023 GB", "type": "integer" }, "encryptionSettings": { "description": "EncryptionSettings: Specifies the encryption settings for the OS Disk.\nMinimum api-version: 2015-06-15", "properties": { "diskEncryptionKey": { "description": "DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.", "properties": { "secretUrl": { "description": "SecretUrl: The URL referencing a secret in a Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the secret.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "secretUrl", "sourceVault" ], "type": "object", "additionalProperties": false }, "enabled": { "description": "Enabled: Specifies whether disk encryption should be enabled on the virtual machine.", "type": "boolean" }, "keyEncryptionKey": { "description": "KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.", "properties": { "keyUrl": { "description": "KeyUrl: The URL referencing a key encryption key in Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the key.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "required": [ "keyUrl", "sourceVault" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "image": { "description": "Image: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the\nvirtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "managedDisk": { "description": "ManagedDisk: The managed disk parameters.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false }, "securityProfile": { "description": "SecurityProfile: Specifies the security profile for the managed disk.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for\nCustomer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "securityEncryptionType": { "description": "SecurityEncryptionType: Specifies the EncryptionType of the managed disk.\nIt is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly\nfor encryption of just the VMGuestState blob.\nNOTE: It can be set for only Confidential VMs.", "enum": [ "DiskWithVMGuestState", "VMGuestStateOnly" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "storageAccountType": { "description": "StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with\ndata disks, it cannot be used with OS Disk.", "enum": [ "PremiumV2_LRS", "Premium_LRS", "Premium_ZRS", "StandardSSD_LRS", "StandardSSD_ZRS", "Standard_LRS", "UltraSSD_LRS" ], "type": "string" } }, "type": "object", "additionalProperties": false }, "name": { "description": "Name: The disk name.", "type": "string" }, "osType": { "description": "OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from\nuser-image or a specialized VHD.\nPossible values are:\nWindows\nLinux", "enum": [ "Linux", "Windows" ], "type": "string" }, "vhd": { "description": "Vhd: The virtual hard disk.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "writeAcceleratorEnabled": { "description": "WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.", "type": "boolean" } }, "required": [ "createOption" ], "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags: Resource tags", "type": "object" }, "userData": { "description": "UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.\nMinimum api-version: 2021-03-01", "type": "string" }, "virtualMachineScaleSet": { "description": "VirtualMachineScaleSet: Specifies information about the virtual machine scale set that the virtual machine should be\nassigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to\nmaximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM\ncannot be added to a virtual machine scale set.\nThis property cannot exist along with a non-null properties.availabilitySet reference.\nMinimum api\u2010version: 2019\u201003\u201001", "properties": { "reference": { "description": "Reference: Resource Id", "properties": { "armId": { "description": "ARMID is a string of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\nThe /resourcegroups/{resourceGroupName} bit is optional as some resources are scoped at the subscription level\nARMID is mutually exclusive with Group, Kind, Namespace and Name.", "pattern": "(?i)(^(/subscriptions/([^/]+)(/resourcegroups/([^/]+))?)?/providers/([^/]+)/([^/]+/[^/]+)(/([^/]+/[^/]+))*$|^/subscriptions/([^/]+)(/resourcegroups/([^/]+))?$)", "type": "string" }, "group": { "description": "Group is the Kubernetes group of the resource.", "type": "string" }, "kind": { "description": "Kind is the Kubernetes kind of the resource.", "type": "string" }, "name": { "description": "Name is the Kubernetes name of the resource.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "zones": { "description": "Zones: The virtual machine zones.", "items": { "type": "string" }, "type": "array" } }, "required": [ "location", "owner" ], "type": "object", "additionalProperties": false }, "status": { "description": "Describes a Virtual Machine.", "properties": { "additionalCapabilities": { "description": "AdditionalCapabilities: Specifies additional capabilities enabled or disabled on the virtual machine.", "properties": { "hibernationEnabled": { "description": "HibernationEnabled: The flag that enables or disables hibernation capability on the VM.", "type": "boolean" }, "ultraSSDEnabled": { "description": "UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS\nstorage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual\nmachine or virtual machine scale set only if this property is enabled.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "applicationProfile": { "description": "ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS", "properties": { "galleryApplications": { "description": "GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS", "items": { "description": "Specifies the required information to reference a compute gallery application version", "properties": { "configurationReference": { "description": "ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the\npackage if provided", "type": "string" }, "enableAutomaticUpgrade": { "description": "EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be\nautomatically updated for the VM/VMSS", "type": "boolean" }, "order": { "description": "Order: Optional, Specifies the order in which the packages have to be installed", "type": "integer" }, "packageReferenceId": { "description": "PackageReferenceId: Specifies the GalleryApplicationVersion resource id on the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}", "type": "string" }, "tags": { "description": "Tags: Optional, Specifies a passthrough value for more generic context.", "type": "string" }, "treatFailureAsDeploymentFailure": { "description": "TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the\ndeployment", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "availabilitySet": { "description": "AvailabilitySet: Specifies information about the availability set that the virtual machine should be assigned to.\nVirtual machines specified in the same availability set are allocated to different nodes to maximize availability. For\nmore information about availability sets, see [Availability sets\noverview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).\nFor more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in\nAzure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates)\nCurrently, a VM can only be added to availability set at creation time. The availability set to which the VM is being\nadded should be under the same resource group as the availability set resource. An existing VM cannot be added to an\navailability set.\nThis property cannot exist along with a non-null properties.virtualMachineScaleSet reference.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "billingProfile": { "description": "BillingProfile: Specifies the billing related details of a Azure Spot virtual machine.\nMinimum api-version: 2019-03-01.", "properties": { "maxPrice": { "description": "MaxPrice: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.\nThis price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time\nof create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current\nAzure Spot price.\nThe maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the\nmaxPrice after creation of VM/VMSS.\nPossible values are:\n- Any decimal value greater than zero. Example: 0.01538\n-1 \u2013 indicates default price to be up-to on-demand.\nYou can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also,\nthe default max price is -1 if it is not provided by you.\nMinimum api-version: 2019-03-01.", "type": "number" } }, "type": "object", "additionalProperties": false }, "capacityReservation": { "description": "CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine.\nMinimum api-version: 2021-04-01.", "properties": { "capacityReservationGroup": { "description": "CapacityReservationGroup: Specifies the capacity reservation group resource id that should be used for allocating the\nvirtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to\nhttps://aka.ms/CapacityReservation for more details.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "conditions": { "description": "Conditions: The observed state of the resource", "items": { "description": "Condition defines an extension to status (an observation) of a resource", "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the last time the condition transitioned from one status to another.", "format": "date-time", "type": "string" }, "message": { "description": "Message is a human readable message indicating details about the transition. This field may be empty.", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration is the .metadata.generation that the condition was set based upon. For instance, if\n.metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "type": "integer" }, "reason": { "description": "Reason for the condition's last transition.\nReasons are upper CamelCase (PascalCase) with no spaces. A reason is always provided, this field will not be empty.", "type": "string" }, "severity": { "description": "Severity with which to treat failures of this type of condition.\nFor conditions which have positive polarity (Status == True is their normal/healthy state), this will be omitted when Status == True\nFor conditions which have negative polarity (Status == False is their normal/healthy state), this will be omitted when Status == False.\nThis is omitted in all cases when Status == Unknown", "type": "string" }, "status": { "description": "Status of the condition, one of True, False, or Unknown.", "type": "string" }, "type": { "description": "Type of condition.", "type": "string" } }, "required": [ "lastTransitionTime", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array" }, "diagnosticsProfile": { "description": "DiagnosticsProfile: Specifies the boot diagnostic settings state.\nMinimum api-version: 2015-06-15.", "properties": { "bootDiagnostics": { "description": "BootDiagnostics: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to\ndiagnose VM status.\nNOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as\nthe VM.\nYou can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor.", "properties": { "enabled": { "description": "Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.", "type": "boolean" }, "storageUri": { "description": "StorageUri: Uri of the storage account to use for placing the console output and screenshot.\nIf storageUri is not specified while enabling boot diagnostics, managed storage will be used.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "evictionPolicy": { "description": "EvictionPolicy: Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.\nFor Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.\nFor Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is\n2017-10-30-preview.", "type": "string" }, "extendedLocation": { "description": "ExtendedLocation: The extended location of the Virtual Machine.", "properties": { "name": { "description": "Name: The name of the extended location.", "type": "string" }, "type": { "description": "Type: The type of the extended location.", "type": "string" } }, "type": "object", "additionalProperties": false }, "extensionsTimeBudget": { "description": "ExtensionsTimeBudget: Specifies the time alloted for all extensions to start. The time duration should be between 15\nminutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes\n(PT1H30M).\nMinimum api-version: 2020-06-01", "type": "string" }, "hardwareProfile": { "description": "HardwareProfile: Specifies the hardware settings for the virtual machine.", "properties": { "vmSize": { "description": "VmSize: Specifies the size of the virtual machine.\nThe enum data type is currently deprecated and will be removed by December 23rd 2023.\nRecommended way to get the list of available sizes is using these APIs:\n[List all available virtual machine sizes in an availability\nset](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)\n[List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list)\n[List all available virtual machine sizes for\nresizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about\nvirtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).\nThe available VM sizes depend on region and availability set.", "type": "string" }, "vmSizeProperties": { "description": "VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version:\n2021-07-01.\nThis feature is still in preview mode and is not supported for VirtualMachineScaleSet.\nPlease follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details.", "properties": { "vCPUsAvailable": { "description": "VCPUsAvailable: Specifies the number of vCPUs available for the VM.\nWhen this property is not specified in the request body the default behavior is to set it to the value of vCPUs\navailable for that VM size exposed in api response of [List all available virtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) .", "type": "integer" }, "vCPUsPerCore": { "description": "VCPUsPerCore: Specifies the vCPU to physical core ratio.\nWhen this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the\nVM Size exposed in api response of [List all available virtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)\nSetting this property to 1 also means that hyper-threading is disabled.", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "host": { "description": "Host: Specifies information about the dedicated host that the virtual machine resides in.\nMinimum api-version: 2018-10-01.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "hostGroup": { "description": "HostGroup: Specifies information about the dedicated host group that the virtual machine resides in.\nMinimum api-version: 2020-06-01.\nNOTE: User cannot specify both host and hostGroup properties.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "id": { "description": "Id: Resource Id", "type": "string" }, "identity": { "description": "Identity: The identity of the virtual machine, if configured.", "properties": { "principalId": { "description": "PrincipalId: The principal id of virtual machine identity. This property will only be provided for a system assigned\nidentity.", "type": "string" }, "tenantId": { "description": "TenantId: The tenant id associated with the virtual machine. This property will only be provided for a system assigned\nidentity.", "type": "string" }, "type": { "description": "Type: The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an\nimplicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the\nvirtual machine.", "type": "string" }, "userAssignedIdentities": { "additionalProperties": { "properties": { "clientId": { "description": "ClientId: The client id of user assigned identity.", "type": "string" }, "principalId": { "description": "PrincipalId: The principal id of user assigned identity.", "type": "string" } }, "type": "object", "additionalProperties": false }, "description": "UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary\nkey references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", "type": "object" } }, "type": "object", "additionalProperties": false }, "instanceView": { "description": "InstanceView: The virtual machine instance view.", "properties": { "assignedHost": { "description": "AssignedHost: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement,\nwhen the virtual machine is associated with a dedicated host group that has automatic placement enabled.\nMinimum api-version: 2020-06-01.", "type": "string" }, "bootDiagnostics": { "description": "BootDiagnostics: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to\ndiagnose VM status.\nYou can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor.", "properties": { "consoleScreenshotBlobUri": { "description": "ConsoleScreenshotBlobUri: The console screenshot blob URI.\nNOTE: This will not be set if boot diagnostics is currently enabled with managed storage.", "type": "string" }, "serialConsoleLogBlobUri": { "description": "SerialConsoleLogBlobUri: The serial console log blob Uri.\nNOTE: This will not be set if boot diagnostics is currently enabled with managed storage.", "type": "string" }, "status": { "description": "Status: The boot diagnostics status information for the VM.\nNOTE: It will be set only if there are errors encountered in enabling boot diagnostics.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "computerName": { "description": "ComputerName: The computer name assigned to the virtual machine.", "type": "string" }, "disks": { "description": "Disks: The virtual machine disk information.", "items": { "description": "The instance view of the disk.", "properties": { "encryptionSettings": { "description": "EncryptionSettings: Specifies the encryption settings for the OS Disk.\nMinimum api-version: 2015-06-15", "items": { "description": "Describes a Encryption Settings for a Disk", "properties": { "diskEncryptionKey": { "description": "DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.", "properties": { "secretUrl": { "description": "SecretUrl: The URL referencing a secret in a Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the secret.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "enabled": { "description": "Enabled: Specifies whether disk encryption should be enabled on the virtual machine.", "type": "boolean" }, "keyEncryptionKey": { "description": "KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.", "properties": { "keyUrl": { "description": "KeyUrl: The URL referencing a key encryption key in Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the key.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The disk name.", "type": "string" }, "statuses": { "description": "Statuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "extensions": { "description": "Extensions: The extensions information.", "items": { "description": "The instance view of a virtual machine extension.", "properties": { "name": { "description": "Name: The virtual machine extension name.", "type": "string" }, "statuses": { "description": "Statuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "substatuses": { "description": "Substatuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "type": { "description": "Type: Specifies the type of the extension; an example is \"CustomScriptExtension\".", "type": "string" }, "typeHandlerVersion": { "description": "TypeHandlerVersion: Specifies the version of the script handler.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "hyperVGeneration": { "description": "HyperVGeneration: Specifies the HyperVGeneration Type associated with a resource", "type": "string" }, "maintenanceRedeployStatus": { "description": "MaintenanceRedeployStatus: The Maintenance Operation status on the virtual machine.", "properties": { "isCustomerInitiatedMaintenanceAllowed": { "description": "IsCustomerInitiatedMaintenanceAllowed: True, if customer is allowed to perform Maintenance.", "type": "boolean" }, "lastOperationMessage": { "description": "LastOperationMessage: Message returned for the last Maintenance Operation.", "type": "string" }, "lastOperationResultCode": { "description": "LastOperationResultCode: The Last Maintenance Operation Result Code.", "type": "string" }, "maintenanceWindowEndTime": { "description": "MaintenanceWindowEndTime: End Time for the Maintenance Window.", "type": "string" }, "maintenanceWindowStartTime": { "description": "MaintenanceWindowStartTime: Start Time for the Maintenance Window.", "type": "string" }, "preMaintenanceWindowEndTime": { "description": "PreMaintenanceWindowEndTime: End Time for the Pre Maintenance Window.", "type": "string" }, "preMaintenanceWindowStartTime": { "description": "PreMaintenanceWindowStartTime: Start Time for the Pre Maintenance Window.", "type": "string" } }, "type": "object", "additionalProperties": false }, "osName": { "description": "OsName: The Operating System running on the virtual machine.", "type": "string" }, "osVersion": { "description": "OsVersion: The version of Operating System running on the virtual machine.", "type": "string" }, "patchStatus": { "description": "PatchStatus: [Preview Feature] The status of virtual machine patch operations.", "properties": { "availablePatchSummary": { "description": "AvailablePatchSummary: The available patch summary of the latest assessment operation for the virtual machine.", "properties": { "assessmentActivityId": { "description": "AssessmentActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and\nextension logs.", "type": "string" }, "criticalAndSecurityPatchCount": { "description": "CriticalAndSecurityPatchCount: The number of critical or security patches that have been detected as available and not\nyet installed.", "type": "integer" }, "error": { "description": "Error: The errors that were encountered during execution of the operation. The details array contains the list of them.", "properties": { "code": { "description": "Code: The error code.", "type": "string" }, "details": { "description": "Details: The Api error details", "items": { "description": "Api error base.", "properties": { "code": { "description": "Code: The error code.", "type": "string" }, "message": { "description": "Message: The error message.", "type": "string" }, "target": { "description": "Target: The target of the particular error.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "innererror": { "description": "Innererror: The Api inner error", "properties": { "errordetail": { "description": "Errordetail: The internal error message or exception dump.", "type": "string" }, "exceptiontype": { "description": "Exceptiontype: The exception type.", "type": "string" } }, "type": "object", "additionalProperties": false }, "message": { "description": "Message: The error message.", "type": "string" }, "target": { "description": "Target: The target of the particular error.", "type": "string" } }, "type": "object", "additionalProperties": false }, "lastModifiedTime": { "description": "LastModifiedTime: The UTC timestamp when the operation began.", "type": "string" }, "otherPatchCount": { "description": "OtherPatchCount: The number of all available patches excluding critical and security.", "type": "integer" }, "rebootPending": { "description": "RebootPending: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to\ncomplete installation but the reboot has not yet occurred.", "type": "boolean" }, "startTime": { "description": "StartTime: The UTC timestamp when the operation began.", "type": "string" }, "status": { "description": "Status: The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes.\nAt that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", "type": "string" } }, "type": "object", "additionalProperties": false }, "configurationStatuses": { "description": "ConfigurationStatuses: The enablement status of the specified patchMode", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "lastPatchInstallationSummary": { "description": "LastPatchInstallationSummary: The installation summary of the latest installation operation for the virtual machine.", "properties": { "error": { "description": "Error: The errors that were encountered during execution of the operation. The details array contains the list of them.", "properties": { "code": { "description": "Code: The error code.", "type": "string" }, "details": { "description": "Details: The Api error details", "items": { "description": "Api error base.", "properties": { "code": { "description": "Code: The error code.", "type": "string" }, "message": { "description": "Message: The error message.", "type": "string" }, "target": { "description": "Target: The target of the particular error.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "innererror": { "description": "Innererror: The Api inner error", "properties": { "errordetail": { "description": "Errordetail: The internal error message or exception dump.", "type": "string" }, "exceptiontype": { "description": "Exceptiontype: The exception type.", "type": "string" } }, "type": "object", "additionalProperties": false }, "message": { "description": "Message: The error message.", "type": "string" }, "target": { "description": "Target: The target of the particular error.", "type": "string" } }, "type": "object", "additionalProperties": false }, "excludedPatchCount": { "description": "ExcludedPatchCount: The number of all available patches but excluded explicitly by a customer-specified exclusion list\nmatch.", "type": "integer" }, "failedPatchCount": { "description": "FailedPatchCount: The count of patches that failed installation.", "type": "integer" }, "installationActivityId": { "description": "InstallationActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP\nand extension logs.", "type": "string" }, "installedPatchCount": { "description": "InstalledPatchCount: The count of patches that successfully installed.", "type": "integer" }, "lastModifiedTime": { "description": "LastModifiedTime: The UTC timestamp when the operation began.", "type": "string" }, "maintenanceWindowExceeded": { "description": "MaintenanceWindowExceeded: Describes whether the operation ran out of time before it completed all its intended actions", "type": "boolean" }, "notSelectedPatchCount": { "description": "NotSelectedPatchCount: The number of all available patches but not going to be installed because it didn't match a\nclassification or inclusion list entry.", "type": "integer" }, "pendingPatchCount": { "description": "PendingPatchCount: The number of all available patches expected to be installed over the course of the patch\ninstallation operation.", "type": "integer" }, "startTime": { "description": "StartTime: The UTC timestamp when the operation began.", "type": "string" }, "status": { "description": "Status: The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes.\nAt that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "platformFaultDomain": { "description": "PlatformFaultDomain: Specifies the fault domain of the virtual machine.", "type": "integer" }, "platformUpdateDomain": { "description": "PlatformUpdateDomain: Specifies the update domain of the virtual machine.", "type": "integer" }, "rdpThumbPrint": { "description": "RdpThumbPrint: The Remote desktop certificate thumbprint.", "type": "string" }, "statuses": { "description": "Statuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "vmAgent": { "description": "VmAgent: The VM Agent running on the virtual machine.", "properties": { "extensionHandlers": { "description": "ExtensionHandlers: The virtual machine extension handler instance view.", "items": { "description": "The instance view of a virtual machine extension handler.", "properties": { "status": { "description": "Status: The extension handler status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": { "description": "Type: Specifies the type of the extension; an example is \"CustomScriptExtension\".", "type": "string" }, "typeHandlerVersion": { "description": "TypeHandlerVersion: Specifies the version of the script handler.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "statuses": { "description": "Statuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "vmAgentVersion": { "description": "VmAgentVersion: The VM Agent full version.", "type": "string" } }, "type": "object", "additionalProperties": false }, "vmHealth": { "description": "VmHealth: The health status for the VM.", "properties": { "status": { "description": "Status: The health status information for the VM.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "licenseType": { "description": "LicenseType: Specifies that the image or disk that is being used was licensed on-premises.\nPossible values for Windows Server operating system are:\nWindows_Client\nWindows_Server\nPossible values for Linux Server operating system are:\nRHEL_BYOS (for RHEL)\nSLES_BYOS (for SUSE)\nFor more information, see [Azure Hybrid Use Benefit for Windows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n[Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\nMinimum api-version: 2015-06-15", "type": "string" }, "location": { "description": "Location: Resource location", "type": "string" }, "name": { "description": "Name: Resource name", "type": "string" }, "networkProfile": { "description": "NetworkProfile: Specifies the network interfaces of the virtual machine.", "properties": { "networkApiVersion": { "description": "NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network\nInterface Configurations", "type": "string" }, "networkInterfaceConfigurations": { "description": "NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine\nnetworking resources.", "items": { "description": "Describes a virtual machine network interface configurations.", "properties": { "deleteOption": { "description": "DeleteOption: Specify what happens to the network interface when the VM is deleted", "type": "string" }, "dnsSettings": { "description": "DnsSettings: The dns settings to be applied on the network interfaces.", "properties": { "dnsServers": { "description": "DnsServers: List of DNS servers IP addresses", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "dscpConfiguration": { "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "enableAcceleratedNetworking": { "description": "EnableAcceleratedNetworking: Specifies whether the network interface is accelerated networking-enabled.", "type": "boolean" }, "enableFpga": { "description": "EnableFpga: Specifies whether the network interface is FPGA networking-enabled.", "type": "boolean" }, "enableIPForwarding": { "description": "EnableIPForwarding: Whether IP forwarding enabled on this NIC.", "type": "boolean" }, "ipConfigurations": { "description": "IpConfigurations: Specifies the IP configurations of the network interface.", "items": { "description": "Describes a virtual machine network profile's IP configuration.", "properties": { "applicationGatewayBackendAddressPools": { "description": "ApplicationGatewayBackendAddressPools: Specifies an array of references to backend address pools of application\ngateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual\nmachines cannot use the same application gateway.", "items": { "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "applicationSecurityGroups": { "description": "ApplicationSecurityGroups: Specifies an array of references to application security group.", "items": { "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "loadBalancerBackendAddressPools": { "description": "LoadBalancerBackendAddressPools: Specifies an array of references to backend address pools of load balancers. A virtual\nmachine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines\ncannot use the same basic sku load balancer].", "items": { "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The IP configuration name.", "type": "string" }, "primary": { "description": "Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.", "type": "boolean" }, "privateIPAddressVersion": { "description": "PrivateIPAddressVersion: Available from Api-Version 2017-03-30 onwards, it represents whether the specific\nipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "type": "string" }, "publicIPAddressConfiguration": { "description": "PublicIPAddressConfiguration: The publicIPAddressConfiguration.", "properties": { "deleteOption": { "description": "DeleteOption: Specify what happens to the public IP address when the VM is deleted", "type": "string" }, "dnsSettings": { "description": "DnsSettings: The dns settings to be applied on the publicIP addresses .", "properties": { "domainNameLabel": { "description": "DomainNameLabel: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name\nlabel is the concatenation of the domain name label and vm network profile unique ID.", "type": "string" } }, "type": "object", "additionalProperties": false }, "idleTimeoutInMinutes": { "description": "IdleTimeoutInMinutes: The idle timeout of the public IP address.", "type": "integer" }, "ipTags": { "description": "IpTags: The list of IP tags associated with the public IP address.", "items": { "description": "Contains the IP tag associated with the public IP address.", "properties": { "ipTagType": { "description": "IpTagType: IP tag type. Example: FirstPartyUsage.", "type": "string" }, "tag": { "description": "Tag: IP tag associated with the public IP. Example: SQL, Storage etc.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The publicIP address configuration name.", "type": "string" }, "publicIPAddressVersion": { "description": "PublicIPAddressVersion: Available from Api-Version 2019-07-01 onwards, it represents whether the specific\nipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "type": "string" }, "publicIPAllocationMethod": { "description": "PublicIPAllocationMethod: Specify the public IP allocation type", "type": "string" }, "publicIPPrefix": { "description": "PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "sku": { "description": "Sku: Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.", "properties": { "name": { "description": "Name: Specify public IP sku name", "type": "string" }, "tier": { "description": "Tier: Specify public IP sku tier", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "subnet": { "description": "Subnet: Specifies the identifier of the subnet.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "Name: The network interface configuration name.", "type": "string" }, "networkSecurityGroup": { "description": "NetworkSecurityGroup: The network security group.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "primary": { "description": "Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "networkInterfaces": { "description": "NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.", "items": { "description": "Describes a network interface reference.", "properties": { "deleteOption": { "description": "DeleteOption: Specify what happens to the network interface when the VM is deleted", "type": "string" }, "id": { "description": "Id: Resource Id", "type": "string" }, "primary": { "description": "Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "osProfile": { "description": "OsProfile: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot\nbe changed once VM is provisioned.", "properties": { "adminUsername": { "description": "AdminUsername: Specifies the name of the administrator account.\nThis property cannot be updated after the VM is created.\nWindows-only restriction: Cannot end in \".\"\nDisallowed values: \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\",\n\"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\",\n\"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".\nMinimum-length (Linux): 1 character\nMax-length (Linux): 64 characters\nMax-length (Windows): 20 characters.", "type": "string" }, "allowExtensionOperations": { "description": "AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine.\nThis may only be set to False when no extensions are present on the virtual machine.", "type": "boolean" }, "computerName": { "description": "ComputerName: Specifies the host OS name of the virtual machine.\nThis name cannot be updated after the VM is created.\nMax-length (Windows): 15 characters\nMax-length (Linux): 64 characters.\nFor naming conventions and restrictions see [Azure infrastructure services implementation\nguidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules).", "type": "string" }, "customData": { "description": "CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array\nthat is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.\nNote: Do not pass any secrets or passwords in customData property\nThis property cannot be updated after the VM is created.\ncustomData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure\nVMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)\nFor using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)", "type": "string" }, "linuxConfiguration": { "description": "LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine.\nFor a list of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", "properties": { "disablePasswordAuthentication": { "description": "DisablePasswordAuthentication: Specifies whether password authentication should be disabled.", "type": "boolean" }, "patchSettings": { "description": "PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Linux.", "properties": { "assessmentMode": { "description": "AssessmentMode: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.\nPossible values are:\nImageDefault - You control the timing of patch assessments on a virtual machine.\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.", "type": "string" }, "automaticByPlatformSettings": { "description": "AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on\nLinux.", "properties": { "rebootSetting": { "description": "RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", "type": "string" } }, "type": "object", "additionalProperties": false }, "patchMode": { "description": "PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual\nmachine scale set with OrchestrationMode as Flexible.\nPossible values are:\nImageDefault - The virtual machine's default patching configuration is used.\nAutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent\nmust be true", "type": "string" } }, "type": "object", "additionalProperties": false }, "provisionVMAgent": { "description": "ProvisionVMAgent: Indicates whether virtual machine agent should be provisioned on the virtual machine.\nWhen this property is not specified in the request body, default behavior is to set it to true. This will ensure that\nVM Agent is installed on the VM so that extensions can be added to the VM later.", "type": "boolean" }, "ssh": { "description": "Ssh: Specifies the ssh key configuration for a Linux OS.", "properties": { "publicKeys": { "description": "PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.", "items": { "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.", "properties": { "keyData": { "description": "KeyData: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit\nand in ssh-rsa format.\nFor creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).", "type": "string" }, "path": { "description": "Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the\nspecified key is appended to the file. Example: /home/user/.ssh/authorized_keys", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "requireGuestProvisionSignal": { "description": "RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.", "type": "boolean" }, "secrets": { "description": "Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a\nvirtual machine it is recommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual\nmachine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "items": { "description": "Describes a set of certificates which are all in the same Key Vault.", "properties": { "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "vaultCertificates": { "description": "VaultCertificates: The list of key vault references in SourceVault which contain certificates.", "items": { "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.", "properties": { "certificateStore": { "description": "CertificateStore: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate\nshould be added. The specified certificate store is implicitly in the LocalMachine account.\nFor Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name\n<UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both\nof these files are .pem formatted.", "type": "string" }, "certificateUrl": { "description": "CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to\nthe Key Vault, see [Add a key or secret to the key\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to\nbe It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:\n{\n\"data\":\"\",\n\"dataType\":\"pfx\",\n\"password\":\"\"\n}\nTo install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual\nmachine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "windowsConfiguration": { "description": "WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.", "properties": { "additionalUnattendContent": { "description": "AdditionalUnattendContent: Specifies additional base-64 encoded XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup.", "items": { "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows\nSetup. Contents are defined by setting name, component name, and the pass in which the content is applied.", "properties": { "componentName": { "description": "ComponentName: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", "type": "string" }, "content": { "description": "Content: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and\ncomponent. The XML must be less than 4KB and must include the root element for the setting or feature that is being\ninserted.", "type": "string" }, "passName": { "description": "PassName: The pass name. Currently, the only allowable value is OobeSystem.", "type": "string" }, "settingName": { "description": "SettingName: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and\nAutoLogon.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "enableAutomaticUpdates": { "description": "EnableAutomaticUpdates: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is\ntrue.\nFor virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.", "type": "boolean" }, "patchSettings": { "description": "PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Windows.", "properties": { "assessmentMode": { "description": "AssessmentMode: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.\nPossible values are:\nImageDefault - You control the timing of patch assessments on a virtual machine.\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.", "type": "string" }, "automaticByPlatformSettings": { "description": "AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on\nWindows.", "properties": { "rebootSetting": { "description": "RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", "type": "string" } }, "type": "object", "additionalProperties": false }, "enableHotpatching": { "description": "EnableHotpatching: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the\n'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.", "type": "boolean" }, "patchMode": { "description": "PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual\nmachine scale set with OrchestrationMode as Flexible.\nPossible values are:\nManual - You control the application of patches to a virtual machine. You do this by applying patches manually inside\nthe VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be\nfalse\nAutomaticByOS - The virtual machine will automatically be updated by the OS. The property\nWindowsConfiguration.enableAutomaticUpdates must be true.\nAutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent\nand WindowsConfiguration.enableAutomaticUpdates must be true", "type": "string" } }, "type": "object", "additionalProperties": false }, "provisionVMAgent": { "description": "ProvisionVMAgent: Indicates whether virtual machine agent should be provisioned on the virtual machine.\nWhen this property is not specified in the request body, default behavior is to set it to true. This will ensure that\nVM Agent is installed on the VM so that extensions can be added to the VM later.", "type": "boolean" }, "timeZone": { "description": "TimeZone: Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time\nzones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones).", "type": "string" }, "winRM": { "description": "WinRM: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.", "properties": { "listeners": { "description": "Listeners: The list of Windows Remote Management listeners", "items": { "description": "Describes Protocol and thumbprint of Windows Remote Management listener", "properties": { "certificateUrl": { "description": "CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to\nthe Key Vault, see [Add a key or secret to the key\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to\nbe It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:\n{\n\"data\":\"\",\n\"dataType\":\"pfx\",\n\"password\":\"\"\n}\nTo install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual\nmachine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", "type": "string" }, "protocol": { "description": "Protocol: Specifies the protocol of WinRM listener.\nPossible values are:\nhttp\nhttps", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "plan": { "description": "Plan: Specifies information about the marketplace image used to create the virtual machine. This element is only used\nfor marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic\nuse. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy\nprogrammatically, Get Started ->. Enter any required information and then click Save.", "properties": { "name": { "description": "Name: The plan ID.", "type": "string" }, "product": { "description": "Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the\nimageReference element.", "type": "string" }, "promotionCode": { "description": "PromotionCode: The promotion code.", "type": "string" }, "publisher": { "description": "Publisher: The publisher ID.", "type": "string" } }, "type": "object", "additionalProperties": false }, "platformFaultDomain": { "description": "PlatformFaultDomain: Specifies the scale set logical fault domain into which the Virtual Machine will be created. By\ndefault, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across\navailable fault domains.\n
  • This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.
  • The Virtual\nMachine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.
  • This property cannot be updated\nonce the Virtual Machine is created.
  • Fault domain assignment can be viewed in the Virtual Machine Instance View.\nMinimum api\u2010version: 2020\u201012\u201001", "type": "integer" }, "priority": { "description": "Priority: Specifies the priority for the virtual machine.\nMinimum api-version: 2019-03-01", "type": "string" }, "provisioningState": { "description": "ProvisioningState: The provisioning state, which only appears in the response.", "type": "string" }, "proximityPlacementGroup": { "description": "ProximityPlacementGroup: Specifies information about the proximity placement group that the virtual machine should be\nassigned to.\nMinimum api-version: 2018-04-01.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "resources": { "description": "Resources: The virtual machine child extension resources.", "items": { "description": "Describes a Virtual Machine Extension.", "properties": { "autoUpgradeMinorVersion": { "description": "AutoUpgradeMinorVersion: Indicates whether the extension should use a newer minor version if one is available at\ndeployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this\nproperty set to true.", "type": "boolean" }, "enableAutomaticUpgrade": { "description": "EnableAutomaticUpgrade: Indicates whether the extension should be automatically upgraded by the platform if there is a\nnewer version of the extension available.", "type": "boolean" }, "forceUpdateTag": { "description": "ForceUpdateTag: How the extension handler should be forced to update even if the extension configuration has not changed.", "type": "string" }, "id": { "description": "Id: Resource Id", "type": "string" }, "instanceView": { "description": "InstanceView: The virtual machine extension instance view.", "properties": { "name": { "description": "Name: The virtual machine extension name.", "type": "string" }, "statuses": { "description": "Statuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "substatuses": { "description": "Substatuses: The resource status information.", "items": { "description": "Instance view status.", "properties": { "code": { "description": "Code: The status code.", "type": "string" }, "displayStatus": { "description": "DisplayStatus: The short localizable label for the status.", "type": "string" }, "level": { "description": "Level: The level code.", "type": "string" }, "message": { "description": "Message: The detailed status message, including for alerts and error messages.", "type": "string" }, "time": { "description": "Time: The time of the status.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "type": { "description": "Type: Specifies the type of the extension; an example is \"CustomScriptExtension\".", "type": "string" }, "typeHandlerVersion": { "description": "TypeHandlerVersion: Specifies the version of the script handler.", "type": "string" } }, "type": "object", "additionalProperties": false }, "location": { "description": "Location: Resource location", "type": "string" }, "name": { "description": "Name: Resource name", "type": "string" }, "properties_type": { "description": "PropertiesType: Specifies the type of the extension; an example is \"CustomScriptExtension\".", "type": "string" }, "protectedSettingsFromKeyVault": { "description": "ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key\nvault", "properties": { "secretUrl": { "description": "SecretUrl: The URL referencing a secret in a Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the secret.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "provisioningState": { "description": "ProvisioningState: The provisioning state, which only appears in the response.", "type": "string" }, "publisher": { "description": "Publisher: The name of the extension handler publisher.", "type": "string" }, "settings": { "additionalProperties": { "x-kubernetes-preserve-unknown-fields": true }, "description": "Settings: Json formatted public settings for the extension.", "type": "object" }, "suppressFailures": { "description": "SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such\nas not connecting to the VM will not be suppressed regardless of this value). The default is false.", "type": "boolean" }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags: Resource tags", "type": "object" }, "type": { "description": "Type: Resource type", "type": "string" }, "typeHandlerVersion": { "description": "TypeHandlerVersion: Specifies the version of the script handler.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "scheduledEventsProfile": { "description": "ScheduledEventsProfile: Specifies Scheduled Event related configurations.", "properties": { "terminateNotificationProfile": { "description": "TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.", "properties": { "enable": { "description": "Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.", "type": "boolean" }, "notBeforeTimeout": { "description": "NotBeforeTimeout: Configurable length of time a Virtual Machine being deleted will have to potentially approve the\nTerminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601\nformat, the default value is 5 minutes (PT5M)", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "securityProfile": { "description": "SecurityProfile: Specifies the Security related profile settings for the virtual machine.", "properties": { "encryptionAtHost": { "description": "EncryptionAtHost: This property can be used by user in the request to enable or disable the Host Encryption for the\nvirtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp\ndisk at host itself.\nDefault: The Encryption at host will be disabled unless this property is set to true for the resource.", "type": "boolean" }, "securityType": { "description": "SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable\nUefiSettings.\nDefault: UefiSettings will not be enabled unless this property is set.", "type": "string" }, "uefiSettings": { "description": "UefiSettings: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.\nMinimum api-version: 2020-12-01", "properties": { "secureBootEnabled": { "description": "SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine.\nMinimum api-version: 2020-12-01", "type": "boolean" }, "vTpmEnabled": { "description": "VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine.\nMinimum api-version: 2020-12-01", "type": "boolean" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "storageProfile": { "description": "StorageProfile: Specifies the storage settings for the virtual machine disks.", "properties": { "dataDisks": { "description": "DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine.\nFor more information about disks, see [About disks and VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", "items": { "description": "Describes a data disk.", "properties": { "caching": { "description": "Caching: Specifies the caching requirements.\nPossible values are:\nNone\nReadOnly\nReadWrite\nDefault: None for Standard storage. ReadOnly for Premium storage", "type": "string" }, "createOption": { "description": "CreateOption: Specifies how the virtual machine should be created.\nPossible values are:\nAttach \\u2013 This value is used when you are using a specialized disk to create the virtual machine.\nFromImage \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a\nplatform image, you also use the imageReference element described above. If you are using a marketplace image, you also\nuse the plan element previously described.", "type": "string" }, "deleteOption": { "description": "DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion.\nPossible values:\nDelete If this value is used, the data disk is deleted when VM is deleted.\nDetach If this value is used, the data disk is retained after VM is deleted.\nThe default value is set to detach", "type": "string" }, "detachOption": { "description": "DetachOption: Specifies the detach behavior to be used while detaching a disk or which is already in the process of\ndetachment from the virtual machine. Supported values: ForceDetach.\ndetachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk\ndid not complete due to an unexpected failure from the virtual machine and the disk is still not released then use\nforce-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed\nwhen using this detach behavior.\nThis feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk\nupdate toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.", "type": "string" }, "diskIOPSReadWrite": { "description": "DiskIOPSReadWrite: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned\nonly for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.", "type": "integer" }, "diskMBpsReadWrite": { "description": "DiskMBpsReadWrite: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is\nUltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine\nScale Set.", "type": "integer" }, "diskSizeGB": { "description": "DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the\ndisk in a virtual machine image.\nThis value cannot be larger than 1023 GB", "type": "integer" }, "image": { "description": "Image: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the\nvirtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "lun": { "description": "Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and\ntherefore must be unique for each data disk attached to a VM.", "type": "integer" }, "managedDisk": { "description": "ManagedDisk: The managed disk parameters.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "id": { "description": "Id: Resource Id", "type": "string" }, "securityProfile": { "description": "SecurityProfile: Specifies the security profile for the managed disk.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for\nCustomer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "securityEncryptionType": { "description": "SecurityEncryptionType: Specifies the EncryptionType of the managed disk.\nIt is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly\nfor encryption of just the VMGuestState blob.\nNOTE: It can be set for only Confidential VMs.", "type": "string" } }, "type": "object", "additionalProperties": false }, "storageAccountType": { "description": "StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with\ndata disks, it cannot be used with OS Disk.", "type": "string" } }, "type": "object", "additionalProperties": false }, "name": { "description": "Name: The disk name.", "type": "string" }, "toBeDetached": { "description": "ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset", "type": "boolean" }, "vhd": { "description": "Vhd: The virtual hard disk.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "writeAcceleratorEnabled": { "description": "WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "imageReference": { "description": "ImageReference: Specifies information about the image to use. You can specify information about platform images,\nmarketplace images, or virtual machine images. This element is required when you want to use a platform image,\nmarketplace image, or virtual machine image, but is not used in other creation operations.", "properties": { "communityGalleryImageId": { "description": "CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from\ncommunity gallery image GET call.", "type": "string" }, "exactVersion": { "description": "ExactVersion: Specifies in decimal numbers, the version of platform image or marketplace image used to create the\nvirtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.", "type": "string" }, "id": { "description": "Id: Resource Id", "type": "string" }, "offer": { "description": "Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.", "type": "string" }, "publisher": { "description": "Publisher: The image publisher.", "type": "string" }, "sharedGalleryImageId": { "description": "SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared\ngallery image GET call.", "type": "string" }, "sku": { "description": "Sku: The image SKU.", "type": "string" }, "version": { "description": "Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The\nallowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use\nthe latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically\nupdate after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image\ndeployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just\nset\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\nin the 'id' field without version input.", "type": "string" } }, "type": "object", "additionalProperties": false }, "osDisk": { "description": "OsDisk: Specifies information about the operating system disk used by the virtual machine.\nFor more information about disks, see [About disks and VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", "properties": { "caching": { "description": "Caching: Specifies the caching requirements.\nPossible values are:\nNone\nReadOnly\nReadWrite\nDefault: None for Standard storage. ReadOnly for Premium storage.", "type": "string" }, "createOption": { "description": "CreateOption: Specifies how the virtual machine should be created.\nPossible values are:\nAttach \\u2013 This value is used when you are using a specialized disk to create the virtual machine.\nFromImage \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a\nplatform image, you also use the imageReference element described above. If you are using a marketplace image, you also\nuse the plan element previously described.", "type": "string" }, "deleteOption": { "description": "DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion.\nPossible values:\nDelete If this value is used, the OS disk is deleted when VM is deleted.\nDetach If this value is used, the os disk is retained after VM is deleted.\nThe default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the\ndelete option for ephemeral OS Disk.", "type": "string" }, "diffDiskSettings": { "description": "DiffDiskSettings: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "properties": { "option": { "description": "Option: Specifies the ephemeral disk settings for operating system disk.", "type": "string" }, "placement": { "description": "Placement: Specifies the ephemeral disk placement for operating system disk.\nPossible values are:\nCacheDisk\nResourceDisk\nDefault: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used.\nRefer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and\nLinux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.", "type": "string" } }, "type": "object", "additionalProperties": false }, "diskSizeGB": { "description": "DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the\ndisk in a virtual machine image.\nThis value cannot be larger than 1023 GB", "type": "integer" }, "encryptionSettings": { "description": "EncryptionSettings: Specifies the encryption settings for the OS Disk.\nMinimum api-version: 2015-06-15", "properties": { "diskEncryptionKey": { "description": "DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.", "properties": { "secretUrl": { "description": "SecretUrl: The URL referencing a secret in a Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the secret.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "enabled": { "description": "Enabled: Specifies whether disk encryption should be enabled on the virtual machine.", "type": "boolean" }, "keyEncryptionKey": { "description": "KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.", "properties": { "keyUrl": { "description": "KeyUrl: The URL referencing a key encryption key in Key Vault.", "type": "string" }, "sourceVault": { "description": "SourceVault: The relative URL of the Key Vault containing the key.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "image": { "description": "Image: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the\nvirtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "managedDisk": { "description": "ManagedDisk: The managed disk parameters.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "id": { "description": "Id: Resource Id", "type": "string" }, "securityProfile": { "description": "SecurityProfile: Specifies the security profile for the managed disk.", "properties": { "diskEncryptionSet": { "description": "DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for\nCustomer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "securityEncryptionType": { "description": "SecurityEncryptionType: Specifies the EncryptionType of the managed disk.\nIt is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly\nfor encryption of just the VMGuestState blob.\nNOTE: It can be set for only Confidential VMs.", "type": "string" } }, "type": "object", "additionalProperties": false }, "storageAccountType": { "description": "StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with\ndata disks, it cannot be used with OS Disk.", "type": "string" } }, "type": "object", "additionalProperties": false }, "name": { "description": "Name: The disk name.", "type": "string" }, "osType": { "description": "OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from\nuser-image or a specialized VHD.\nPossible values are:\nWindows\nLinux", "type": "string" }, "vhd": { "description": "Vhd: The virtual hard disk.", "properties": { "uri": { "description": "Uri: Specifies the virtual hard disk's uri.", "type": "string" } }, "type": "object", "additionalProperties": false }, "writeAcceleratorEnabled": { "description": "WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.", "type": "boolean" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "tags": { "additionalProperties": { "type": "string" }, "description": "Tags: Resource tags", "type": "object" }, "timeCreated": { "description": "TimeCreated: Specifies the time at which the Virtual Machine resource was created.\nMinimum api-version: 2022-03-01.", "type": "string" }, "type": { "description": "Type: Resource type", "type": "string" }, "userData": { "description": "UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.\nMinimum api-version: 2021-03-01", "type": "string" }, "virtualMachineScaleSet": { "description": "VirtualMachineScaleSet: Specifies information about the virtual machine scale set that the virtual machine should be\nassigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to\nmaximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM\ncannot be added to a virtual machine scale set.\nThis property cannot exist along with a non-null properties.availabilitySet reference.\nMinimum api\u2010version: 2019\u201003\u201001", "properties": { "id": { "description": "Id: Resource Id", "type": "string" } }, "type": "object", "additionalProperties": false }, "vmId": { "description": "VmId: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS\nand can be read using platform BIOS commands.", "type": "string" }, "zones": { "description": "Zones: The virtual machine zones.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false } }, "type": "object" }