compute.azure.com/v1api20220301

APIVersion

Value	Description
“2022-03-01”

Image

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-03-01/image.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}

Used by: ImageList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		Image_Spec Optional
status		Image_STATUS Optional

Image_Spec

Property	Description	Type
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
extendedLocation	The extended location of the Image.	ExtendedLocation Optional
hyperVGeneration	Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.	HyperVGenerationType Optional
location	Resource location	string Required
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	ImageOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
sourceVirtualMachine	The source virtual machine from which Image is created.	SubResource Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	ImageStorageProfile Optional
tags	Resource tags	map[string]string Optional

Image_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
extendedLocation	The extended location of the Image.	ExtendedLocation_STATUS Optional
hyperVGeneration	Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.	HyperVGenerationType_STATUS Optional
id	Resource Id	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
provisioningState	The provisioning state.	string Optional
sourceVirtualMachine	The source virtual machine from which Image is created.	SubResource_STATUS Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	ImageStorageProfile_STATUS Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional

ImageList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		Image[] Optional

VirtualMachine

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-03-01/virtualMachine.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}

Used by: VirtualMachineList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		VirtualMachine_Spec Optional
status		VirtualMachine_STATUS Optional

VirtualMachine_Spec

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the virtual machine.	AdditionalCapabilities Optional
applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS	ApplicationProfile Optional
availabilitySet	Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.	SubResource Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
billingProfile	Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.	BillingProfile Optional
capacityReservation	Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.	CapacityReservationProfile Optional
diagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.	DiagnosticsProfile Optional
evictionPolicy	Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2017-10-30-preview.	EvictionPolicy Optional
extendedLocation	The extended location of the Virtual Machine.	ExtendedLocation Optional
extensionsTimeBudget	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01	string Optional
hardwareProfile	Specifies the hardware settings for the virtual machine.	HardwareProfile Optional
host	Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.	SubResource Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine resides in. Minimum api-version: 2020-06-01. NOTE: User cannot specify both host and hostGroup properties.	SubResource Optional
identity	The identity of the virtual machine, if configured.	VirtualMachineIdentity Optional
licenseType	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15	string Optional
location	Resource location	string Required
networkProfile	Specifies the network interfaces of the virtual machine.	NetworkProfile Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachineOperatorSpec Optional
osProfile	Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.	OSProfile Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan Optional
platformFaultDomain	Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the ‘virtualMachineScaleSet’ property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have ‘platformFaultDomainCount’ > 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01	int Optional
priority	Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01	Priority Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.	SubResource Optional
scheduledEventsProfile	Specifies Scheduled Event related configurations.	ScheduledEventsProfile Optional
securityProfile	Specifies the Security related profile settings for the virtual machine.	SecurityProfile Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	StorageProfile Optional
tags	Resource tags	map[string]string Optional
userData	UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01	string Optional
virtualMachineScaleSet	Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01	SubResource Optional
zones	The virtual machine zones.	string[] Optional

VirtualMachine_STATUS

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the virtual machine.	AdditionalCapabilities_STATUS Optional
applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS	ApplicationProfile_STATUS Optional
availabilitySet	Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.	SubResource_STATUS Optional
billingProfile	Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.	BillingProfile_STATUS Optional
capacityReservation	Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.	CapacityReservationProfile_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
diagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.	DiagnosticsProfile_STATUS Optional
evictionPolicy	Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2017-10-30-preview.	EvictionPolicy_STATUS Optional
extendedLocation	The extended location of the Virtual Machine.	ExtendedLocation_STATUS Optional
extensionsTimeBudget	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01	string Optional
hardwareProfile	Specifies the hardware settings for the virtual machine.	HardwareProfile_STATUS Optional
host	Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.	SubResource_STATUS Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine resides in. Minimum api-version: 2020-06-01. NOTE: User cannot specify both host and hostGroup properties.	SubResource_STATUS Optional
id	Resource Id	string Optional
identity	The identity of the virtual machine, if configured.	VirtualMachineIdentity_STATUS Optional
instanceView	The virtual machine instance view.	VirtualMachineInstanceView_STATUS Optional
licenseType	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
networkProfile	Specifies the network interfaces of the virtual machine.	NetworkProfile_STATUS Optional
osProfile	Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.	OSProfile_STATUS Optional
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan_STATUS Optional
platformFaultDomain	Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the ‘virtualMachineScaleSet’ property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have ‘platformFaultDomainCount’ > 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01	int Optional
priority	Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01	Priority_STATUS Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.	SubResource_STATUS Optional
resources	The virtual machine child extension resources.	VirtualMachineExtension_STATUS[] Optional
scheduledEventsProfile	Specifies Scheduled Event related configurations.	ScheduledEventsProfile_STATUS Optional
securityProfile	Specifies the Security related profile settings for the virtual machine.	SecurityProfile_STATUS Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	StorageProfile_STATUS Optional
tags	Resource tags	map[string]string Optional
timeCreated	Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2022-03-01.	string Optional
type	Resource type	string Optional
userData	UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01	string Optional
virtualMachineScaleSet	Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01	SubResource_STATUS Optional
vmId	Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.	string Optional
zones	The virtual machine zones.	string[] Optional

VirtualMachineList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		VirtualMachine[] Optional

VirtualMachineScaleSet

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-03-01/virtualMachineScaleSet.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}

Used by: VirtualMachineScaleSetList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		VirtualMachineScaleSet_Spec Optional
status		VirtualMachineScaleSet_STATUS Optional

VirtualMachineScaleSet_Spec

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.	AdditionalCapabilities Optional
automaticRepairsPolicy	Policy for automatic repairs.	AutomaticRepairsPolicy Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
doNotRunExtensionsOnOverprovisionedVMs	When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.	bool Optional
extendedLocation	The extended location of the Virtual Machine Scale Set.	ExtendedLocation Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.	SubResource Optional
identity	The identity of the virtual machine scale set, if configured.	VirtualMachineScaleSetIdentity Optional
location	Resource location	string Required
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachineScaleSetOperatorSpec Optional
orchestrationMode	Specifies the orchestration mode for the virtual machine scale set.	OrchestrationMode Optional
overprovision	Specifies whether the Virtual Machine Scale Set should be overprovisioned.	bool Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan Optional
platformFaultDomainCount	Fault Domain count for each placement group.	int Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.	SubResource Optional
scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.	ScaleInPolicy Optional
singlePlacementGroup	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.	bool Optional
sku	The virtual machine scale set sku.	Sku Optional
spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.	SpotRestorePolicy Optional
tags	Resource tags	map[string]string Optional
upgradePolicy	The upgrade policy.	UpgradePolicy Optional
virtualMachineProfile	The virtual machine profile.	VirtualMachineScaleSetVMProfile Optional
zoneBalance	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.	bool Optional
zones	The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set	string[] Optional

VirtualMachineScaleSet_STATUS

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.	AdditionalCapabilities_STATUS Optional
automaticRepairsPolicy	Policy for automatic repairs.	AutomaticRepairsPolicy_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
doNotRunExtensionsOnOverprovisionedVMs	When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.	bool Optional
extendedLocation	The extended location of the Virtual Machine Scale Set.	ExtendedLocation_STATUS Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.	SubResource_STATUS Optional
id	Resource Id	string Optional
identity	The identity of the virtual machine scale set, if configured.	VirtualMachineScaleSetIdentity_STATUS Optional
location	Resource location	string Optional
name	Resource name	string Optional
orchestrationMode	Specifies the orchestration mode for the virtual machine scale set.	OrchestrationMode_STATUS Optional
overprovision	Specifies whether the Virtual Machine Scale Set should be overprovisioned.	bool Optional
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan_STATUS Optional
platformFaultDomainCount	Fault Domain count for each placement group.	int Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.	SubResource_STATUS Optional
scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.	ScaleInPolicy_STATUS Optional
singlePlacementGroup	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.	bool Optional
sku	The virtual machine scale set sku.	Sku_STATUS Optional
spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.	SpotRestorePolicy_STATUS Optional
tags	Resource tags	map[string]string Optional
timeCreated	Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2022-03-01.	string Optional
type	Resource type	string Optional
uniqueId	Specifies the ID which uniquely identifies a Virtual Machine Scale Set.	string Optional
upgradePolicy	The upgrade policy.	UpgradePolicy_STATUS Optional
virtualMachineProfile	The virtual machine profile.	VirtualMachineScaleSetVMProfile_STATUS Optional
zoneBalance	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.	bool Optional
zones	The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set	string[] Optional

VirtualMachineScaleSetList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		VirtualMachineScaleSet[] Optional

VirtualMachineScaleSetsExtension

Used by: VirtualMachineScaleSetsExtensionList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		VirtualMachineScaleSetsExtension_Spec Optional
status		VirtualMachineScaleSetsExtension_STATUS Optional

VirtualMachineScaleSetsExtension_Spec

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachineScaleSetsExtensionOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a compute.azure.com/VirtualMachineScaleSet resource	genruntime.KnownResourceReference Required
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.	genruntime.SecretMapReference Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference Optional
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[] Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineScaleSetsExtension_STATUS

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.	string Optional
id	Resource Id	string Optional
name	The name of the extension.	string Optional
properties_type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference_STATUS Optional
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[] Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
type	Resource type	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineScaleSetsExtensionList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		VirtualMachineScaleSetsExtension[] Optional

VirtualMachinesExtension

Used by: VirtualMachinesExtensionList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		VirtualMachinesExtension_Spec Optional
status		VirtualMachinesExtension_STATUS Optional

VirtualMachinesExtension_Spec

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.	string Optional
instanceView	The virtual machine extension instance view.	VirtualMachineExtensionInstanceView Optional
location	Resource location	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachinesExtensionOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a compute.azure.com/VirtualMachine resource	genruntime.KnownResourceReference Required
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.	genruntime.SecretMapReference Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
tags	Resource tags	map[string]string Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachinesExtension_STATUS

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.	string Optional
id	Resource Id	string Optional
instanceView	The virtual machine extension instance view.	VirtualMachineExtensionInstanceView_STATUS Optional
location	Resource location	string Optional
name	Resource name	string Optional
properties_type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference_STATUS Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachinesExtensionList

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		VirtualMachinesExtension[] Optional

Image_Spec

Used by: Image.

Property	Description	Type
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
extendedLocation	The extended location of the Image.	ExtendedLocation Optional
hyperVGeneration	Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.	HyperVGenerationType Optional
location	Resource location	string Required
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	ImageOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
sourceVirtualMachine	The source virtual machine from which Image is created.	SubResource Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	ImageStorageProfile Optional
tags	Resource tags	map[string]string Optional

Image_STATUS

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Used by: Image.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
extendedLocation	The extended location of the Image.	ExtendedLocation_STATUS Optional
hyperVGeneration	Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.	HyperVGenerationType_STATUS Optional
id	Resource Id	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
provisioningState	The provisioning state.	string Optional
sourceVirtualMachine	The source virtual machine from which Image is created.	SubResource_STATUS Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	ImageStorageProfile_STATUS Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional

VirtualMachine_Spec

Used by: VirtualMachine.

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the virtual machine.	AdditionalCapabilities Optional
applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS	ApplicationProfile Optional
availabilitySet	Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.	SubResource Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
billingProfile	Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.	BillingProfile Optional
capacityReservation	Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.	CapacityReservationProfile Optional
diagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.	DiagnosticsProfile Optional
evictionPolicy	Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2017-10-30-preview.	EvictionPolicy Optional
extendedLocation	The extended location of the Virtual Machine.	ExtendedLocation Optional
extensionsTimeBudget	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01	string Optional
hardwareProfile	Specifies the hardware settings for the virtual machine.	HardwareProfile Optional
host	Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.	SubResource Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine resides in. Minimum api-version: 2020-06-01. NOTE: User cannot specify both host and hostGroup properties.	SubResource Optional
identity	The identity of the virtual machine, if configured.	VirtualMachineIdentity Optional
licenseType	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15	string Optional
location	Resource location	string Required
networkProfile	Specifies the network interfaces of the virtual machine.	NetworkProfile Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachineOperatorSpec Optional
osProfile	Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.	OSProfile Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan Optional
platformFaultDomain	Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the ‘virtualMachineScaleSet’ property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have ‘platformFaultDomainCount’ > 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01	int Optional
priority	Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01	Priority Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.	SubResource Optional
scheduledEventsProfile	Specifies Scheduled Event related configurations.	ScheduledEventsProfile Optional
securityProfile	Specifies the Security related profile settings for the virtual machine.	SecurityProfile Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	StorageProfile Optional
tags	Resource tags	map[string]string Optional
userData	UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01	string Optional
virtualMachineScaleSet	Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01	SubResource Optional
zones	The virtual machine zones.	string[] Optional

VirtualMachine_STATUS

Describes a Virtual Machine.

Used by: VirtualMachine.

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the virtual machine.	AdditionalCapabilities_STATUS Optional
applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS	ApplicationProfile_STATUS Optional
availabilitySet	Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.	SubResource_STATUS Optional
billingProfile	Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.	BillingProfile_STATUS Optional
capacityReservation	Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.	CapacityReservationProfile_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
diagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.	DiagnosticsProfile_STATUS Optional
evictionPolicy	Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2017-10-30-preview.	EvictionPolicy_STATUS Optional
extendedLocation	The extended location of the Virtual Machine.	ExtendedLocation_STATUS Optional
extensionsTimeBudget	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01	string Optional
hardwareProfile	Specifies the hardware settings for the virtual machine.	HardwareProfile_STATUS Optional
host	Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.	SubResource_STATUS Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine resides in. Minimum api-version: 2020-06-01. NOTE: User cannot specify both host and hostGroup properties.	SubResource_STATUS Optional
id	Resource Id	string Optional
identity	The identity of the virtual machine, if configured.	VirtualMachineIdentity_STATUS Optional
instanceView	The virtual machine instance view.	VirtualMachineInstanceView_STATUS Optional
licenseType	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15	string Optional
location	Resource location	string Optional
name	Resource name	string Optional
networkProfile	Specifies the network interfaces of the virtual machine.	NetworkProfile_STATUS Optional
osProfile	Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.	OSProfile_STATUS Optional
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan_STATUS Optional
platformFaultDomain	Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the ‘virtualMachineScaleSet’ property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have ‘platformFaultDomainCount’ > 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01	int Optional
priority	Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01	Priority_STATUS Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.	SubResource_STATUS Optional
resources	The virtual machine child extension resources.	VirtualMachineExtension_STATUS[] Optional
scheduledEventsProfile	Specifies Scheduled Event related configurations.	ScheduledEventsProfile_STATUS Optional
securityProfile	Specifies the Security related profile settings for the virtual machine.	SecurityProfile_STATUS Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	StorageProfile_STATUS Optional
tags	Resource tags	map[string]string Optional
timeCreated	Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2022-03-01.	string Optional
type	Resource type	string Optional
userData	UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01	string Optional
virtualMachineScaleSet	Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01	SubResource_STATUS Optional
vmId	Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.	string Optional
zones	The virtual machine zones.	string[] Optional

VirtualMachineScaleSet_Spec

Used by: VirtualMachineScaleSet.

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.	AdditionalCapabilities Optional
automaticRepairsPolicy	Policy for automatic repairs.	AutomaticRepairsPolicy Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
doNotRunExtensionsOnOverprovisionedVMs	When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.	bool Optional
extendedLocation	The extended location of the Virtual Machine Scale Set.	ExtendedLocation Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.	SubResource Optional
identity	The identity of the virtual machine scale set, if configured.	VirtualMachineScaleSetIdentity Optional
location	Resource location	string Required
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachineScaleSetOperatorSpec Optional
orchestrationMode	Specifies the orchestration mode for the virtual machine scale set.	OrchestrationMode Optional
overprovision	Specifies whether the Virtual Machine Scale Set should be overprovisioned.	bool Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan Optional
platformFaultDomainCount	Fault Domain count for each placement group.	int Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.	SubResource Optional
scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.	ScaleInPolicy Optional
singlePlacementGroup	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.	bool Optional
sku	The virtual machine scale set sku.	Sku Optional
spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.	SpotRestorePolicy Optional
tags	Resource tags	map[string]string Optional
upgradePolicy	The upgrade policy.	UpgradePolicy Optional
virtualMachineProfile	The virtual machine profile.	VirtualMachineScaleSetVMProfile Optional
zoneBalance	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.	bool Optional
zones	The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set	string[] Optional

VirtualMachineScaleSet_STATUS

Describes a Virtual Machine Scale Set.

Used by: VirtualMachineScaleSet.

Property	Description	Type
additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.	AdditionalCapabilities_STATUS Optional
automaticRepairsPolicy	Policy for automatic repairs.	AutomaticRepairsPolicy_STATUS Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
doNotRunExtensionsOnOverprovisionedVMs	When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.	bool Optional
extendedLocation	The extended location of the Virtual Machine Scale Set.	ExtendedLocation_STATUS Optional
hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.	SubResource_STATUS Optional
id	Resource Id	string Optional
identity	The identity of the virtual machine scale set, if configured.	VirtualMachineScaleSetIdentity_STATUS Optional
location	Resource location	string Optional
name	Resource name	string Optional
orchestrationMode	Specifies the orchestration mode for the virtual machine scale set.	OrchestrationMode_STATUS Optional
overprovision	Specifies whether the Virtual Machine Scale Set should be overprovisioned.	bool Optional
plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.	Plan_STATUS Optional
platformFaultDomainCount	Fault Domain count for each placement group.	int Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.	SubResource_STATUS Optional
scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.	ScaleInPolicy_STATUS Optional
singlePlacementGroup	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.	bool Optional
sku	The virtual machine scale set sku.	Sku_STATUS Optional
spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.	SpotRestorePolicy_STATUS Optional
tags	Resource tags	map[string]string Optional
timeCreated	Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2022-03-01.	string Optional
type	Resource type	string Optional
uniqueId	Specifies the ID which uniquely identifies a Virtual Machine Scale Set.	string Optional
upgradePolicy	The upgrade policy.	UpgradePolicy_STATUS Optional
virtualMachineProfile	The virtual machine profile.	VirtualMachineScaleSetVMProfile_STATUS Optional
zoneBalance	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.	bool Optional
zones	The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set	string[] Optional

VirtualMachineScaleSetsExtension_Spec

Used by: VirtualMachineScaleSetsExtension.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachineScaleSetsExtensionOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a compute.azure.com/VirtualMachineScaleSet resource	genruntime.KnownResourceReference Required
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.	genruntime.SecretMapReference Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference Optional
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[] Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineScaleSetsExtension_STATUS

Used by: VirtualMachineScaleSetsExtension.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.	string Optional
id	Resource Id	string Optional
name	The name of the extension.	string Optional
properties_type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference_STATUS Optional
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[] Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
type	Resource type	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachinesExtension_Spec

Used by: VirtualMachinesExtension.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.	string Optional
instanceView	The virtual machine extension instance view.	VirtualMachineExtensionInstanceView Optional
location	Resource location	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	VirtualMachinesExtensionOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a compute.azure.com/VirtualMachine resource	genruntime.KnownResourceReference Required
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.	genruntime.SecretMapReference Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
tags	Resource tags	map[string]string Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachinesExtension_STATUS

Used by: VirtualMachinesExtension.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.	string Optional
id	Resource Id	string Optional
instanceView	The virtual machine extension instance view.	VirtualMachineExtensionInstanceView_STATUS Optional
location	Resource location	string Optional
name	Resource name	string Optional
properties_type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference_STATUS Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

AdditionalCapabilities

Enables or disables a capability on the virtual machine or virtual machine scale set.

Used by: VirtualMachine_Spec, and VirtualMachineScaleSet_Spec.

Property	Description	Type
hibernationEnabled	The flag that enables or disables hibernation capability on the VM.	bool Optional
ultraSSDEnabled	The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.	bool Optional

AdditionalCapabilities_STATUS

Enables or disables a capability on the virtual machine or virtual machine scale set.

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSet_STATUS.

Property	Description	Type
hibernationEnabled	The flag that enables or disables hibernation capability on the VM.	bool Optional
ultraSSDEnabled	The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.	bool Optional

ApplicationProfile

Contains the list of gallery applications that should be made available to the VM/VMSS

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Property	Description	Type
galleryApplications	Specifies the gallery applications that should be made available to the VM/VMSS	VMGalleryApplication[] Optional

ApplicationProfile_STATUS

Contains the list of gallery applications that should be made available to the VM/VMSS

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
galleryApplications	Specifies the gallery applications that should be made available to the VM/VMSS	VMGalleryApplication_STATUS[] Optional

AutomaticRepairsPolicy

Specifies the configuration parameters for automatic repairs on the virtual machine scale set.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
enabled	Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.	bool Optional
gracePeriod	The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).	string Optional
repairAction	Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.	AutomaticRepairsPolicy_RepairAction Optional

AutomaticRepairsPolicy_STATUS

Specifies the configuration parameters for automatic repairs on the virtual machine scale set.

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
enabled	Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.	bool Optional
gracePeriod	The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).	string Optional
repairAction	Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.	AutomaticRepairsPolicy_RepairAction_STATUS Optional

BillingProfile

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

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Property	Description	Type
maxPrice	Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: - Any decimal value greater than zero. Example: 0.01538 -1 – indicates default price to be up-to on-demand. You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. Minimum api-version: 2019-03-01.	float64 Optional

BillingProfile_STATUS

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

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
maxPrice	Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: - Any decimal value greater than zero. Example: 0.01538 -1 – indicates default price to be up-to on-demand. You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. Minimum api-version: 2019-03-01.	float64 Optional

CapacityReservationProfile

The parameters of a capacity reservation Profile.

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Property	Description	Type
capacityReservationGroup	Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details.	SubResource Optional

CapacityReservationProfile_STATUS

The parameters of a capacity reservation Profile.

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
capacityReservationGroup	Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details.	SubResource_STATUS Optional

DiagnosticsProfile

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Property	Description	Type
bootDiagnostics	Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.	BootDiagnostics Optional

DiagnosticsProfile_STATUS

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
bootDiagnostics	Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.	BootDiagnostics_STATUS Optional

EvictionPolicy

Specifies the eviction policy for the Azure Spot VM/VMSS

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Value	Description
“Deallocate”
“Delete”

EvictionPolicy_STATUS

Specifies the eviction policy for the Azure Spot VM/VMSS

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Value	Description
“Deallocate”
“Delete”

ExtendedLocation

The complex type of the extended location.

Used by: Image_Spec, VirtualMachine_Spec, and VirtualMachineScaleSet_Spec.

Property	Description	Type
name	The name of the extended location.	string Optional
type	The type of the extended location.	ExtendedLocationType Optional

ExtendedLocation_STATUS

The complex type of the extended location.

Used by: Image_STATUS, VirtualMachine_STATUS, and VirtualMachineScaleSet_STATUS.

Property	Description	Type
name	The name of the extended location.	string Optional
type	The type of the extended location.	ExtendedLocationType_STATUS Optional

HardwareProfile

Specifies the hardware settings for the virtual machine.

Used by: VirtualMachine_Spec.

Property	Description	Type
vmSize	Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. Recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set List all available virtual machine sizes in a region List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.	string Optional
vmSizeProperties	Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.	VMSizeProperties Optional

HardwareProfile_STATUS

Specifies the hardware settings for the virtual machine.

Used by: VirtualMachine_STATUS.

Property	Description	Type
vmSize	Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. Recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set List all available virtual machine sizes in a region List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.	HardwareProfile_VmSize_STATUS Optional
vmSizeProperties	Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.	VMSizeProperties_STATUS Optional

HyperVGenerationType

Specifies the HyperVGeneration Type

Used by: Image_Spec.

Value	Description
“V1”
“V2”

HyperVGenerationType_STATUS

Specifies the HyperVGeneration Type

Used by: Image_STATUS.

Value	Description
“V1”
“V2”

ImageOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: Image_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

ImageStorageProfile

Describes a storage profile.

Used by: Image_Spec.

Property	Description	Type
dataDisks	Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	ImageDataDisk[] Optional
osDisk	Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	ImageOSDisk Optional
zoneResilient	Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).	bool Optional

ImageStorageProfile_STATUS

Describes a storage profile.

Used by: Image_STATUS.

Property	Description	Type
dataDisks	Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	ImageDataDisk_STATUS[] Optional
osDisk	Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	ImageOSDisk_STATUS Optional
zoneResilient	Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).	bool Optional

KeyVaultSecretReference

Describes a reference to Key Vault Secret

Used by: DiskEncryptionSettings, VirtualMachineScaleSetExtension, VirtualMachineScaleSetsExtension_Spec, and VirtualMachinesExtension_Spec.

Property	Description	Type
secretUrl	The URL referencing a secret in a Key Vault.	string Required
sourceVault	The relative URL of the Key Vault containing the secret.	SubResource Required

KeyVaultSecretReference_STATUS

Describes a reference to Key Vault Secret

Used by: DiskEncryptionSettings_STATUS, VirtualMachineExtension_STATUS, VirtualMachineScaleSetExtension_STATUS, VirtualMachineScaleSetsExtension_STATUS, and VirtualMachinesExtension_STATUS.

Property	Description	Type
secretUrl	The URL referencing a secret in a Key Vault.	string Optional
sourceVault	The relative URL of the Key Vault containing the secret.	SubResource_STATUS Optional

NetworkProfile

Specifies the network interfaces or the networking configuration of the virtual machine.

Used by: VirtualMachine_Spec.

Property	Description	Type
networkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations	NetworkProfile_NetworkApiVersion Optional
networkInterfaceConfigurations	Specifies the networking configurations that will be used to create the virtual machine networking resources.	VirtualMachineNetworkInterfaceConfiguration[] Optional
networkInterfaces	Specifies the list of resource Ids for the network interfaces associated with the virtual machine.	NetworkInterfaceReference[] Optional

NetworkProfile_STATUS

Specifies the network interfaces or the networking configuration of the virtual machine.

Used by: VirtualMachine_STATUS.

Property	Description	Type
networkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations	NetworkProfile_NetworkApiVersion_STATUS Optional
networkInterfaceConfigurations	Specifies the networking configurations that will be used to create the virtual machine networking resources.	VirtualMachineNetworkInterfaceConfiguration_STATUS[] Optional
networkInterfaces	Specifies the list of resource Ids for the network interfaces associated with the virtual machine.	NetworkInterfaceReference_STATUS[] Optional

OrchestrationMode

Specifies the orchestration mode for the virtual machine scale set.

Used by: VirtualMachineScaleSet_Spec.

Value	Description
“Flexible”
“Uniform”

OrchestrationMode_STATUS

Specifies the orchestration mode for the virtual machine scale set.

Used by: VirtualMachineScaleSet_STATUS.

Value	Description
“Flexible”
“Uniform”

OSProfile

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Used by: VirtualMachine_Spec.

Property	Description	Type
adminPassword	Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!” For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension	genruntime.SecretReference Optional
adminUsername	Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.	string Optional
allowExtensionOperations	Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.	bool Optional
computerName	Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.	string Optional
customData	Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation	string Optional
linuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.	LinuxConfiguration Optional
requireGuestProvisionSignal	Optional property which must either be set to True or omitted.	bool Optional
secrets	Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	VaultSecretGroup[] Optional
windowsConfiguration	Specifies Windows operating system settings on the virtual machine.	WindowsConfiguration Optional

OSProfile_STATUS

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Used by: VirtualMachine_STATUS.

Property	Description	Type
adminUsername	Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.	string Optional
allowExtensionOperations	Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.	bool Optional
computerName	Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.	string Optional
customData	Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation	string Optional
linuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.	LinuxConfiguration_STATUS Optional
requireGuestProvisionSignal	Optional property which must either be set to True or omitted.	bool Optional
secrets	Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	VaultSecretGroup_STATUS[] Optional
windowsConfiguration	Specifies Windows operating system settings on the virtual machine.	WindowsConfiguration_STATUS Optional

Plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

Used by: VirtualMachine_Spec, and VirtualMachineScaleSet_Spec.

Property	Description	Type
name	The plan ID.	string Optional
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string Optional
promotionCode	The promotion code.	string Optional
publisher	The publisher ID.	string Optional

Plan_STATUS

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSet_STATUS.

Property	Description	Type
name	The plan ID.	string Optional
product	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.	string Optional
promotionCode	The promotion code.	string Optional
publisher	The publisher ID.	string Optional

Priority

Specifies the priority for a standalone virtual machine or the virtual machines in the scale set. ‘Low’ enum will be deprecated in the future, please use ‘Spot’ as the enum to deploy Azure Spot VM/VMSS.

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Value	Description
“Low”
“Regular”
“Spot”

Priority_STATUS

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Value	Description
“Low”
“Regular”
“Spot”

ScaleInPolicy

Describes a scale-in policy for a virtual machine scale set.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
forceDeletion	This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)	bool Optional
rules	The rules to be followed when scaling-in a virtual machine scale set. Possible values are: Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.	ScaleInPolicy_Rules[] Optional

ScaleInPolicy_STATUS

Describes a scale-in policy for a virtual machine scale set.

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
forceDeletion	This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)	bool Optional
rules	The rules to be followed when scaling-in a virtual machine scale set. Possible values are: Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.	ScaleInPolicy_Rules_STATUS[] Optional

ScheduledEventsProfile

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Property	Description	Type
terminateNotificationProfile	Specifies Terminate Scheduled Event related configurations.	TerminateNotificationProfile Optional

ScheduledEventsProfile_STATUS

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
terminateNotificationProfile	Specifies Terminate Scheduled Event related configurations.	TerminateNotificationProfile_STATUS Optional

SecurityProfile

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Used by: VirtualMachine_Spec, and VirtualMachineScaleSetVMProfile.

Property	Description	Type
encryptionAtHost	This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.	bool Optional
securityType	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.	SecurityProfile_SecurityType Optional
uefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01	UefiSettings Optional

SecurityProfile_STATUS

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Used by: VirtualMachine_STATUS, and VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
encryptionAtHost	This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.	bool Optional
securityType	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.	SecurityProfile_SecurityType_STATUS Optional
uefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01	UefiSettings_STATUS Optional

Sku

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
capacity	Specifies the number of virtual machines in the scale set.	int Optional
name	The sku name.	string Optional
tier	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic	string Optional

Sku_STATUS

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
capacity	Specifies the number of virtual machines in the scale set.	int Optional
name	The sku name.	string Optional
tier	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic	string Optional

SpotRestorePolicy

Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
enabled	Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints	bool Optional
restoreTimeout	Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances	string Optional

SpotRestorePolicy_STATUS

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
enabled	Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints	bool Optional
restoreTimeout	Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances	string Optional

StorageProfile

Specifies the storage settings for the virtual machine disks.

Used by: VirtualMachine_Spec.

Property	Description	Type
dataDisks	Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	DataDisk[] Optional
imageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.	ImageReference Optional
osDisk	Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	OSDisk Optional

StorageProfile_STATUS

Specifies the storage settings for the virtual machine disks.

Used by: VirtualMachine_STATUS.

Property	Description	Type
dataDisks	Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	DataDisk_STATUS[] Optional
imageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.	ImageReference_STATUS Optional
osDisk	Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.	OSDisk_STATUS Optional

SubResource

Used by: CapacityReservationProfile, Image_Spec, ImageDataDisk, ImageDataDisk, ImageDataDisk, ImageOSDisk, ImageOSDisk, ImageOSDisk, KeyVaultKeyReference, KeyVaultSecretReference, ManagedDiskParameters, VaultSecretGroup, VirtualMachine_Spec, VirtualMachine_Spec, VirtualMachine_Spec, VirtualMachine_Spec, VirtualMachine_Spec, VirtualMachineNetworkInterfaceConfiguration, VirtualMachineNetworkInterfaceConfiguration, VirtualMachineNetworkInterfaceIPConfiguration, VirtualMachineNetworkInterfaceIPConfiguration, VirtualMachineNetworkInterfaceIPConfiguration, VirtualMachineNetworkInterfaceIPConfiguration, VirtualMachinePublicIPAddressConfiguration, VirtualMachineScaleSet_Spec, VirtualMachineScaleSet_Spec, VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetManagedDiskParameters, VirtualMachineScaleSetNetworkConfiguration, VirtualMachineScaleSetPublicIPAddressConfiguration, and VMDiskSecurityProfile.

Property	Description	Type
reference	Resource Id	genruntime.ResourceReference Optional

SubResource_STATUS

Property	Description	Type
id	Resource Id	string Optional

UpgradePolicy

Describes an upgrade policy - automatic, manual, or rolling.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
automaticOSUpgradePolicy	Configuration parameters used for performing automatic OS Upgrade.	AutomaticOSUpgradePolicy Optional
mode	Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time.	UpgradePolicy_Mode Optional
rollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.	RollingUpgradePolicy Optional

UpgradePolicy_STATUS

Describes an upgrade policy - automatic, manual, or rolling.

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
automaticOSUpgradePolicy	Configuration parameters used for performing automatic OS Upgrade.	AutomaticOSUpgradePolicy_STATUS Optional
mode	Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. Automatic - All virtual machines in the scale set are automatically updated at the same time.	UpgradePolicy_Mode_STATUS Optional
rollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.	RollingUpgradePolicy_STATUS Optional

VirtualMachineExtension_STATUS

Describes a Virtual Machine Extension.

Used by: VirtualMachine_STATUS.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.	string Optional
id	Resource Id	string Optional
instanceView	The virtual machine extension instance view.	VirtualMachineExtensionInstanceView_STATUS Optional
location	Resource location	string Optional
name	Resource name	string Optional
properties_type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference_STATUS Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
tags	Resource tags	map[string]string Optional
type	Resource type	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

Used by: VirtualMachinesExtension_Spec.

Property	Description	Type
name	The virtual machine extension name.	string Optional
statuses	The resource status information.	InstanceViewStatus[] Optional
substatuses	The resource status information.	InstanceViewStatus[] Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineExtensionInstanceView_STATUS

The instance view of a virtual machine extension.

Used by: VirtualMachineExtension_STATUS, VirtualMachineInstanceView_STATUS, and VirtualMachinesExtension_STATUS.

Property	Description	Type
name	The virtual machine extension name.	string Optional
statuses	The resource status information.	InstanceViewStatus_STATUS[] Optional
substatuses	The resource status information.	InstanceViewStatus_STATUS[] Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineIdentity

Identity for the virtual machine.

Used by: VirtualMachine_Spec.

Property	Description	Type
type	The type of identity used for the virtual machine. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.	VirtualMachineIdentity_Type Optional
userAssignedIdentities	The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.	UserAssignedIdentityDetails[] Optional

VirtualMachineIdentity_STATUS

Identity for the virtual machine.

Used by: VirtualMachine_STATUS.

Property	Description	Type
principalId	The principal id of virtual machine identity. This property will only be provided for a system assigned identity.	string Optional
tenantId	The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.	string Optional
type	The type of identity used for the virtual machine. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.	VirtualMachineIdentity_Type_STATUS Optional
userAssignedIdentities	The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.	map[string]VirtualMachineIdentity_UserAssignedIdentities_STATUS Optional

VirtualMachineInstanceView_STATUS

The instance view of a virtual machine.

Used by: VirtualMachine_STATUS.

Property	Description	Type
assignedHost	Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01.	string Optional
bootDiagnostics	Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.	BootDiagnosticsInstanceView_STATUS Optional
computerName	The computer name assigned to the virtual machine.	string Optional
disks	The virtual machine disk information.	DiskInstanceView_STATUS[] Optional
extensions	The extensions information.	VirtualMachineExtensionInstanceView_STATUS[] Optional
hyperVGeneration	Specifies the HyperVGeneration Type associated with a resource	VirtualMachineInstanceView_HyperVGeneration_STATUS Optional
maintenanceRedeployStatus	The Maintenance Operation status on the virtual machine.	MaintenanceRedeployStatus_STATUS Optional
osName	The Operating System running on the virtual machine.	string Optional
osVersion	The version of Operating System running on the virtual machine.	string Optional
patchStatus	[Preview Feature] The status of virtual machine patch operations.	VirtualMachinePatchStatus_STATUS Optional
platformFaultDomain	Specifies the fault domain of the virtual machine.	int Optional
platformUpdateDomain	Specifies the update domain of the virtual machine.	int Optional
rdpThumbPrint	The Remote desktop certificate thumbprint.	string Optional
statuses	The resource status information.	InstanceViewStatus_STATUS[] Optional
vmAgent	The VM Agent running on the virtual machine.	VirtualMachineAgentInstanceView_STATUS Optional
vmHealth	The health status for the VM.	VirtualMachineHealthStatus_STATUS Optional

VirtualMachineOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualMachine_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

VirtualMachineScaleSetIdentity

Identity for the virtual machine scale set.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
type	The type of identity used for the virtual machine scale set. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine scale set.	VirtualMachineScaleSetIdentity_Type Optional
userAssignedIdentities	The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.	UserAssignedIdentityDetails[] Optional

VirtualMachineScaleSetIdentity_STATUS

Identity for the virtual machine scale set.

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
principalId	The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.	string Optional
tenantId	The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.	string Optional
type	The type of identity used for the virtual machine scale set. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine scale set.	VirtualMachineScaleSetIdentity_Type_STATUS Optional
userAssignedIdentities	The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.	map[string]VirtualMachineScaleSetIdentity_UserAssignedIdentities_STATUS Optional

VirtualMachineScaleSetOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

VirtualMachineScaleSetsExtensionOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualMachineScaleSetsExtension_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

VirtualMachineScaleSetVMProfile

Describes a virtual machine scale set virtual machine profile.

Used by: VirtualMachineScaleSet_Spec.

Property	Description	Type
applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS	ApplicationProfile Optional
billingProfile	Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.	BillingProfile Optional
capacityReservation	Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.	CapacityReservationProfile Optional
diagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.	DiagnosticsProfile Optional
evictionPolicy	Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2017-10-30-preview.	EvictionPolicy Optional
extensionProfile	Specifies a collection of settings for extensions installed on virtual machines in the scale set.	VirtualMachineScaleSetExtensionProfile Optional
hardwareProfile	Specifies the hardware profile related details of a scale set. Minimum api-version: 2022-03-01.	VirtualMachineScaleSetHardwareProfile Optional
licenseType	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15	string Optional
networkProfile	Specifies properties of the network interfaces of the virtual machines in the scale set.	VirtualMachineScaleSetNetworkProfile Optional
osProfile	Specifies the operating system settings for the virtual machines in the scale set.	VirtualMachineScaleSetOSProfile Optional
priority	Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview	Priority Optional
scheduledEventsProfile	Specifies Scheduled Event related configurations.	ScheduledEventsProfile Optional
securityProfile	Specifies the Security related profile settings for the virtual machines in the scale set.	SecurityProfile Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	VirtualMachineScaleSetStorageProfile Optional
userData	UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01	string Optional

VirtualMachineScaleSetVMProfile_STATUS

Describes a virtual machine scale set virtual machine profile.

Used by: VirtualMachineScaleSet_STATUS.

Property	Description	Type
applicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS	ApplicationProfile_STATUS Optional
billingProfile	Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.	BillingProfile_STATUS Optional
capacityReservation	Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.	CapacityReservationProfile_STATUS Optional
diagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.	DiagnosticsProfile_STATUS Optional
evictionPolicy	Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both ‘Deallocate’ and ‘Delete’ are supported and the minimum api-version is 2017-10-30-preview.	EvictionPolicy_STATUS Optional
extensionProfile	Specifies a collection of settings for extensions installed on virtual machines in the scale set.	VirtualMachineScaleSetExtensionProfile_STATUS Optional
hardwareProfile	Specifies the hardware profile related details of a scale set. Minimum api-version: 2022-03-01.	VirtualMachineScaleSetHardwareProfile_STATUS Optional
licenseType	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15	string Optional
networkProfile	Specifies properties of the network interfaces of the virtual machines in the scale set.	VirtualMachineScaleSetNetworkProfile_STATUS Optional
osProfile	Specifies the operating system settings for the virtual machines in the scale set.	VirtualMachineScaleSetOSProfile_STATUS Optional
priority	Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview	Priority_STATUS Optional
scheduledEventsProfile	Specifies Scheduled Event related configurations.	ScheduledEventsProfile_STATUS Optional
securityProfile	Specifies the Security related profile settings for the virtual machines in the scale set.	SecurityProfile_STATUS Optional
storageProfile	Specifies the storage settings for the virtual machine disks.	VirtualMachineScaleSetStorageProfile_STATUS Optional
userData	UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01	string Optional

VirtualMachinesExtensionOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualMachinesExtension_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

AutomaticOSUpgradePolicy

The configuration parameters used for performing automatic OS upgrade.

Used by: UpgradePolicy.

Property	Description	Type
disableAutomaticRollback	Whether OS image rollback feature should be disabled. Default value is false.	bool Optional
enableAutomaticOSUpgrade	Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true.	bool Optional
useRollingUpgradePolicy	Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.	bool Optional

AutomaticOSUpgradePolicy_STATUS

The configuration parameters used for performing automatic OS upgrade.

Used by: UpgradePolicy_STATUS.

Property	Description	Type
disableAutomaticRollback	Whether OS image rollback feature should be disabled. Default value is false.	bool Optional
enableAutomaticOSUpgrade	Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true.	bool Optional
useRollingUpgradePolicy	Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.	bool Optional

AutomaticRepairsPolicy_RepairAction

Used by: AutomaticRepairsPolicy.

Value	Description
“Reimage”
“Replace”
“Restart”

AutomaticRepairsPolicy_RepairAction_STATUS

Used by: AutomaticRepairsPolicy_STATUS.

Value	Description
“Reimage”
“Replace”
“Restart”

BootDiagnostics

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

Used by: DiagnosticsProfile.

Property	Description	Type
enabled	Whether boot diagnostics should be enabled on the Virtual Machine.	bool Optional
storageUri	Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.	string Optional

BootDiagnostics_STATUS

Used by: DiagnosticsProfile_STATUS.

Property	Description	Type
enabled	Whether boot diagnostics should be enabled on the Virtual Machine.	bool Optional
storageUri	Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.	string Optional

BootDiagnosticsInstanceView_STATUS

The instance view of a virtual machine boot diagnostics.

Used by: VirtualMachineInstanceView_STATUS.

Property	Description	Type
consoleScreenshotBlobUri	The console screenshot blob URI. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.	string Optional
serialConsoleLogBlobUri	The serial console log blob Uri. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.	string Optional
status	The boot diagnostics status information for the VM. NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.	InstanceViewStatus_STATUS Optional

DataDisk

Describes a data disk.

Used by: StorageProfile.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	Caching Optional
createOption	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.	CreateOption Required
deleteOption	Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach	DeleteOption Optional
detachOption	Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to ’true’ along with setting detachOption: ‘ForceDetach’.	DetachOption Optional
diskSizeGB	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
image	The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.	VirtualHardDisk Optional
lun	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.	int Required
managedDisk	The managed disk parameters.	ManagedDiskParameters Optional
name	The disk name.	string Optional
toBeDetached	Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset	bool Optional
vhd	The virtual hard disk.	VirtualHardDisk Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

DataDisk_STATUS

Describes a data disk.

Used by: StorageProfile_STATUS.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	Caching_STATUS Optional
createOption	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.	CreateOption_STATUS Optional
deleteOption	Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach	DeleteOption_STATUS Optional
detachOption	Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to ’true’ along with setting detachOption: ‘ForceDetach’.	DetachOption_STATUS Optional
diskIOPSReadWrite	Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.	int Optional
diskMBpsReadWrite	Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.	int Optional
diskSizeGB	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
image	The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.	VirtualHardDisk_STATUS Optional
lun	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.	int Optional
managedDisk	The managed disk parameters.	ManagedDiskParameters_STATUS Optional
name	The disk name.	string Optional
toBeDetached	Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset	bool Optional
vhd	The virtual hard disk.	VirtualHardDisk_STATUS Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

DiskInstanceView_STATUS

The instance view of the disk.

Used by: VirtualMachineInstanceView_STATUS.

Property	Description	Type
encryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15	DiskEncryptionSettings_STATUS[] Optional
name	The disk name.	string Optional
statuses	The resource status information.	InstanceViewStatus_STATUS[] Optional

ExtendedLocationType

The type of extendedLocation.

Used by: ExtendedLocation.

Value	Description
“EdgeZone”

ExtendedLocationType_STATUS

The type of extendedLocation.

Used by: ExtendedLocation_STATUS.

Value	Description
“EdgeZone”

HardwareProfile_VmSize_STATUS

Used by: HardwareProfile_STATUS.

Value	Description
“Basic_A0”
“Basic_A1”
“Basic_A2”
“Basic_A3”
“Basic_A4”
“Standard_A0”
“Standard_A1”
“Standard_A10”
“Standard_A11”
“Standard_A1_v2”
“Standard_A2”
“Standard_A2m_v2”
“Standard_A2_v2”
“Standard_A3”
“Standard_A4”
“Standard_A4m_v2”
“Standard_A4_v2”
“Standard_A5”
“Standard_A6”
“Standard_A7”
“Standard_A8”
“Standard_A8m_v2”
“Standard_A8_v2”
“Standard_A9”
“Standard_B1ms”
“Standard_B1s”
“Standard_B2ms”
“Standard_B2s”
“Standard_B4ms”
“Standard_B8ms”
“Standard_D1”
“Standard_D11”
“Standard_D11_v2”
“Standard_D12”
“Standard_D12_v2”
“Standard_D13”
“Standard_D13_v2”
“Standard_D14”
“Standard_D14_v2”
“Standard_D15_v2”
“Standard_D16s_v3”
“Standard_D16_v3”
“Standard_D1_v2”
“Standard_D2”
“Standard_D2s_v3”
“Standard_D2_v2”
“Standard_D2_v3”
“Standard_D3”
“Standard_D32s_v3”
“Standard_D32_v3”
“Standard_D3_v2”
“Standard_D4”
“Standard_D4s_v3”
“Standard_D4_v2”
“Standard_D4_v3”
“Standard_D5_v2”
“Standard_D64s_v3”
“Standard_D64_v3”
“Standard_D8s_v3”
“Standard_D8_v3”
“Standard_DS1”
“Standard_DS11”
“Standard_DS11_v2”
“Standard_DS12”
“Standard_DS12_v2”
“Standard_DS13”
“Standard_DS13-2_v2”
“Standard_DS13-4_v2”
“Standard_DS13_v2”
“Standard_DS14”
“Standard_DS14-4_v2”
“Standard_DS14-8_v2”
“Standard_DS14_v2”
“Standard_DS15_v2”
“Standard_DS1_v2”
“Standard_DS2”
“Standard_DS2_v2”
“Standard_DS3”
“Standard_DS3_v2”
“Standard_DS4”
“Standard_DS4_v2”
“Standard_DS5_v2”
“Standard_E16s_v3”
“Standard_E16_v3”
“Standard_E2s_v3”
“Standard_E2_v3”
“Standard_E32-16_v3”
“Standard_E32-8s_v3”
“Standard_E32s_v3”
“Standard_E32_v3”
“Standard_E4s_v3”
“Standard_E4_v3”
“Standard_E64-16s_v3”
“Standard_E64-32s_v3”
“Standard_E64s_v3”
“Standard_E64_v3”
“Standard_E8s_v3”
“Standard_E8_v3”
“Standard_F1”
“Standard_F16”
“Standard_F16s”
“Standard_F16s_v2”
“Standard_F1s”
“Standard_F2”
“Standard_F2s”
“Standard_F2s_v2”
“Standard_F32s_v2”
“Standard_F4”
“Standard_F4s”
“Standard_F4s_v2”
“Standard_F64s_v2”
“Standard_F72s_v2”
“Standard_F8”
“Standard_F8s”
“Standard_F8s_v2”
“Standard_G1”
“Standard_G2”
“Standard_G3”
“Standard_G4”
“Standard_G5”
“Standard_GS1”
“Standard_GS2”
“Standard_GS3”
“Standard_GS4”
“Standard_GS4-4”
“Standard_GS4-8”
“Standard_GS5”
“Standard_GS5-16”
“Standard_GS5-8”
“Standard_H16”
“Standard_H16m”
“Standard_H16mr”
“Standard_H16r”
“Standard_H8”
“Standard_H8m”
“Standard_L16s”
“Standard_L32s”
“Standard_L4s”
“Standard_L8s”
“Standard_M128-32ms”
“Standard_M128-64ms”
“Standard_M128ms”
“Standard_M128s”
“Standard_M64-16ms”
“Standard_M64-32ms”
“Standard_M64ms”
“Standard_M64s”
“Standard_NC12”
“Standard_NC12s_v2”
“Standard_NC12s_v3”
“Standard_NC24”
“Standard_NC24r”
“Standard_NC24rs_v2”
“Standard_NC24rs_v3”
“Standard_NC24s_v2”
“Standard_NC24s_v3”
“Standard_NC6”
“Standard_NC6s_v2”
“Standard_NC6s_v3”
“Standard_ND12s”
“Standard_ND24rs”
“Standard_ND24s”
“Standard_ND6s”
“Standard_NV12”
“Standard_NV24”
“Standard_NV6”

ImageDataDisk

Describes a data disk.

Used by: ImageStorageProfile.

Property	Description	Type
blobUri	The Virtual Hard Disk.	string Optional
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	ImageDataDisk_Caching Optional
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed image disk.	SubResource Optional
diskSizeGB	Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
lun	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.	int Required
managedDisk	The managedDisk.	SubResource Optional
snapshot	The snapshot.	SubResource Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType Optional

ImageDataDisk_STATUS

Describes a data disk.

Used by: ImageStorageProfile_STATUS.

Property	Description	Type
blobUri	The Virtual Hard Disk.	string Optional
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	ImageDataDisk_Caching_STATUS Optional
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed image disk.	SubResource_STATUS Optional
diskSizeGB	Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
lun	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.	int Optional
managedDisk	The managedDisk.	SubResource_STATUS Optional
snapshot	The snapshot.	SubResource_STATUS Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType_STATUS Optional

ImageOSDisk

Describes an Operating System disk.

Used by: ImageStorageProfile.

Property	Description	Type
blobUri	The Virtual Hard Disk.	string Optional
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	ImageOSDisk_Caching Optional
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed image disk.	SubResource Optional
diskSizeGB	Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
managedDisk	The managedDisk.	SubResource Optional
osState	The OS State. For managed images, use Generalized.	ImageOSDisk_OsState Required
osType	This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux	ImageOSDisk_OsType Required
snapshot	The snapshot.	SubResource Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType Optional

ImageOSDisk_STATUS

Describes an Operating System disk.

Used by: ImageStorageProfile_STATUS.

Property	Description	Type
blobUri	The Virtual Hard Disk.	string Optional
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	ImageOSDisk_Caching_STATUS Optional
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed image disk.	SubResource_STATUS Optional
diskSizeGB	Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
managedDisk	The managedDisk.	SubResource_STATUS Optional
osState	The OS State. For managed images, use Generalized.	ImageOSDisk_OsState_STATUS Optional
osType	This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux	ImageOSDisk_OsType_STATUS Optional
snapshot	The snapshot.	SubResource_STATUS Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType_STATUS Optional

ImageReference

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Used by: StorageProfile, and VirtualMachineScaleSetStorageProfile.

Property	Description	Type
communityGalleryImageId	Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.	string Optional
offer	Specifies the offer of the platform image or marketplace image used to create the virtual machine.	string Optional
publisher	The image publisher.	string Optional
reference	Resource Id	genruntime.ResourceReference Optional
sharedGalleryImageId	Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.	string Optional
sku	The image SKU.	string Optional
version	Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ’latest’. Major, Minor, and Build are decimal numbers. Specify ’latest’ to use the latest version of an image available at deploy time. Even if you use ’latest’, the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ’latest’ version of gallery image, just set ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}’ in the ‘id’ field without version input.	string Optional

ImageReference_STATUS

Used by: StorageProfile_STATUS, and VirtualMachineScaleSetStorageProfile_STATUS.

Property	Description	Type
communityGalleryImageId	Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.	string Optional
exactVersion	Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from ‘version’, only if the value specified in ‘version’ field is ’latest’.	string Optional
id	Resource Id	string Optional
offer	Specifies the offer of the platform image or marketplace image used to create the virtual machine.	string Optional
publisher	The image publisher.	string Optional
sharedGalleryImageId	Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.	string Optional
sku	The image SKU.	string Optional
version	Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ’latest’. Major, Minor, and Build are decimal numbers. Specify ’latest’ to use the latest version of an image available at deploy time. Even if you use ’latest’, the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ’latest’ version of gallery image, just set ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}’ in the ‘id’ field without version input.	string Optional

InstanceViewStatus

Instance view status.

Used by: VirtualMachineExtensionInstanceView, and VirtualMachineExtensionInstanceView.

Property	Description	Type
code	The status code.	string Optional
displayStatus	The short localizable label for the status.	string Optional
level	The level code.	InstanceViewStatus_Level Optional
message	The detailed status message, including for alerts and error messages.	string Optional
time	The time of the status.	string Optional

InstanceViewStatus_STATUS

Instance view status.

Used by: BootDiagnosticsInstanceView_STATUS, DiskInstanceView_STATUS, VirtualMachineAgentInstanceView_STATUS, VirtualMachineExtensionHandlerInstanceView_STATUS, VirtualMachineExtensionInstanceView_STATUS, VirtualMachineExtensionInstanceView_STATUS, VirtualMachineHealthStatus_STATUS, VirtualMachineInstanceView_STATUS, and VirtualMachinePatchStatus_STATUS.

Property	Description	Type
code	The status code.	string Optional
displayStatus	The short localizable label for the status.	string Optional
level	The level code.	InstanceViewStatus_Level_STATUS Optional
message	The detailed status message, including for alerts and error messages.	string Optional
time	The time of the status.	string Optional

LinuxConfiguration

Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Used by: OSProfile, and VirtualMachineScaleSetOSProfile.

Property	Description	Type
disablePasswordAuthentication	Specifies whether password authentication should be disabled.	bool Optional
patchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Linux.	LinuxPatchSettings Optional
provisionVMAgent	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.	bool Optional
ssh	Specifies the ssh key configuration for a Linux OS.	SshConfiguration Optional

LinuxConfiguration_STATUS

Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Used by: OSProfile_STATUS, and VirtualMachineScaleSetOSProfile_STATUS.

Property	Description	Type
disablePasswordAuthentication	Specifies whether password authentication should be disabled.	bool Optional
patchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Linux.	LinuxPatchSettings_STATUS Optional
provisionVMAgent	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.	bool Optional
ssh	Specifies the ssh key configuration for a Linux OS.	SshConfiguration_STATUS Optional

MaintenanceRedeployStatus_STATUS

Maintenance Operation Status.

Used by: VirtualMachineInstanceView_STATUS.

Property	Description	Type
isCustomerInitiatedMaintenanceAllowed	True, if customer is allowed to perform Maintenance.	bool Optional
lastOperationMessage	Message returned for the last Maintenance Operation.	string Optional
lastOperationResultCode	The Last Maintenance Operation Result Code.	MaintenanceRedeployStatus_LastOperationResultCode_STATUS Optional
maintenanceWindowEndTime	End Time for the Maintenance Window.	string Optional
maintenanceWindowStartTime	Start Time for the Maintenance Window.	string Optional
preMaintenanceWindowEndTime	End Time for the Pre Maintenance Window.	string Optional
preMaintenanceWindowStartTime	Start Time for the Pre Maintenance Window.	string Optional

NetworkInterfaceReference

Describes a network interface reference.

Used by: NetworkProfile.

Property	Description	Type
deleteOption	Specify what happens to the network interface when the VM is deleted	NetworkInterfaceReferenceProperties_DeleteOption Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional
reference	Resource Id	genruntime.ResourceReference Optional

NetworkInterfaceReference_STATUS

Describes a network interface reference.

Used by: NetworkProfile_STATUS.

Property	Description	Type
deleteOption	Specify what happens to the network interface when the VM is deleted	NetworkInterfaceReferenceProperties_DeleteOption_STATUS Optional
id	Resource Id	string Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional

NetworkProfile_NetworkApiVersion

Used by: NetworkProfile.

Value	Description
“2020-11-01”

NetworkProfile_NetworkApiVersion_STATUS

Used by: NetworkProfile_STATUS.

Value	Description
“2020-11-01”

OSDisk

Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

Used by: StorageProfile.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage.	Caching Optional
createOption	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.	CreateOption Required
deleteOption	Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.	DeleteOption Optional
diffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.	DiffDiskSettings Optional
diskSizeGB	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
encryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15	DiskEncryptionSettings Optional
image	The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.	VirtualHardDisk Optional
managedDisk	The managed disk parameters.	ManagedDiskParameters Optional
name	The disk name.	string Optional
osType	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows Linux	OSDisk_OsType Optional
vhd	The virtual hard disk.	VirtualHardDisk Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

OSDisk_STATUS

Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

Used by: StorageProfile_STATUS.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage.	Caching_STATUS Optional
createOption	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.	CreateOption_STATUS Optional
deleteOption	Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.	DeleteOption_STATUS Optional
diffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.	DiffDiskSettings_STATUS Optional
diskSizeGB	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
encryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15	DiskEncryptionSettings_STATUS Optional
image	The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.	VirtualHardDisk_STATUS Optional
managedDisk	The managed disk parameters.	ManagedDiskParameters_STATUS Optional
name	The disk name.	string Optional
osType	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows Linux	OSDisk_OsType_STATUS Optional
vhd	The virtual hard disk.	VirtualHardDisk_STATUS Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

RollingUpgradePolicy

The configuration parameters used while performing a rolling upgrade.

Used by: UpgradePolicy.

Property	Description	Type
enableCrossZoneUpgrade	Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.	bool Optional
maxBatchInstancePercent	The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.	int Optional
maxUnhealthyInstancePercent	The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.	int Optional
maxUnhealthyUpgradedInstancePercent	The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.	int Optional
pauseTimeBetweenBatches	The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).	string Optional
prioritizeUnhealthyInstances	Upgrade all unhealthy instances in a scale set before any healthy instances.	bool Optional

RollingUpgradePolicy_STATUS

The configuration parameters used while performing a rolling upgrade.

Used by: UpgradePolicy_STATUS.

Property	Description	Type
enableCrossZoneUpgrade	Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.	bool Optional
maxBatchInstancePercent	The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.	int Optional
maxUnhealthyInstancePercent	The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.	int Optional
maxUnhealthyUpgradedInstancePercent	The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.	int Optional
pauseTimeBetweenBatches	The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).	string Optional
prioritizeUnhealthyInstances	Upgrade all unhealthy instances in a scale set before any healthy instances.	bool Optional

ScaleInPolicy_Rules

Used by: ScaleInPolicy.

Value	Description
“Default”
“NewestVM”
“OldestVM”

ScaleInPolicy_Rules_STATUS

Used by: ScaleInPolicy_STATUS.

Value	Description
“Default”
“NewestVM”
“OldestVM”

SecurityProfile_SecurityType

Used by: SecurityProfile.

Value	Description
“ConfidentialVM”
“TrustedLaunch”

SecurityProfile_SecurityType_STATUS

Used by: SecurityProfile_STATUS.

Value	Description
“ConfidentialVM”
“TrustedLaunch”

TerminateNotificationProfile

Used by: ScheduledEventsProfile.

Property	Description	Type
enable	Specifies whether the Terminate Scheduled event is enabled or disabled.	bool Optional
notBeforeTimeout	Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)	string Optional

TerminateNotificationProfile_STATUS

Used by: ScheduledEventsProfile_STATUS.

Property	Description	Type
enable	Specifies whether the Terminate Scheduled event is enabled or disabled.	bool Optional
notBeforeTimeout	Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)	string Optional

UefiSettings

Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01

Used by: SecurityProfile.

Property	Description	Type
secureBootEnabled	Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01	bool Optional
vTpmEnabled	Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01	bool Optional

UefiSettings_STATUS

Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01

Used by: SecurityProfile_STATUS.

Property	Description	Type
secureBootEnabled	Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01	bool Optional
vTpmEnabled	Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01	bool Optional

UpgradePolicy_Mode

Used by: UpgradePolicy.

Value	Description
“Automatic”
“Manual”
“Rolling”

UpgradePolicy_Mode_STATUS

Used by: UpgradePolicy_STATUS.

Value	Description
“Automatic”
“Manual”
“Rolling”

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: VirtualMachineIdentity, and VirtualMachineScaleSetIdentity.

Property	Description	Type
reference		genruntime.ResourceReference Optional

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

Used by: OSProfile, and VirtualMachineScaleSetOSProfile.

Property	Description	Type
sourceVault	The relative URL of the Key Vault containing all of the certificates in VaultCertificates.	SubResource Optional
vaultCertificates	The list of key vault references in SourceVault which contain certificates.	VaultCertificate[] Optional

VaultSecretGroup_STATUS

Describes a set of certificates which are all in the same Key Vault.

Used by: OSProfile_STATUS, and VirtualMachineScaleSetOSProfile_STATUS.

Property	Description	Type
sourceVault	The relative URL of the Key Vault containing all of the certificates in VaultCertificates.	SubResource_STATUS Optional
vaultCertificates	The list of key vault references in SourceVault which contain certificates.	VaultCertificate_STATUS[] Optional

VirtualMachineAgentInstanceView_STATUS

The instance view of the VM Agent running on the virtual machine.

Used by: VirtualMachineInstanceView_STATUS.

Property	Description	Type
extensionHandlers	The virtual machine extension handler instance view.	VirtualMachineExtensionHandlerInstanceView_STATUS[] Optional
statuses	The resource status information.	InstanceViewStatus_STATUS[] Optional
vmAgentVersion	The VM Agent full version.	string Optional

VirtualMachineHealthStatus_STATUS

The health status of the VM.

Used by: VirtualMachineInstanceView_STATUS.

Property	Description	Type
status	The health status information for the VM.	InstanceViewStatus_STATUS Optional

VirtualMachineIdentity_Type

Used by: VirtualMachineIdentity.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

VirtualMachineIdentity_Type_STATUS

Used by: VirtualMachineIdentity_STATUS.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

VirtualMachineIdentity_UserAssignedIdentities_STATUS

Used by: VirtualMachineIdentity_STATUS.

Property	Description	Type
clientId	The client id of user assigned identity.	string Optional
principalId	The principal id of user assigned identity.	string Optional

VirtualMachineInstanceView_HyperVGeneration_STATUS

Used by: VirtualMachineInstanceView_STATUS.

Value	Description
“V1”
“V2”

VirtualMachineNetworkInterfaceConfiguration

Describes a virtual machine network interface configurations.

Used by: NetworkProfile.

Property	Description	Type
deleteOption	Specify what happens to the network interface when the VM is deleted	VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption Optional
dnsSettings	The dns settings to be applied on the network interfaces.	VirtualMachineNetworkInterfaceDnsSettingsConfiguration Optional
dscpConfiguration		SubResource Optional
enableAcceleratedNetworking	Specifies whether the network interface is accelerated networking-enabled.	bool Optional
enableFpga	Specifies whether the network interface is FPGA networking-enabled.	bool Optional
enableIPForwarding	Whether IP forwarding enabled on this NIC.	bool Optional
ipConfigurations	Specifies the IP configurations of the network interface.	VirtualMachineNetworkInterfaceIPConfiguration[] Required
name	The network interface configuration name.	string Required
networkSecurityGroup	The network security group.	SubResource Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional

VirtualMachineNetworkInterfaceConfiguration_STATUS

Describes a virtual machine network interface configurations.

Used by: NetworkProfile_STATUS.

Property	Description	Type
deleteOption	Specify what happens to the network interface when the VM is deleted	VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption_STATUS Optional
dnsSettings	The dns settings to be applied on the network interfaces.	VirtualMachineNetworkInterfaceDnsSettingsConfiguration_STATUS Optional
dscpConfiguration		SubResource_STATUS Optional
enableAcceleratedNetworking	Specifies whether the network interface is accelerated networking-enabled.	bool Optional
enableFpga	Specifies whether the network interface is FPGA networking-enabled.	bool Optional
enableIPForwarding	Whether IP forwarding enabled on this NIC.	bool Optional
ipConfigurations	Specifies the IP configurations of the network interface.	VirtualMachineNetworkInterfaceIPConfiguration_STATUS[] Optional
name	The network interface configuration name.	string Optional
networkSecurityGroup	The network security group.	SubResource_STATUS Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional

VirtualMachinePatchStatus_STATUS

The status of virtual machine patch operations.

Used by: VirtualMachineInstanceView_STATUS.

Property	Description	Type
availablePatchSummary	The available patch summary of the latest assessment operation for the virtual machine.	AvailablePatchSummary_STATUS Optional
configurationStatuses	The enablement status of the specified patchMode	InstanceViewStatus_STATUS[] Optional
lastPatchInstallationSummary	The installation summary of the latest installation operation for the virtual machine.	LastPatchInstallationSummary_STATUS Optional

VirtualMachineScaleSetExtensionProfile

Describes a virtual machine scale set extension profile.

Used by: VirtualMachineScaleSetVMProfile.

Property	Description	Type
extensions	The virtual machine scale set child extension resources.	VirtualMachineScaleSetExtension[] Optional
extensionsTimeBudget	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01	string Optional

VirtualMachineScaleSetExtensionProfile_STATUS

Describes a virtual machine scale set extension profile.

Used by: VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
extensions	The virtual machine scale set child extension resources.	VirtualMachineScaleSetExtension_STATUS[] Optional
extensionsTimeBudget	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01	string Optional

VirtualMachineScaleSetHardwareProfile

Specifies the hardware settings for the virtual machine scale set.

Used by: VirtualMachineScaleSetVMProfile.

Property	Description	Type
vmSizeProperties	Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2022-03-01. Please follow the instructions in VM Customization for more details.	VMSizeProperties Optional

VirtualMachineScaleSetHardwareProfile_STATUS

Specifies the hardware settings for the virtual machine scale set.

Used by: VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
vmSizeProperties	Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2022-03-01. Please follow the instructions in VM Customization for more details.	VMSizeProperties_STATUS Optional

VirtualMachineScaleSetIdentity_Type

Used by: VirtualMachineScaleSetIdentity.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

VirtualMachineScaleSetIdentity_Type_STATUS

Used by: VirtualMachineScaleSetIdentity_STATUS.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

VirtualMachineScaleSetIdentity_UserAssignedIdentities_STATUS

Used by: VirtualMachineScaleSetIdentity_STATUS.

Property	Description	Type
clientId	The client id of user assigned identity.	string Optional
principalId	The principal id of user assigned identity.	string Optional

VirtualMachineScaleSetNetworkProfile

Describes a virtual machine scale set network profile.

Used by: VirtualMachineScaleSetVMProfile.

Property	Description	Type
healthProbe	A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}’.	ApiEntityReference Optional
networkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode ‘Flexible’	VirtualMachineScaleSetNetworkProfile_NetworkApiVersion Optional
networkInterfaceConfigurations	The list of network configurations.	VirtualMachineScaleSetNetworkConfiguration[] Optional

VirtualMachineScaleSetNetworkProfile_STATUS

Describes a virtual machine scale set network profile.

Used by: VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
healthProbe	A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}’.	ApiEntityReference_STATUS Optional
networkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode ‘Flexible’	VirtualMachineScaleSetNetworkProfile_NetworkApiVersion_STATUS Optional
networkInterfaceConfigurations	The list of network configurations.	VirtualMachineScaleSetNetworkConfiguration_STATUS[] Optional

VirtualMachineScaleSetOSProfile

Describes a virtual machine scale set OS profile.

Used by: VirtualMachineScaleSetVMProfile.

Property	Description	Type
adminPassword	Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!” For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension	genruntime.SecretReference Optional
adminUsername	Specifies the name of the administrator account. Windows-only restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters	string Optional
allowExtensionOperations	Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.	bool Optional
computerNamePrefix	Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.	string Optional
customData	Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation	string Optional
linuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.	LinuxConfiguration Optional
secrets	Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	VaultSecretGroup[] Optional
windowsConfiguration	Specifies Windows operating system settings on the virtual machine.	WindowsConfiguration Optional

VirtualMachineScaleSetOSProfile_STATUS

Describes a virtual machine scale set OS profile.

Used by: VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
adminUsername	Specifies the name of the administrator account. Windows-only restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters	string Optional
allowExtensionOperations	Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.	bool Optional
computerNamePrefix	Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.	string Optional
customData	Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation	string Optional
linuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.	LinuxConfiguration_STATUS Optional
secrets	Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	VaultSecretGroup_STATUS[] Optional
windowsConfiguration	Specifies Windows operating system settings on the virtual machine.	WindowsConfiguration_STATUS Optional

VirtualMachineScaleSetStorageProfile

Describes a virtual machine scale set storage profile.

Used by: VirtualMachineScaleSetVMProfile.

Property	Description	Type
dataDisks	Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines.	VirtualMachineScaleSetDataDisk[] Optional
imageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.	ImageReference Optional
osDisk	Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines.	VirtualMachineScaleSetOSDisk Optional

VirtualMachineScaleSetStorageProfile_STATUS

Describes a virtual machine scale set storage profile.

Used by: VirtualMachineScaleSetVMProfile_STATUS.

Property	Description	Type
dataDisks	Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines.	VirtualMachineScaleSetDataDisk_STATUS[] Optional
imageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.	ImageReference_STATUS Optional
osDisk	Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines.	VirtualMachineScaleSetOSDisk_STATUS Optional

VMGalleryApplication

Specifies the required information to reference a compute gallery application version

Used by: ApplicationProfile.

Property	Description	Type
configurationReference	Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided	string Optional
enableAutomaticUpgrade	If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS	bool Optional
order	Optional, Specifies the order in which the packages have to be installed	int Optional
packageReferenceReference	Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}	genruntime.ResourceReference Required
tags	Optional, Specifies a passthrough value for more generic context.	string Optional
treatFailureAsDeploymentFailure	Optional, If true, any failure for any operation in the VmApplication will fail the deployment	bool Optional

VMGalleryApplication_STATUS

Specifies the required information to reference a compute gallery application version

Used by: ApplicationProfile_STATUS.

Property	Description	Type
configurationReference	Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided	string Optional
enableAutomaticUpgrade	If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS	bool Optional
order	Optional, Specifies the order in which the packages have to be installed	int Optional
packageReferenceId	Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}	string Optional
tags	Optional, Specifies a passthrough value for more generic context.	string Optional
treatFailureAsDeploymentFailure	Optional, If true, any failure for any operation in the VmApplication will fail the deployment	bool Optional

VMSizeProperties

Specifies VM Size Property settings on the virtual machine.

Used by: HardwareProfile, and VirtualMachineScaleSetHardwareProfile.

Property	Description	Type
vCPUsAvailable	Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .	int Optional
vCPUsPerCore	Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.	int Optional

VMSizeProperties_STATUS

Specifies VM Size Property settings on the virtual machine.

Used by: HardwareProfile_STATUS, and VirtualMachineScaleSetHardwareProfile_STATUS.

Property	Description	Type
vCPUsAvailable	Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .	int Optional
vCPUsPerCore	Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.	int Optional

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

Used by: OSProfile, and VirtualMachineScaleSetOSProfile.

Property	Description	Type
additionalUnattendContent	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.	AdditionalUnattendContent[] Optional
enableAutomaticUpdates	Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.	bool Optional
patchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Windows.	PatchSettings Optional
provisionVMAgent	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.	bool Optional
timeZone	Specifies the time zone of the virtual machine. e.g. “Pacific Standard Time”. Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.	string Optional
winRM	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.	WinRMConfiguration Optional

WindowsConfiguration_STATUS

Specifies Windows operating system settings on the virtual machine.

Used by: OSProfile_STATUS, and VirtualMachineScaleSetOSProfile_STATUS.

Property	Description	Type
additionalUnattendContent	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.	AdditionalUnattendContent_STATUS[] Optional
enableAutomaticUpdates	Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.	bool Optional
patchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Windows.	PatchSettings_STATUS Optional
provisionVMAgent	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.	bool Optional
timeZone	Specifies the time zone of the virtual machine. e.g. “Pacific Standard Time”. Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.	string Optional
winRM	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.	WinRMConfiguration_STATUS Optional

AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Used by: WindowsConfiguration.

Property	Description	Type
componentName	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.	AdditionalUnattendContent_ComponentName Optional
content	Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.	string Optional
passName	The pass name. Currently, the only allowable value is OobeSystem.	AdditionalUnattendContent_PassName Optional
settingName	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.	AdditionalUnattendContent_SettingName Optional

AdditionalUnattendContent_STATUS

Used by: WindowsConfiguration_STATUS.

Property	Description	Type
componentName	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.	AdditionalUnattendContent_ComponentName_STATUS Optional
content	Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.	string Optional
passName	The pass name. Currently, the only allowable value is OobeSystem.	AdditionalUnattendContent_PassName_STATUS Optional
settingName	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.	AdditionalUnattendContent_SettingName_STATUS Optional

ApiEntityReference

The API entity reference.

Used by: VirtualMachineScaleSetIPConfiguration, and VirtualMachineScaleSetNetworkProfile.

Property	Description	Type
reference	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…	genruntime.ResourceReference Optional

ApiEntityReference_STATUS

The API entity reference.

Used by: VirtualMachineScaleSetIPConfiguration_STATUS, and VirtualMachineScaleSetNetworkProfile_STATUS.

Property	Description	Type
id	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…	string Optional

AvailablePatchSummary_STATUS

Describes the properties of an virtual machine instance view for available patch summary.

Used by: VirtualMachinePatchStatus_STATUS.

Property	Description	Type
assessmentActivityId	The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.	string Optional
criticalAndSecurityPatchCount	The number of critical or security patches that have been detected as available and not yet installed.	int Optional
error	The errors that were encountered during execution of the operation. The details array contains the list of them.	ApiError_STATUS Optional
lastModifiedTime	The UTC timestamp when the operation began.	string Optional
otherPatchCount	The number of all available patches excluding critical and security.	int Optional
rebootPending	The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred.	bool Optional
startTime	The UTC timestamp when the operation began.	string Optional
status	The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Unknown”, “Failed”, “Succeeded”, or “CompletedWithWarnings.”	AvailablePatchSummary_Status_STATUS Optional

Caching

Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

Used by: DataDisk, OSDisk, VirtualMachineScaleSetDataDisk, and VirtualMachineScaleSetOSDisk.

Value	Description
“None”
“ReadOnly”
“ReadWrite”

Caching_STATUS

Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

Used by: DataDisk_STATUS, OSDisk_STATUS, VirtualMachineScaleSetDataDisk_STATUS, and VirtualMachineScaleSetOSDisk_STATUS.

Value	Description
“None”
“ReadOnly”
“ReadWrite”

CreateOption

Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

Used by: DataDisk, OSDisk, VirtualMachineScaleSetDataDisk, and VirtualMachineScaleSetOSDisk.

Value	Description
“Attach”
“Empty”
“FromImage”

CreateOption_STATUS

Used by: DataDisk_STATUS, OSDisk_STATUS, VirtualMachineScaleSetDataDisk_STATUS, and VirtualMachineScaleSetOSDisk_STATUS.

Value	Description
“Attach”
“Empty”
“FromImage”

DeleteOption

Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values: Delete If this value is used, the managed disk is deleted when VM gets deleted. Detach If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01

Used by: DataDisk, OSDisk, VirtualMachineScaleSetDataDisk, and VirtualMachineScaleSetOSDisk.

Value	Description
“Delete”
“Detach”

DeleteOption_STATUS

Used by: DataDisk_STATUS, OSDisk_STATUS, VirtualMachineScaleSetDataDisk_STATUS, and VirtualMachineScaleSetOSDisk_STATUS.

Value	Description
“Delete”
“Detach”

DetachOption

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to ’true’ along with setting detachOption: ‘ForceDetach’.

Used by: DataDisk.

Value	Description
“ForceDetach”

DetachOption_STATUS

Used by: DataDisk_STATUS.

Value	Description
“ForceDetach”

DiffDiskSettings

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

Used by: OSDisk, and VirtualMachineScaleSetOSDisk.

Property	Description	Type
option	Specifies the ephemeral disk settings for operating system disk.	DiffDiskOption Optional
placement	Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk ResourceDisk Default: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.	DiffDiskPlacement Optional

DiffDiskSettings_STATUS

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

Used by: OSDisk_STATUS, and VirtualMachineScaleSetOSDisk_STATUS.

Property	Description	Type
option	Specifies the ephemeral disk settings for operating system disk.	DiffDiskOption_STATUS Optional
placement	Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk ResourceDisk Default: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.	DiffDiskPlacement_STATUS Optional

DiskEncryptionSettings

Describes a Encryption Settings for a Disk

Used by: OSDisk.

Property	Description	Type
diskEncryptionKey	Specifies the location of the disk encryption key, which is a Key Vault Secret.	KeyVaultSecretReference Optional
enabled	Specifies whether disk encryption should be enabled on the virtual machine.	bool Optional
keyEncryptionKey	Specifies the location of the key encryption key in Key Vault.	KeyVaultKeyReference Optional

DiskEncryptionSettings_STATUS

Describes a Encryption Settings for a Disk

Used by: DiskInstanceView_STATUS, and OSDisk_STATUS.

Property	Description	Type
diskEncryptionKey	Specifies the location of the disk encryption key, which is a Key Vault Secret.	KeyVaultSecretReference_STATUS Optional
enabled	Specifies whether disk encryption should be enabled on the virtual machine.	bool Optional
keyEncryptionKey	Specifies the location of the key encryption key in Key Vault.	KeyVaultKeyReference_STATUS Optional

ImageDataDisk_Caching

Used by: ImageDataDisk.

Value	Description
“None”
“ReadOnly”
“ReadWrite”

ImageDataDisk_Caching_STATUS

Used by: ImageDataDisk_STATUS.

Value	Description
“None”
“ReadOnly”
“ReadWrite”

ImageOSDisk_Caching

Used by: ImageOSDisk.

Value	Description
“None”
“ReadOnly”
“ReadWrite”

ImageOSDisk_Caching_STATUS

Used by: ImageOSDisk_STATUS.

Value	Description
“None”
“ReadOnly”
“ReadWrite”

ImageOSDisk_OsState

Used by: ImageOSDisk.

Value	Description
“Generalized”
“Specialized”

ImageOSDisk_OsState_STATUS

Used by: ImageOSDisk_STATUS.

Value	Description
“Generalized”
“Specialized”

ImageOSDisk_OsType

Used by: ImageOSDisk.

Value	Description
“Linux”
“Windows”

ImageOSDisk_OsType_STATUS

Used by: ImageOSDisk_STATUS.

Value	Description
“Linux”
“Windows”

InstanceViewStatus_Level

Used by: InstanceViewStatus.

Value	Description
“Error”
“Info”
“Warning”

InstanceViewStatus_Level_STATUS

Used by: InstanceViewStatus_STATUS.

Value	Description
“Error”
“Info”
“Warning”

LastPatchInstallationSummary_STATUS

Describes the properties of the last installed patch summary.

Used by: VirtualMachinePatchStatus_STATUS.

Property	Description	Type
error	The errors that were encountered during execution of the operation. The details array contains the list of them.	ApiError_STATUS Optional
excludedPatchCount	The number of all available patches but excluded explicitly by a customer-specified exclusion list match.	int Optional
failedPatchCount	The count of patches that failed installation.	int Optional
installationActivityId	The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.	string Optional
installedPatchCount	The count of patches that successfully installed.	int Optional
lastModifiedTime	The UTC timestamp when the operation began.	string Optional
maintenanceWindowExceeded	Describes whether the operation ran out of time before it completed all its intended actions	bool Optional
notSelectedPatchCount	The number of all available patches but not going to be installed because it didn’t match a classification or inclusion list entry.	int Optional
pendingPatchCount	The number of all available patches expected to be installed over the course of the patch installation operation.	int Optional
startTime	The UTC timestamp when the operation began.	string Optional
status	The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Unknown”, “Failed”, “Succeeded”, or “CompletedWithWarnings.”	LastPatchInstallationSummary_Status_STATUS Optional

LinuxPatchSettings

Specifies settings related to VM Guest Patching on Linux.

Used by: LinuxConfiguration.

Property	Description	Type
assessmentMode	Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.	LinuxPatchSettings_AssessmentMode Optional
automaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.	LinuxVMGuestPatchAutomaticByPlatformSettings Optional
patchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine’s default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true	LinuxPatchSettings_PatchMode Optional

LinuxPatchSettings_STATUS

Specifies settings related to VM Guest Patching on Linux.

Used by: LinuxConfiguration_STATUS.

Property	Description	Type
assessmentMode	Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.	LinuxPatchSettings_AssessmentMode_STATUS Optional
automaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.	LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS Optional
patchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine’s default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true	LinuxPatchSettings_PatchMode_STATUS Optional

MaintenanceRedeployStatus_LastOperationResultCode_STATUS

Used by: MaintenanceRedeployStatus_STATUS.

Value	Description
“MaintenanceAborted”
“MaintenanceCompleted”
“None”
“RetryLater”

ManagedDiskParameters

The parameters of a managed disk.

Used by: DataDisk, and OSDisk.

Property	Description	Type
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	SubResource Optional
reference	Resource Id	genruntime.ResourceReference Optional
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType Optional

ManagedDiskParameters_STATUS

The parameters of a managed disk.

Used by: DataDisk_STATUS, and OSDisk_STATUS.

Property	Description	Type
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	SubResource_STATUS Optional
id	Resource Id	string Optional
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile_STATUS Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType_STATUS Optional

NetworkInterfaceReferenceProperties_DeleteOption

Used by: NetworkInterfaceReference.

Value	Description
“Delete”
“Detach”

NetworkInterfaceReferenceProperties_DeleteOption_STATUS

Used by: NetworkInterfaceReference_STATUS.

Value	Description
“Delete”
“Detach”

OSDisk_OsType

Used by: OSDisk.

Value	Description
“Linux”
“Windows”

OSDisk_OsType_STATUS

Used by: OSDisk_STATUS.

Value	Description
“Linux”
“Windows”

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

Used by: WindowsConfiguration.

Property	Description	Type
assessmentMode	Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.	PatchSettings_AssessmentMode Optional
automaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.	WindowsVMGuestPatchAutomaticByPlatformSettings Optional
enableHotpatching	Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the ‘provisionVMAgent’ must be set to true and ‘patchMode’ must be set to ‘AutomaticByPlatform’.	bool Optional
patchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true	PatchSettings_PatchMode Optional

PatchSettings_STATUS

Specifies settings related to VM Guest Patching on Windows.

Used by: WindowsConfiguration_STATUS.

Property	Description	Type
assessmentMode	Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.	PatchSettings_AssessmentMode_STATUS Optional
automaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.	WindowsVMGuestPatchAutomaticByPlatformSettings_STATUS Optional
enableHotpatching	Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the ‘provisionVMAgent’ must be set to true and ‘patchMode’ must be set to ‘AutomaticByPlatform’.	bool Optional
patchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true	PatchSettings_PatchMode_STATUS Optional

SshConfiguration

SSH configuration for Linux based VMs running on Azure

Used by: LinuxConfiguration.

Property	Description	Type
publicKeys	The list of SSH public keys used to authenticate with linux based VMs.	SshPublicKeySpec[] Optional

SshConfiguration_STATUS

SSH configuration for Linux based VMs running on Azure

Used by: LinuxConfiguration_STATUS.

Property	Description	Type
publicKeys	The list of SSH public keys used to authenticate with linux based VMs.	SshPublicKey_STATUS[] Optional

StorageAccountType

Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types

Used by: ImageDataDisk, ImageOSDisk, ManagedDiskParameters, and VirtualMachineScaleSetManagedDiskParameters.

Value	Description
“PremiumV2_LRS”
“Premium_LRS”
“Premium_ZRS”
“StandardSSD_LRS”
“StandardSSD_ZRS”
“Standard_LRS”
“UltraSSD_LRS”

StorageAccountType_STATUS

Used by: ImageDataDisk_STATUS, ImageOSDisk_STATUS, ManagedDiskParameters_STATUS, and VirtualMachineScaleSetManagedDiskParameters_STATUS.

Value	Description
“PremiumV2_LRS”
“Premium_LRS”
“Premium_ZRS”
“StandardSSD_LRS”
“StandardSSD_ZRS”
“Standard_LRS”
“UltraSSD_LRS”

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Used by: VaultSecretGroup.

Property	Description	Type
certificateStore	For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.	string Optional
certificateUrl	This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:"", “dataType”:“pfx”, “password”:"" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	string Optional

VaultCertificate_STATUS

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Used by: VaultSecretGroup_STATUS.

Property	Description	Type
certificateStore	For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.	string Optional
certificateUrl	This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:"", “dataType”:“pfx”, “password”:"" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	string Optional

VirtualHardDisk

Describes the uri of a disk.

Used by: DataDisk, DataDisk, OSDisk, OSDisk, and VirtualMachineScaleSetOSDisk.

Property	Description	Type
uri	Specifies the virtual hard disk’s uri.	string Optional

VirtualHardDisk_STATUS

Describes the uri of a disk.

Used by: DataDisk_STATUS, DataDisk_STATUS, OSDisk_STATUS, OSDisk_STATUS, and VirtualMachineScaleSetOSDisk_STATUS.

Property	Description	Type
uri	Specifies the virtual hard disk’s uri.	string Optional

VirtualMachineExtensionHandlerInstanceView_STATUS

The instance view of a virtual machine extension handler.

Used by: VirtualMachineAgentInstanceView_STATUS.

Property	Description	Type
status	The extension handler status.	InstanceViewStatus_STATUS Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption

Used by: VirtualMachineNetworkInterfaceConfiguration.

Value	Description
“Delete”
“Detach”

VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption_STATUS

Used by: VirtualMachineNetworkInterfaceConfiguration_STATUS.

Value	Description
“Delete”
“Detach”

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

Describes a virtual machines network configuration’s DNS settings.

Used by: VirtualMachineNetworkInterfaceConfiguration.

Property	Description	Type
dnsServers	List of DNS servers IP addresses	string[] Optional

VirtualMachineNetworkInterfaceDnsSettingsConfiguration_STATUS

Describes a virtual machines network configuration’s DNS settings.

Used by: VirtualMachineNetworkInterfaceConfiguration_STATUS.

Property	Description	Type
dnsServers	List of DNS servers IP addresses	string[] Optional

VirtualMachineNetworkInterfaceIPConfiguration

Describes a virtual machine network profile’s IP configuration.

Used by: VirtualMachineNetworkInterfaceConfiguration.

Property	Description	Type
applicationGatewayBackendAddressPools	Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.	SubResource[] Optional
applicationSecurityGroups	Specifies an array of references to application security group.	SubResource[] Optional
loadBalancerBackendAddressPools	Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].	SubResource[] Optional
name	The IP configuration name.	string Required
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional
privateIPAddressVersion	Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion Optional
publicIPAddressConfiguration	The publicIPAddressConfiguration.	VirtualMachinePublicIPAddressConfiguration Optional
subnet	Specifies the identifier of the subnet.	SubResource Optional

VirtualMachineNetworkInterfaceIPConfiguration_STATUS

Describes a virtual machine network profile’s IP configuration.

Used by: VirtualMachineNetworkInterfaceConfiguration_STATUS.

Property	Description	Type
applicationGatewayBackendAddressPools	Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.	SubResource_STATUS[] Optional
applicationSecurityGroups	Specifies an array of references to application security group.	SubResource_STATUS[] Optional
loadBalancerBackendAddressPools	Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].	SubResource_STATUS[] Optional
name	The IP configuration name.	string Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional
privateIPAddressVersion	Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion_STATUS Optional
publicIPAddressConfiguration	The publicIPAddressConfiguration.	VirtualMachinePublicIPAddressConfiguration_STATUS Optional
subnet	Specifies the identifier of the subnet.	SubResource_STATUS Optional

VirtualMachineScaleSetDataDisk

Describes a virtual machine scale set data disk.

Used by: VirtualMachineScaleSetStorageProfile.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	Caching Optional
createOption	The create option.	CreateOption Required
deleteOption	Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.	DeleteOption Optional
diskIOPSReadWrite	Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.	int Optional
diskMBpsReadWrite	Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.	int Optional
diskSizeGB	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
lun	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.	int Required
managedDisk	The managed disk parameters.	VirtualMachineScaleSetManagedDiskParameters Optional
name	The disk name.	string Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

VirtualMachineScaleSetDataDisk_STATUS

Describes a virtual machine scale set data disk.

Used by: VirtualMachineScaleSetStorageProfile_STATUS.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	Caching_STATUS Optional
createOption	The create option.	CreateOption_STATUS Optional
deleteOption	Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.	DeleteOption_STATUS Optional
diskIOPSReadWrite	Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.	int Optional
diskMBpsReadWrite	Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.	int Optional
diskSizeGB	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
lun	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.	int Optional
managedDisk	The managed disk parameters.	VirtualMachineScaleSetManagedDiskParameters_STATUS Optional
name	The disk name.	string Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

VirtualMachineScaleSetExtension

Describes a Virtual Machine Scale Set Extension.

Used by: VirtualMachineScaleSetExtensionProfile.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.	string Optional
name	The name of the extension.	string Optional
protectedSettings	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.	genruntime.SecretMapReference Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference Optional
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[] Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineScaleSetExtension_STATUS

Describes a Virtual Machine Scale Set Extension.

Used by: VirtualMachineScaleSetExtensionProfile_STATUS.

Property	Description	Type
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.	bool Optional
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.	bool Optional
forceUpdateTag	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.	string Optional
id	Resource Id	string Optional
name	The name of the extension.	string Optional
properties_type	Specifies the type of the extension; an example is “CustomScriptExtension”.	string Optional
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference_STATUS Optional
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[] Optional
provisioningState	The provisioning state, which only appears in the response.	string Optional
publisher	The name of the extension handler publisher.	string Optional
settings	Json formatted public settings for the extension.	map[string]v1.JSON Optional
suppressFailures	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.	bool Optional
type	Resource type	string Optional
typeHandlerVersion	Specifies the version of the script handler.	string Optional

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile’s network configurations.

Used by: VirtualMachineScaleSetNetworkProfile.

Property	Description	Type
deleteOption	Specify what happens to the network interface when the VM is deleted	VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption Optional
dnsSettings	The dns settings to be applied on the network interfaces.	VirtualMachineScaleSetNetworkConfigurationDnsSettings Optional
enableAcceleratedNetworking	Specifies whether the network interface is accelerated networking-enabled.	bool Optional
enableFpga	Specifies whether the network interface is FPGA networking-enabled.	bool Optional
enableIPForwarding	Whether IP forwarding enabled on this NIC.	bool Optional
ipConfigurations	Specifies the IP configurations of the network interface.	VirtualMachineScaleSetIPConfiguration[] Required
name	The network configuration name.	string Required
networkSecurityGroup	The network security group.	SubResource Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional
reference	Resource Id	genruntime.ResourceReference Optional

VirtualMachineScaleSetNetworkConfiguration_STATUS

Describes a virtual machine scale set network profile’s network configurations.

Used by: VirtualMachineScaleSetNetworkProfile_STATUS.

Property	Description	Type
deleteOption	Specify what happens to the network interface when the VM is deleted	VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption_STATUS Optional
dnsSettings	The dns settings to be applied on the network interfaces.	VirtualMachineScaleSetNetworkConfigurationDnsSettings_STATUS Optional
enableAcceleratedNetworking	Specifies whether the network interface is accelerated networking-enabled.	bool Optional
enableFpga	Specifies whether the network interface is FPGA networking-enabled.	bool Optional
enableIPForwarding	Whether IP forwarding enabled on this NIC.	bool Optional
id	Resource Id	string Optional
ipConfigurations	Specifies the IP configurations of the network interface.	VirtualMachineScaleSetIPConfiguration_STATUS[] Optional
name	The network configuration name.	string Optional
networkSecurityGroup	The network security group.	SubResource_STATUS Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional

VirtualMachineScaleSetNetworkProfile_NetworkApiVersion

Used by: VirtualMachineScaleSetNetworkProfile.

Value	Description
“2020-11-01”

VirtualMachineScaleSetNetworkProfile_NetworkApiVersion_STATUS

Used by: VirtualMachineScaleSetNetworkProfile_STATUS.

Value	Description
“2020-11-01”

VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

Used by: VirtualMachineScaleSetStorageProfile.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	Caching Optional
createOption	Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.	CreateOption Required
deleteOption	Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.	DeleteOption Optional
diffDiskSettings	Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.	DiffDiskSettings Optional
diskSizeGB	Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
image	Specifies information about the unmanaged user image to base the scale set on.	VirtualHardDisk Optional
managedDisk	The managed disk parameters.	VirtualMachineScaleSetManagedDiskParameters Optional
name	The disk name.	string Optional
osType	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows Linux	VirtualMachineScaleSetOSDisk_OsType Optional
vhdContainers	Specifies the container urls that are used to store operating system disks for the scale set.	string[] Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

VirtualMachineScaleSetOSDisk_STATUS

Describes a virtual machine scale set operating system disk.

Used by: VirtualMachineScaleSetStorageProfile_STATUS.

Property	Description	Type
caching	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage	Caching_STATUS Optional
createOption	Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.	CreateOption_STATUS Optional
deleteOption	Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.	DeleteOption_STATUS Optional
diffDiskSettings	Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.	DiffDiskSettings_STATUS Optional
diskSizeGB	Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB	int Optional
image	Specifies information about the unmanaged user image to base the scale set on.	VirtualHardDisk_STATUS Optional
managedDisk	The managed disk parameters.	VirtualMachineScaleSetManagedDiskParameters_STATUS Optional
name	The disk name.	string Optional
osType	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows Linux	VirtualMachineScaleSetOSDisk_OsType_STATUS Optional
vhdContainers	Specifies the container urls that are used to store operating system disks for the scale set.	string[] Optional
writeAcceleratorEnabled	Specifies whether writeAccelerator should be enabled or disabled on the disk.	bool Optional

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

Used by: WindowsConfiguration.

Property	Description	Type
listeners	The list of Windows Remote Management listeners	WinRMListener[] Optional

WinRMConfiguration_STATUS

Describes Windows Remote Management configuration of the VM

Used by: WindowsConfiguration_STATUS.

Property	Description	Type
listeners	The list of Windows Remote Management listeners	WinRMListener_STATUS[] Optional

AdditionalUnattendContent_ComponentName

Used by: AdditionalUnattendContent.

Value	Description
“Microsoft-Windows-Shell-Setup”

AdditionalUnattendContent_ComponentName_STATUS

Used by: AdditionalUnattendContent_STATUS.

Value	Description
“Microsoft-Windows-Shell-Setup”

AdditionalUnattendContent_PassName

Used by: AdditionalUnattendContent.

Value	Description
“OobeSystem”

AdditionalUnattendContent_PassName_STATUS

Used by: AdditionalUnattendContent_STATUS.

Value	Description
“OobeSystem”

AdditionalUnattendContent_SettingName

Used by: AdditionalUnattendContent.

Value	Description
“AutoLogon”
“FirstLogonCommands”

AdditionalUnattendContent_SettingName_STATUS

Used by: AdditionalUnattendContent_STATUS.

Value	Description
“AutoLogon”
“FirstLogonCommands”

ApiError_STATUS

Api error.

Used by: AvailablePatchSummary_STATUS, and LastPatchInstallationSummary_STATUS.

Property	Description	Type
code	The error code.	string Optional
details	The Api error details	ApiErrorBase_STATUS[] Optional
innererror	The Api inner error	InnerError_STATUS Optional
message	The error message.	string Optional
target	The target of the particular error.	string Optional

AvailablePatchSummary_Status_STATUS

Used by: AvailablePatchSummary_STATUS.

Value	Description
“CompletedWithWarnings”
“Failed”
“InProgress”
“Succeeded”
“Unknown”

DiffDiskOption

Specifies the ephemeral disk option for operating system disk.

Used by: DiffDiskSettings.

Value	Description
“Local”

DiffDiskOption_STATUS

Specifies the ephemeral disk option for operating system disk.

Used by: DiffDiskSettings_STATUS.

Value	Description
“Local”

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Used by: DiffDiskSettings.

Value	Description
“CacheDisk”
“ResourceDisk”

DiffDiskPlacement_STATUS

Used by: DiffDiskSettings_STATUS.

Value	Description
“CacheDisk”
“ResourceDisk”

KeyVaultKeyReference

Describes a reference to Key Vault Key

Used by: DiskEncryptionSettings.

Property	Description	Type
keyUrl	The URL referencing a key encryption key in Key Vault.	string Required
sourceVault	The relative URL of the Key Vault containing the key.	SubResource Required

KeyVaultKeyReference_STATUS

Describes a reference to Key Vault Key

Used by: DiskEncryptionSettings_STATUS.

Property	Description	Type
keyUrl	The URL referencing a key encryption key in Key Vault.	string Optional
sourceVault	The relative URL of the Key Vault containing the key.	SubResource_STATUS Optional

LastPatchInstallationSummary_Status_STATUS

Used by: LastPatchInstallationSummary_STATUS.

Value	Description
“CompletedWithWarnings”
“Failed”
“InProgress”
“Succeeded”
“Unknown”

LinuxPatchSettings_AssessmentMode

Used by: LinuxPatchSettings.

Value	Description
“AutomaticByPlatform”
“ImageDefault”

LinuxPatchSettings_AssessmentMode_STATUS

Used by: LinuxPatchSettings_STATUS.

Value	Description
“AutomaticByPlatform”
“ImageDefault”

LinuxPatchSettings_PatchMode

Used by: LinuxPatchSettings.

Value	Description
“AutomaticByPlatform”
“ImageDefault”

LinuxPatchSettings_PatchMode_STATUS

Used by: LinuxPatchSettings_STATUS.

Value	Description
“AutomaticByPlatform”
“ImageDefault”

LinuxVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Used by: LinuxPatchSettings.

Property	Description	Type
rebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.	LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting Optional

LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Used by: LinuxPatchSettings_STATUS.

Property	Description	Type
rebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.	LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS Optional

PatchSettings_AssessmentMode

Used by: PatchSettings.

Value	Description
“AutomaticByPlatform”
“ImageDefault”

PatchSettings_AssessmentMode_STATUS

Used by: PatchSettings_STATUS.

Value	Description
“AutomaticByPlatform”
“ImageDefault”

PatchSettings_PatchMode

Used by: PatchSettings.

Value	Description
“AutomaticByOS”
“AutomaticByPlatform”
“Manual”

PatchSettings_PatchMode_STATUS

Used by: PatchSettings_STATUS.

Value	Description
“AutomaticByOS”
“AutomaticByPlatform”
“Manual”

SshPublicKey_STATUS

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Used by: SshConfiguration_STATUS.

Property	Description	Type
keyData	SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).	string Optional
path	Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys	string Optional

SshPublicKeySpec

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Used by: SshConfiguration.

Property	Description	Type
keyData	SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).	string Optional
path	Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys	string Optional

VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion

Used by: VirtualMachineNetworkInterfaceIPConfiguration.

Value	Description
“IPv4”
“IPv6”

VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion_STATUS

Used by: VirtualMachineNetworkInterfaceIPConfiguration_STATUS.

Value	Description
“IPv4”
“IPv6”

VirtualMachinePublicIPAddressConfiguration

Describes a virtual machines IP Configuration’s PublicIPAddress configuration

Used by: VirtualMachineNetworkInterfaceIPConfiguration.

Property	Description	Type
deleteOption	Specify what happens to the public IP address when the VM is deleted	VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption Optional
dnsSettings	The dns settings to be applied on the publicIP addresses .	VirtualMachinePublicIPAddressDnsSettingsConfiguration Optional
idleTimeoutInMinutes	The idle timeout of the public IP address.	int Optional
ipTags	The list of IP tags associated with the public IP address.	VirtualMachineIpTag[] Optional
name	The publicIP address configuration name.	string Required
publicIPAddressVersion	Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion Optional
publicIPAllocationMethod	Specify the public IP allocation type	VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod Optional
publicIPPrefix	The PublicIPPrefix from which to allocate publicIP addresses.	SubResource Optional
sku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.	PublicIPAddressSku Optional

VirtualMachinePublicIPAddressConfiguration_STATUS

Describes a virtual machines IP Configuration’s PublicIPAddress configuration

Used by: VirtualMachineNetworkInterfaceIPConfiguration_STATUS.

Property	Description	Type
deleteOption	Specify what happens to the public IP address when the VM is deleted	VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption_STATUS Optional
dnsSettings	The dns settings to be applied on the publicIP addresses .	VirtualMachinePublicIPAddressDnsSettingsConfiguration_STATUS Optional
idleTimeoutInMinutes	The idle timeout of the public IP address.	int Optional
ipTags	The list of IP tags associated with the public IP address.	VirtualMachineIpTag_STATUS[] Optional
name	The publicIP address configuration name.	string Optional
publicIPAddressVersion	Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS Optional
publicIPAllocationMethod	Specify the public IP allocation type	VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod_STATUS Optional
publicIPPrefix	The PublicIPPrefix from which to allocate publicIP addresses.	SubResource_STATUS Optional
sku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.	PublicIPAddressSku_STATUS Optional

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile’s IP configuration.

Used by: VirtualMachineScaleSetNetworkConfiguration.

Property	Description	Type
applicationGatewayBackendAddressPools	Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.	SubResource[] Optional
applicationSecurityGroups	Specifies an array of references to application security group.	SubResource[] Optional
loadBalancerBackendAddressPools	Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.	SubResource[] Optional
loadBalancerInboundNatPools	Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.	SubResource[] Optional
name	The IP configuration name.	string Required
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional
privateIPAddressVersion	Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion Optional
publicIPAddressConfiguration	The publicIPAddressConfiguration.	VirtualMachineScaleSetPublicIPAddressConfiguration Optional
reference	Resource Id	genruntime.ResourceReference Optional
subnet	Specifies the identifier of the subnet.	ApiEntityReference Optional

VirtualMachineScaleSetIPConfiguration_STATUS

Describes a virtual machine scale set network profile’s IP configuration.

Used by: VirtualMachineScaleSetNetworkConfiguration_STATUS.

Property	Description	Type
applicationGatewayBackendAddressPools	Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.	SubResource_STATUS[] Optional
applicationSecurityGroups	Specifies an array of references to application security group.	SubResource_STATUS[] Optional
id	Resource Id	string Optional
loadBalancerBackendAddressPools	Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.	SubResource_STATUS[] Optional
loadBalancerInboundNatPools	Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.	SubResource_STATUS[] Optional
name	The IP configuration name.	string Optional
primary	Specifies the primary network interface in case the virtual machine has more than 1 network interface.	bool Optional
privateIPAddressVersion	Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion_STATUS Optional
publicIPAddressConfiguration	The publicIPAddressConfiguration.	VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS Optional
subnet	Specifies the identifier of the subnet.	ApiEntityReference_STATUS Optional

VirtualMachineScaleSetManagedDiskParameters

Describes the parameters of a ScaleSet managed disk.

Used by: VirtualMachineScaleSetDataDisk, and VirtualMachineScaleSetOSDisk.

Property	Description	Type
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	SubResource Optional
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType Optional

VirtualMachineScaleSetManagedDiskParameters_STATUS

Describes the parameters of a ScaleSet managed disk.

Used by: VirtualMachineScaleSetDataDisk_STATUS, and VirtualMachineScaleSetOSDisk_STATUS.

Property	Description	Type
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk.	SubResource_STATUS Optional
securityProfile	Specifies the security profile for the managed disk.	VMDiskSecurityProfile_STATUS Optional
storageAccountType	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.	StorageAccountType_STATUS Optional

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Describes a virtual machines scale sets network configuration’s DNS settings.

Used by: VirtualMachineScaleSetNetworkConfiguration.

Property	Description	Type
dnsServers	List of DNS servers IP addresses	string[] Optional

VirtualMachineScaleSetNetworkConfigurationDnsSettings_STATUS

Describes a virtual machines scale sets network configuration’s DNS settings.

Used by: VirtualMachineScaleSetNetworkConfiguration_STATUS.

Property	Description	Type
dnsServers	List of DNS servers IP addresses	string[] Optional

VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption

Used by: VirtualMachineScaleSetNetworkConfiguration.

Value	Description
“Delete”
“Detach”

VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption_STATUS

Used by: VirtualMachineScaleSetNetworkConfiguration_STATUS.

Value	Description
“Delete”
“Detach”

VirtualMachineScaleSetOSDisk_OsType

Used by: VirtualMachineScaleSetOSDisk.

Value	Description
“Linux”
“Windows”

VirtualMachineScaleSetOSDisk_OsType_STATUS

Used by: VirtualMachineScaleSetOSDisk_STATUS.

Value	Description
“Linux”
“Windows”

VMDiskSecurityProfile

Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs

Used by: ManagedDiskParameters, and VirtualMachineScaleSetManagedDiskParameters.

Property	Description	Type
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.	SubResource Optional
securityEncryptionType	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.	VMDiskSecurityProfile_SecurityEncryptionType Optional

VMDiskSecurityProfile_STATUS

Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs

Used by: ManagedDiskParameters_STATUS, and VirtualMachineScaleSetManagedDiskParameters_STATUS.

Property	Description	Type
diskEncryptionSet	Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.	SubResource_STATUS Optional
securityEncryptionType	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.	VMDiskSecurityProfile_SecurityEncryptionType_STATUS Optional

WindowsVMGuestPatchAutomaticByPlatformSettings

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

Used by: PatchSettings.

Property	Description	Type
rebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.	WindowsVMGuestPatchAutomaticByPlatformSettings_RebootSetting Optional

WindowsVMGuestPatchAutomaticByPlatformSettings_STATUS

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

Used by: PatchSettings_STATUS.

Property	Description	Type
rebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.	WindowsVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS Optional

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

Used by: WinRMConfiguration.

Property	Description	Type
certificateUrl	This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:"", “dataType”:“pfx”, “password”:"" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	string Optional
protocol	Specifies the protocol of WinRM listener. Possible values are: http https	WinRMListener_Protocol Optional

WinRMListener_STATUS

Describes Protocol and thumbprint of Windows Remote Management listener

Used by: WinRMConfiguration_STATUS.

Property	Description	Type
certificateUrl	This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:"", “dataType”:“pfx”, “password”:"" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.	string Optional
protocol	Specifies the protocol of WinRM listener. Possible values are: http https	WinRMListener_Protocol_STATUS Optional

ApiErrorBase_STATUS

Api error base.

Used by: ApiError_STATUS.

Property	Description	Type
code	The error code.	string Optional
message	The error message.	string Optional
target	The target of the particular error.	string Optional

InnerError_STATUS

Inner error details.

Used by: ApiError_STATUS.

Property	Description	Type
errordetail	The internal error message or exception dump.	string Optional
exceptiontype	The exception type.	string Optional

LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting

Used by: LinuxVMGuestPatchAutomaticByPlatformSettings.

Value	Description
“Always”
“IfRequired”
“Never”
“Unknown”

LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS

Used by: LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS.

Value	Description
“Always”
“IfRequired”
“Never”
“Unknown”

PublicIPAddressSku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Used by: VirtualMachinePublicIPAddressConfiguration, and VirtualMachineScaleSetPublicIPAddressConfiguration.

Property	Description	Type
name	Specify public IP sku name	PublicIPAddressSku_Name Optional
tier	Specify public IP sku tier	PublicIPAddressSku_Tier Optional

PublicIPAddressSku_STATUS

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Used by: VirtualMachinePublicIPAddressConfiguration_STATUS, and VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS.

Property	Description	Type
name	Specify public IP sku name	PublicIPAddressSku_Name_STATUS Optional
tier	Specify public IP sku tier	PublicIPAddressSku_Tier_STATUS Optional

VirtualMachineIpTag

Contains the IP tag associated with the public IP address.

Used by: VirtualMachinePublicIPAddressConfiguration.

Property	Description	Type
ipTagType	IP tag type. Example: FirstPartyUsage.	string Optional
tag	IP tag associated with the public IP. Example: SQL, Storage etc.	string Optional

VirtualMachineIpTag_STATUS

Contains the IP tag associated with the public IP address.

Used by: VirtualMachinePublicIPAddressConfiguration_STATUS.

Property	Description	Type
ipTagType	IP tag type. Example: FirstPartyUsage.	string Optional
tag	IP tag associated with the public IP. Example: SQL, Storage etc.	string Optional

VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption

Used by: VirtualMachinePublicIPAddressConfiguration.

Value	Description
“Delete”
“Detach”

VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption_STATUS

Used by: VirtualMachinePublicIPAddressConfiguration_STATUS.

Value	Description
“Delete”
“Detach”

VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion

Used by: VirtualMachinePublicIPAddressConfiguration.

Value	Description
“IPv4”
“IPv6”

VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS

Used by: VirtualMachinePublicIPAddressConfiguration_STATUS.

Value	Description
“IPv4”
“IPv6”

VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod

Used by: VirtualMachinePublicIPAddressConfiguration.

Value	Description
“Dynamic”
“Static”

VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod_STATUS

Used by: VirtualMachinePublicIPAddressConfiguration_STATUS.

Value	Description
“Dynamic”
“Static”

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Describes a virtual machines network configuration’s DNS settings.

Used by: VirtualMachinePublicIPAddressConfiguration.

Property	Description	Type
domainNameLabel	The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.	string Required

VirtualMachinePublicIPAddressDnsSettingsConfiguration_STATUS

Describes a virtual machines network configuration’s DNS settings.

Used by: VirtualMachinePublicIPAddressConfiguration_STATUS.

Property	Description	Type
domainNameLabel	The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.	string Optional

VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion

Used by: VirtualMachineScaleSetIPConfiguration.

Value	Description
“IPv4”
“IPv6”

VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion_STATUS

Used by: VirtualMachineScaleSetIPConfiguration_STATUS.

Value	Description
“IPv4”
“IPv6”

VirtualMachineScaleSetPublicIPAddressConfiguration

Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration

Used by: VirtualMachineScaleSetIPConfiguration.

Property	Description	Type
deleteOption	Specify what happens to the public IP when the VM is deleted	VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption Optional
dnsSettings	The dns settings to be applied on the publicIP addresses .	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings Optional
idleTimeoutInMinutes	The idle timeout of the public IP address.	int Optional
ipTags	The list of IP tags associated with the public IP address.	VirtualMachineScaleSetIpTag[] Optional
name	The publicIP address configuration name.	string Required
publicIPAddressVersion	Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion Optional
publicIPPrefix	The PublicIPPrefix from which to allocate publicIP addresses.	SubResource Optional
sku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.	PublicIPAddressSku Optional

VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS

Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration

Used by: VirtualMachineScaleSetIPConfiguration_STATUS.

Property	Description	Type
deleteOption	Specify what happens to the public IP when the VM is deleted	VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption_STATUS Optional
dnsSettings	The dns settings to be applied on the publicIP addresses .	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_STATUS Optional
idleTimeoutInMinutes	The idle timeout of the public IP address.	int Optional
ipTags	The list of IP tags associated with the public IP address.	VirtualMachineScaleSetIpTag_STATUS[] Optional
name	The publicIP address configuration name.	string Optional
publicIPAddressVersion	Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: ‘IPv4’ and ‘IPv6’.	VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS Optional
publicIPPrefix	The PublicIPPrefix from which to allocate publicIP addresses.	SubResource_STATUS Optional
sku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.	PublicIPAddressSku_STATUS Optional

VMDiskSecurityProfile_SecurityEncryptionType

Used by: VMDiskSecurityProfile.

Value	Description
“DiskWithVMGuestState”
“VMGuestStateOnly”

VMDiskSecurityProfile_SecurityEncryptionType_STATUS

Used by: VMDiskSecurityProfile_STATUS.

Value	Description
“DiskWithVMGuestState”
“VMGuestStateOnly”

WindowsVMGuestPatchAutomaticByPlatformSettings_RebootSetting

Used by: WindowsVMGuestPatchAutomaticByPlatformSettings.

Value	Description
“Always”
“IfRequired”
“Never”
“Unknown”

WindowsVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS

Used by: WindowsVMGuestPatchAutomaticByPlatformSettings_STATUS.

Value	Description
“Always”
“IfRequired”
“Never”
“Unknown”

WinRMListener_Protocol

Used by: WinRMListener.

Value	Description
“Http”
“Https”

WinRMListener_Protocol_STATUS

Used by: WinRMListener_STATUS.

Value	Description
“Http”
“Https”

PublicIPAddressSku_Name

Used by: PublicIPAddressSku.

Value	Description
“Basic”
“Standard”

PublicIPAddressSku_Name_STATUS

Used by: PublicIPAddressSku_STATUS.

Value	Description
“Basic”
“Standard”

PublicIPAddressSku_Tier

Used by: PublicIPAddressSku.

Value	Description
“Global”
“Regional”

PublicIPAddressSku_Tier_STATUS

Used by: PublicIPAddressSku_STATUS.

Value	Description
“Global”
“Regional”

VirtualMachineScaleSetIpTag

Contains the IP tag associated with the public IP address.

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration.

Property	Description	Type
ipTagType	IP tag type. Example: FirstPartyUsage.	string Optional
tag	IP tag associated with the public IP. Example: SQL, Storage etc.	string Optional

VirtualMachineScaleSetIpTag_STATUS

Contains the IP tag associated with the public IP address.

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS.

Property	Description	Type
ipTagType	IP tag type. Example: FirstPartyUsage.	string Optional
tag	IP tag associated with the public IP. Example: SQL, Storage etc.	string Optional

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Describes a virtual machines scale sets network configuration’s DNS settings.

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration.

Property	Description	Type
domainNameLabel	The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created	string Required

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_STATUS

Describes a virtual machines scale sets network configuration’s DNS settings.

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS.

Property	Description	Type
domainNameLabel	The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created	string Optional

VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration.

Value	Description
“Delete”
“Detach”

VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption_STATUS

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS.

Value	Description
“Delete”
“Detach”

VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration.

Value	Description
“IPv4”
“IPv6”

VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS

Used by: VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS.

Value	Description
“IPv4”
“IPv6”