compute.azure.com/v1beta20201201

compute.azure.com/v1beta20201201

Package v1beta20201201 contains API Schema definitions for the compute v1beta20201201 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2020-12-01"

    AdditionalCapabilities

    (Appears on:VirtualMachineScaleSets_Spec, VirtualMachines_Spec)

    Field Description
    ultraSSDEnabled
    bool

    UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

    AdditionalCapabilitiesARM

    (Appears on:VirtualMachineScaleSets_Spec_PropertiesARM, VirtualMachines_Spec_PropertiesARM)

    Field Description
    ultraSSDEnabled
    bool

    UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

    AdditionalCapabilities_Status

    (Appears on:VirtualMachineScaleSet_Status, VirtualMachine_Status)

    Field Description
    ultraSSDEnabled
    bool

    UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

    AdditionalCapabilities_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM, VirtualMachineScaleSetProperties_StatusARM)

    Field Description
    ultraSSDEnabled
    bool

    UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

    AdditionalUnattendContent

    (Appears on:WindowsConfiguration)

    Field Description
    componentName
    AdditionalUnattendContentComponentName

    ComponentName: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

    content
    string

    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.

    passName
    AdditionalUnattendContentPassName

    PassName: The pass name. Currently, the only allowable value is OobeSystem.

    settingName
    AdditionalUnattendContentSettingName

    SettingName: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

    AdditionalUnattendContentARM

    (Appears on:WindowsConfigurationARM)

    Field Description
    componentName
    AdditionalUnattendContentComponentName

    ComponentName: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

    content
    string

    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.

    passName
    AdditionalUnattendContentPassName

    PassName: The pass name. Currently, the only allowable value is OobeSystem.

    settingName
    AdditionalUnattendContentSettingName

    SettingName: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

    AdditionalUnattendContentComponentName (string alias)

    (Appears on:AdditionalUnattendContent, AdditionalUnattendContentARM)

    Value Description

    "Microsoft-Windows-Shell-Setup"

    AdditionalUnattendContentPassName (string alias)

    (Appears on:AdditionalUnattendContent, AdditionalUnattendContentARM)

    Value Description

    "OobeSystem"

    AdditionalUnattendContentSettingName (string alias)

    (Appears on:AdditionalUnattendContent, AdditionalUnattendContentARM)

    Value Description

    "AutoLogon"

    "FirstLogonCommands"

    AdditionalUnattendContentStatusComponentName (string alias)

    (Appears on:AdditionalUnattendContent_Status, AdditionalUnattendContent_StatusARM)

    Value Description

    "Microsoft-Windows-Shell-Setup"

    AdditionalUnattendContentStatusPassName (string alias)

    (Appears on:AdditionalUnattendContent_Status, AdditionalUnattendContent_StatusARM)

    Value Description

    "OobeSystem"

    AdditionalUnattendContentStatusSettingName (string alias)

    (Appears on:AdditionalUnattendContent_Status, AdditionalUnattendContent_StatusARM)

    Value Description

    "AutoLogon"

    "FirstLogonCommands"

    AdditionalUnattendContent_Status

    (Appears on:WindowsConfiguration_Status)

    Field Description
    componentName
    AdditionalUnattendContentStatusComponentName

    ComponentName: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

    content
    string

    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.

    passName
    AdditionalUnattendContentStatusPassName

    PassName: The pass name. Currently, the only allowable value is OobeSystem.

    settingName
    AdditionalUnattendContentStatusSettingName

    SettingName: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

    AdditionalUnattendContent_StatusARM

    (Appears on:WindowsConfiguration_StatusARM)

    Field Description
    componentName
    AdditionalUnattendContentStatusComponentName

    ComponentName: The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

    content
    string

    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.

    passName
    AdditionalUnattendContentStatusPassName

    PassName: The pass name. Currently, the only allowable value is OobeSystem.

    settingName
    AdditionalUnattendContentStatusSettingName

    SettingName: Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

    ApiEntityReference

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: The ARM resource id in the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​…

    ApiEntityReferenceARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfileARM, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_PropertiesARM)

    Field Description
    id
    string

    ApiEntityReference_Status

    (Appears on:VirtualMachineScaleSetIPConfiguration_Status, VirtualMachineScaleSetNetworkProfile_Status)

    Field Description
    id
    string

    Id: The ARM resource id in the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​…

    ApiEntityReference_StatusARM

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_StatusARM, VirtualMachineScaleSetNetworkProfile_StatusARM)

    Field Description
    id
    string

    Id: The ARM resource id in the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​…

    ApiErrorBase_Status

    (Appears on:ApiError_Status)

    Field Description
    code
    string

    Code: The error code.

    message
    string

    Message: The error message.

    target
    string

    Target: The target of the particular error.

    ApiErrorBase_StatusARM

    (Appears on:ApiError_StatusARM)

    Field Description
    code
    string

    Code: The error code.

    message
    string

    Message: The error message.

    target
    string

    Target: The target of the particular error.

    ApiError_Status

    (Appears on:AvailablePatchSummary_Status, LastPatchInstallationSummary_Status)

    Field Description
    code
    string

    Code: The error code.

    details
    []ApiErrorBase_Status

    Details: The Api error details

    innererror
    InnerError_Status

    Innererror: The Api inner error

    message
    string

    Message: The error message.

    target
    string

    Target: The target of the particular error.

    ApiError_StatusARM

    (Appears on:AvailablePatchSummary_StatusARM, LastPatchInstallationSummary_StatusARM)

    Field Description
    code
    string

    Code: The error code.

    details
    []ApiErrorBase_StatusARM

    Details: The Api error details

    innererror
    InnerError_StatusARM

    Innererror: The Api inner error

    message
    string

    Message: The error message.

    target
    string

    Target: The target of the particular error.

    AutomaticOSUpgradePolicy

    (Appears on:UpgradePolicy)

    Field Description
    disableAutomaticRollback
    bool

    DisableAutomaticRollback: Whether OS image rollback feature should be disabled. Default value is false.

    enableAutomaticOSUpgrade
    bool

    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.

    AutomaticOSUpgradePolicyARM

    (Appears on:UpgradePolicyARM)

    Field Description
    disableAutomaticRollback
    bool

    DisableAutomaticRollback: Whether OS image rollback feature should be disabled. Default value is false.

    enableAutomaticOSUpgrade
    bool

    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.

    AutomaticOSUpgradePolicy_Status

    (Appears on:UpgradePolicy_Status)

    Field Description
    disableAutomaticRollback
    bool

    DisableAutomaticRollback: Whether OS image rollback feature should be disabled. Default value is false.

    enableAutomaticOSUpgrade
    bool

    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.

    AutomaticOSUpgradePolicy_StatusARM

    (Appears on:UpgradePolicy_StatusARM)

    Field Description
    disableAutomaticRollback
    bool

    DisableAutomaticRollback: Whether OS image rollback feature should be disabled. Default value is false.

    enableAutomaticOSUpgrade
    bool

    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.

    AutomaticRepairsPolicy

    (Appears on:VirtualMachineScaleSets_Spec)

    Field Description
    enabled
    bool

    Enabled: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.

    gracePeriod
    string

    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 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

    AutomaticRepairsPolicyARM

    (Appears on:VirtualMachineScaleSets_Spec_PropertiesARM)

    Field Description
    enabled
    bool

    Enabled: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.

    gracePeriod
    string

    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 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

    AutomaticRepairsPolicy_Status

    (Appears on:VirtualMachineScaleSet_Status)

    Field Description
    enabled
    bool

    Enabled: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.

    gracePeriod
    string

    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 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

    AutomaticRepairsPolicy_StatusARM

    (Appears on:VirtualMachineScaleSetProperties_StatusARM)

    Field Description
    enabled
    bool

    Enabled: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.

    gracePeriod
    string

    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 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

    AvailablePatchSummaryStatusStatus (string alias)

    (Appears on:AvailablePatchSummary_Status, AvailablePatchSummary_StatusARM)

    Value Description

    "CompletedWithWarnings"

    "Failed"

    "InProgress"

    "Succeeded"

    "Unknown"

    AvailablePatchSummary_Status

    (Appears on:VirtualMachinePatchStatus_Status)

    Field Description
    assessmentActivityId
    string

    AssessmentActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.

    criticalAndSecurityPatchCount
    int

    CriticalAndSecurityPatchCount: The number of critical or security patches that have been detected as available and not yet installed.

    error
    ApiError_Status

    Error: The errors that were encountered during execution of the operation. The details array contains the list of them.

    lastModifiedTime
    string

    LastModifiedTime: The UTC timestamp when the operation began.

    otherPatchCount
    int

    OtherPatchCount: The number of all available patches excluding critical and security.

    rebootPending
    bool

    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.

    startTime
    string

    StartTime: The UTC timestamp when the operation began.

    status
    AvailablePatchSummaryStatusStatus

    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_StatusARM

    (Appears on:VirtualMachinePatchStatus_StatusARM)

    Field Description
    assessmentActivityId
    string

    AssessmentActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.

    criticalAndSecurityPatchCount
    int

    CriticalAndSecurityPatchCount: The number of critical or security patches that have been detected as available and not yet installed.

    error
    ApiError_StatusARM

    Error: The errors that were encountered during execution of the operation. The details array contains the list of them.

    lastModifiedTime
    string

    LastModifiedTime: The UTC timestamp when the operation began.

    otherPatchCount
    int

    OtherPatchCount: The number of all available patches excluding critical and security.

    rebootPending
    bool

    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.

    startTime
    string

    StartTime: The UTC timestamp when the operation began.

    status
    AvailablePatchSummaryStatusStatus

    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.”

    BillingProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile, VirtualMachines_Spec)

    Field Description
    maxPrice
    float64

    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.

    BillingProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM, VirtualMachines_Spec_PropertiesARM)

    Field Description
    maxPrice
    float64

    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.

    BillingProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status, VirtualMachine_Status)

    Field Description
    maxPrice
    float64

    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.

    BillingProfile_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM, VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    maxPrice
    float64

    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.

    BootDiagnostics

    (Appears on:DiagnosticsProfile)

    Field Description
    enabled
    bool

    Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.

    storageUri
    string

    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.

    BootDiagnosticsARM

    (Appears on:DiagnosticsProfileARM)

    Field Description
    enabled
    bool

    Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.

    storageUri
    string

    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.

    BootDiagnosticsInstanceView_Status

    (Appears on:VirtualMachineInstanceView_Status)

    Field Description
    consoleScreenshotBlobUri
    string

    ConsoleScreenshotBlobUri: The console screenshot blob URI. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

    serialConsoleLogBlobUri
    string

    SerialConsoleLogBlobUri: The serial console log blob Uri. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

    status
    InstanceViewStatus_Status

    Status: The boot diagnostics status information for the VM. NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.

    BootDiagnosticsInstanceView_StatusARM

    (Appears on:VirtualMachineInstanceView_StatusARM)

    Field Description
    consoleScreenshotBlobUri
    string

    ConsoleScreenshotBlobUri: The console screenshot blob URI. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

    serialConsoleLogBlobUri
    string

    SerialConsoleLogBlobUri: The serial console log blob Uri. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

    status
    InstanceViewStatus_StatusARM

    Status: The boot diagnostics status information for the VM. NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.

    BootDiagnostics_Status

    (Appears on:DiagnosticsProfile_Status)

    Field Description
    enabled
    bool

    Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.

    storageUri
    string

    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.

    BootDiagnostics_StatusARM

    (Appears on:DiagnosticsProfile_StatusARM)

    Field Description
    enabled
    bool

    Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.

    storageUri
    string

    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.

    Caching_Status (string alias)

    (Appears on:DataDisk_Status, DataDisk_StatusARM, OSDisk_Status, OSDisk_StatusARM, VirtualMachineScaleSetDataDisk_Status, VirtualMachineScaleSetDataDisk_StatusARM, VirtualMachineScaleSetOSDisk_Status, VirtualMachineScaleSetOSDisk_StatusARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    CreateOption_Status (string alias)

    (Appears on:DataDisk_Status, DataDisk_StatusARM, OSDisk_Status, OSDisk_StatusARM, VirtualMachineScaleSetDataDisk_Status, VirtualMachineScaleSetDataDisk_StatusARM, VirtualMachineScaleSetOSDisk_Status, VirtualMachineScaleSetOSDisk_StatusARM)

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    DataDisk

    (Appears on:StorageProfile)

    Field Description
    caching
    DataDiskCaching

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

    createOption
    DataDiskCreateOption

    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.

    detachOption
    DataDiskDetachOption

    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’.

    diskSizeGB
    int

    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

    image
    VirtualHardDisk

    Image: Describes the uri of a disk.

    lun
    int

    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.

    managedDisk
    ManagedDiskParameters

    ManagedDisk: The parameters of a managed disk.

    name
    string

    Name: The disk name.

    toBeDetached
    bool

    ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

    vhd
    VirtualHardDisk

    Vhd: Describes the uri of a disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    DataDiskARM

    (Appears on:StorageProfileARM)

    Field Description
    caching
    DataDiskCaching

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

    createOption
    DataDiskCreateOption

    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.

    detachOption
    DataDiskDetachOption

    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’.

    diskSizeGB
    int

    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

    image
    VirtualHardDiskARM

    Image: Describes the uri of a disk.

    lun
    int

    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.

    managedDisk
    ManagedDiskParametersARM

    ManagedDisk: The parameters of a managed disk.

    name
    string

    Name: The disk name.

    toBeDetached
    bool

    ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

    vhd
    VirtualHardDiskARM

    Vhd: Describes the uri of a disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    DataDiskCaching (string alias)

    (Appears on:DataDisk, DataDiskARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    DataDiskCreateOption (string alias)

    (Appears on:DataDisk, DataDiskARM)

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    DataDiskDetachOption (string alias)

    (Appears on:DataDisk, DataDiskARM)

    Value Description

    "ForceDetach"

    DataDisk_Status

    (Appears on:StorageProfile_Status)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    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.

    detachOption
    DetachOption_Status

    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’.

    diskIOPSReadWrite
    int

    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.

    diskMBpsReadWrite
    int

    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.

    diskSizeGB
    int

    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

    image
    VirtualHardDisk_Status

    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.

    lun
    int

    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.

    managedDisk
    ManagedDiskParameters_Status

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    toBeDetached
    bool

    ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

    vhd
    VirtualHardDisk_Status

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    DataDisk_StatusARM

    (Appears on:StorageProfile_StatusARM)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    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.

    detachOption
    DetachOption_Status

    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’.

    diskIOPSReadWrite
    int

    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.

    diskMBpsReadWrite
    int

    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.

    diskSizeGB
    int

    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

    image
    VirtualHardDisk_StatusARM

    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.

    lun
    int

    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.

    managedDisk
    ManagedDiskParameters_StatusARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    toBeDetached
    bool

    ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

    vhd
    VirtualHardDisk_StatusARM

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    DetachOption_Status (string alias)

    (Appears on:DataDisk_Status, DataDisk_StatusARM)

    Value Description

    "ForceDetach"

    DiagnosticsProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile, VirtualMachines_Spec)

    Field Description
    bootDiagnostics
    BootDiagnostics

    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.

    DiagnosticsProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM, VirtualMachines_Spec_PropertiesARM)

    Field Description
    bootDiagnostics
    BootDiagnosticsARM

    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.

    DiagnosticsProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status, VirtualMachine_Status)

    Field Description
    bootDiagnostics
    BootDiagnostics_Status

    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.

    DiagnosticsProfile_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM, VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    bootDiagnostics
    BootDiagnostics_StatusARM

    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.

    DiffDiskOption_Status (string alias)

    (Appears on:DiffDiskSettings_Status, DiffDiskSettings_StatusARM)

    Value Description

    "Local"

    DiffDiskPlacement_Status (string alias)

    (Appears on:DiffDiskSettings_Status, DiffDiskSettings_StatusARM)

    Value Description

    "CacheDisk"

    "ResourceDisk"

    DiffDiskSettings

    (Appears on:OSDisk, VirtualMachineScaleSetOSDisk)

    Field Description
    option
    DiffDiskSettingsOption

    Option: Specifies the ephemeral disk settings for operating system disk.

    placement
    DiffDiskSettingsPlacement

    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/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

    DiffDiskSettingsARM

    (Appears on:OSDiskARM, VirtualMachineScaleSetOSDiskARM)

    Field Description
    option
    DiffDiskSettingsOption

    Option: Specifies the ephemeral disk settings for operating system disk.

    placement
    DiffDiskSettingsPlacement

    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/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

    DiffDiskSettingsOption (string alias)

    (Appears on:DiffDiskSettings, DiffDiskSettingsARM)

    Value Description

    "Local"

    DiffDiskSettingsPlacement (string alias)

    (Appears on:DiffDiskSettings, DiffDiskSettingsARM)

    Value Description

    "CacheDisk"

    "ResourceDisk"

    DiffDiskSettings_Status

    (Appears on:OSDisk_Status, VirtualMachineScaleSetOSDisk_Status)

    Field Description
    option
    DiffDiskOption_Status

    Option: Specifies the ephemeral disk settings for operating system disk.

    placement
    DiffDiskPlacement_Status

    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/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

    DiffDiskSettings_StatusARM

    (Appears on:OSDisk_StatusARM, VirtualMachineScaleSetOSDisk_StatusARM)

    Field Description
    option
    DiffDiskOption_Status

    Option: Specifies the ephemeral disk settings for operating system disk.

    placement
    DiffDiskPlacement_Status

    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/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

    DiskEncryptionSetParameters

    (Appears on:ManagedDiskParameters, VirtualMachineScaleSetManagedDiskParameters)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource Id

    DiskEncryptionSetParametersARM

    (Appears on:ManagedDiskParametersARM, VirtualMachineScaleSetManagedDiskParametersARM)

    Field Description
    id
    string

    DiskEncryptionSettings

    (Appears on:OSDisk)

    Field Description
    diskEncryptionKey
    KeyVaultSecretReference

    DiskEncryptionKey: Describes a reference to Key Vault Secret

    enabled
    bool

    Enabled: Specifies whether disk encryption should be enabled on the virtual machine.

    keyEncryptionKey
    KeyVaultKeyReference

    KeyEncryptionKey: Describes a reference to Key Vault Key

    DiskEncryptionSettingsARM

    (Appears on:OSDiskARM)

    Field Description
    diskEncryptionKey
    KeyVaultSecretReferenceARM

    DiskEncryptionKey: Describes a reference to Key Vault Secret

    enabled
    bool

    Enabled: Specifies whether disk encryption should be enabled on the virtual machine.

    keyEncryptionKey
    KeyVaultKeyReferenceARM

    KeyEncryptionKey: Describes a reference to Key Vault Key

    DiskEncryptionSettings_Status

    (Appears on:DiskInstanceView_Status, OSDisk_Status)

    Field Description
    diskEncryptionKey
    KeyVaultSecretReference_Status

    DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.

    enabled
    bool

    Enabled: Specifies whether disk encryption should be enabled on the virtual machine.

    keyEncryptionKey
    KeyVaultKeyReference_Status

    KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.

    DiskEncryptionSettings_StatusARM

    (Appears on:DiskInstanceView_StatusARM, OSDisk_StatusARM)

    Field Description
    diskEncryptionKey
    KeyVaultSecretReference_StatusARM

    DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.

    enabled
    bool

    Enabled: Specifies whether disk encryption should be enabled on the virtual machine.

    keyEncryptionKey
    KeyVaultKeyReference_StatusARM

    KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.

    DiskInstanceView_Status

    (Appears on:VirtualMachineInstanceView_Status)

    Field Description
    encryptionSettings
    []DiskEncryptionSettings_Status

    EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

    name
    string

    Name: The disk name.

    statuses
    []InstanceViewStatus_Status

    Statuses: The resource status information.

    DiskInstanceView_StatusARM

    (Appears on:VirtualMachineInstanceView_StatusARM)

    Field Description
    encryptionSettings
    []DiskEncryptionSettings_StatusARM

    EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

    name
    string

    Name: The disk name.

    statuses
    []InstanceViewStatus_StatusARM

    Statuses: The resource status information.

    EvictionPolicy_Status (string alias)

    (Appears on:VirtualMachineProperties_StatusARM, VirtualMachineScaleSetVMProfile_Status, VirtualMachineScaleSetVMProfile_StatusARM, VirtualMachine_Status)

    Value Description

    "Deallocate"

    "Delete"

    ExtendedLocation

    (Appears on:VirtualMachineScaleSets_Spec, VirtualMachines_Spec)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationARM

    (Appears on:VirtualMachineScaleSets_SpecARM, VirtualMachines_SpecARM)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationType (string alias)

    (Appears on:ExtendedLocation, ExtendedLocationARM)

    Value Description

    "EdgeZone"

    ExtendedLocationType_Status (string alias)

    (Appears on:ExtendedLocation_Status, ExtendedLocation_StatusARM)

    Value Description

    "EdgeZone"

    ExtendedLocation_Status

    (Appears on:VirtualMachineScaleSet_Status, VirtualMachine_Status)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    ExtendedLocation_StatusARM

    (Appears on:VirtualMachineScaleSet_StatusARM, VirtualMachine_StatusARM)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    GenericExtensionARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile_ExtensionsARM)

    Field Description
    publisher
    string

    Publisher: Microsoft.Compute/extensions - Publisher

    settings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Settings: Microsoft.Compute/extensions - Settings

    type
    string

    Type: Microsoft.Compute/extensions - Type

    typeHandlerVersion
    string

    TypeHandlerVersion: Microsoft.Compute/extensions - Type handler version

    HardwareProfile

    (Appears on:VirtualMachines_Spec)

    Field Description
    vmSize
    HardwareProfileVmSize

    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.

    HardwareProfileARM

    (Appears on:VirtualMachines_Spec_PropertiesARM)

    Field Description
    vmSize
    HardwareProfileVmSize

    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.

    HardwareProfileStatusVmSize (string alias)

    (Appears on:HardwareProfile_Status, HardwareProfile_StatusARM)

    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"

    HardwareProfileVmSize (string alias)

    (Appears on:HardwareProfile, HardwareProfileARM)

    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"

    HardwareProfile_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    vmSize
    HardwareProfileStatusVmSize

    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_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM)

    Field Description
    vmSize
    HardwareProfileStatusVmSize

    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.

    ImageReference

    (Appears on:StorageProfile, VirtualMachineScaleSetStorageProfile)

    Field Description
    offer
    string

    Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    publisher
    string

    Publisher: The image publisher.

    reference
    genruntime.ResourceReference

    Reference: Resource Id

    sku
    string

    Sku: The image SKU.

    version
    string

    Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

    ImageReferenceARM

    (Appears on:StorageProfileARM, VirtualMachineScaleSetStorageProfileARM)

    Field Description
    id
    string
    offer
    string

    Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    publisher
    string

    Publisher: The image publisher.

    sku
    string

    Sku: The image SKU.

    version
    string

    Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

    ImageReference_Status

    (Appears on:StorageProfile_Status, VirtualMachineScaleSetStorageProfile_Status)

    Field Description
    exactVersion
    string

    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’.

    id
    string

    Id: Resource Id

    offer
    string

    Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    publisher
    string

    Publisher: The image publisher.

    sku
    string

    Sku: The image SKU.

    version
    string

    Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

    ImageReference_StatusARM

    (Appears on:StorageProfile_StatusARM, VirtualMachineScaleSetStorageProfile_StatusARM)

    Field Description
    exactVersion
    string

    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’.

    id
    string

    Id: Resource Id

    offer
    string

    Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    publisher
    string

    Publisher: The image publisher.

    sku
    string

    Sku: The image SKU.

    version
    string

    Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

    InnerError_Status

    (Appears on:ApiError_Status)

    Field Description
    errordetail
    string

    Errordetail: The internal error message or exception dump.

    exceptiontype
    string

    Exceptiontype: The exception type.

    InnerError_StatusARM

    (Appears on:ApiError_StatusARM)

    Field Description
    errordetail
    string

    Errordetail: The internal error message or exception dump.

    exceptiontype
    string

    Exceptiontype: The exception type.

    InstanceViewStatusStatusLevel (string alias)

    (Appears on:InstanceViewStatus_Status, InstanceViewStatus_StatusARM)

    Value Description

    "Error"

    "Info"

    "Warning"

    InstanceViewStatus_Status

    (Appears on:BootDiagnosticsInstanceView_Status, DiskInstanceView_Status, VirtualMachineAgentInstanceView_Status, VirtualMachineExtensionHandlerInstanceView_Status, VirtualMachineExtensionInstanceView_Status, VirtualMachineHealthStatus_Status, VirtualMachineInstanceView_Status, VirtualMachinePatchStatus_Status)

    Field Description
    code
    string

    Code: The status code.

    displayStatus
    string

    DisplayStatus: The short localizable label for the status.

    level
    InstanceViewStatusStatusLevel

    Level: The level code.

    message
    string

    Message: The detailed status message, including for alerts and error messages.

    time
    string

    Time: The time of the status.

    InstanceViewStatus_StatusARM

    (Appears on:BootDiagnosticsInstanceView_StatusARM, DiskInstanceView_StatusARM, VirtualMachineAgentInstanceView_StatusARM, VirtualMachineExtensionHandlerInstanceView_StatusARM, VirtualMachineExtensionInstanceView_StatusARM, VirtualMachineHealthStatus_StatusARM, VirtualMachineInstanceView_StatusARM, VirtualMachinePatchStatus_StatusARM)

    Field Description
    code
    string

    Code: The status code.

    displayStatus
    string

    DisplayStatus: The short localizable label for the status.

    level
    InstanceViewStatusStatusLevel

    Level: The level code.

    message
    string

    Message: The detailed status message, including for alerts and error messages.

    time
    string

    Time: The time of the status.

    KeyVaultKeyReference

    (Appears on:DiskEncryptionSettings)

    Field Description
    keyUrl
    string

    KeyUrl: The URL referencing a key encryption key in Key Vault.

    sourceVault
    SubResource

    KeyVaultKeyReferenceARM

    (Appears on:DiskEncryptionSettingsARM)

    Field Description
    keyUrl
    string

    KeyUrl: The URL referencing a key encryption key in Key Vault.

    sourceVault
    SubResourceARM

    KeyVaultKeyReference_Status

    (Appears on:DiskEncryptionSettings_Status)

    Field Description
    keyUrl
    string

    KeyUrl: The URL referencing a key encryption key in Key Vault.

    sourceVault
    SubResource_Status

    SourceVault: The relative URL of the Key Vault containing the key.

    KeyVaultKeyReference_StatusARM

    (Appears on:DiskEncryptionSettings_StatusARM)

    Field Description
    keyUrl
    string

    KeyUrl: The URL referencing a key encryption key in Key Vault.

    sourceVault
    SubResource_StatusARM

    SourceVault: The relative URL of the Key Vault containing the key.

    KeyVaultSecretReference

    (Appears on:DiskEncryptionSettings)

    Field Description
    secretUrl
    string

    SecretUrl: The URL referencing a secret in a Key Vault.

    sourceVault
    SubResource

    KeyVaultSecretReferenceARM

    (Appears on:DiskEncryptionSettingsARM)

    Field Description
    secretUrl
    string

    SecretUrl: The URL referencing a secret in a Key Vault.

    sourceVault
    SubResourceARM

    KeyVaultSecretReference_Status

    (Appears on:DiskEncryptionSettings_Status)

    Field Description
    secretUrl
    string

    SecretUrl: The URL referencing a secret in a Key Vault.

    sourceVault
    SubResource_Status

    SourceVault: The relative URL of the Key Vault containing the secret.

    KeyVaultSecretReference_StatusARM

    (Appears on:DiskEncryptionSettings_StatusARM)

    Field Description
    secretUrl
    string

    SecretUrl: The URL referencing a secret in a Key Vault.

    sourceVault
    SubResource_StatusARM

    SourceVault: The relative URL of the Key Vault containing the secret.

    LastPatchInstallationSummaryStatusStatus (string alias)

    (Appears on:LastPatchInstallationSummary_Status, LastPatchInstallationSummary_StatusARM)

    Value Description

    "CompletedWithWarnings"

    "Failed"

    "InProgress"

    "Succeeded"

    "Unknown"

    LastPatchInstallationSummary_Status

    (Appears on:VirtualMachinePatchStatus_Status)

    Field Description
    error
    ApiError_Status

    Error: The errors that were encountered during execution of the operation. The details array contains the list of them.

    excludedPatchCount
    int

    ExcludedPatchCount: The number of all available patches but excluded explicitly by a customer-specified exclusion list match.

    failedPatchCount
    int

    FailedPatchCount: The count of patches that failed installation.

    installationActivityId
    string

    InstallationActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.

    installedPatchCount
    int

    InstalledPatchCount: The count of patches that successfully installed.

    lastModifiedTime
    string

    LastModifiedTime: The UTC timestamp when the operation began.

    maintenanceWindowExceeded
    bool

    MaintenanceWindowExceeded: Describes whether the operation ran out of time before it completed all its intended actions

    notSelectedPatchCount
    int

    NotSelectedPatchCount: The number of all available patches but not going to be installed because it didn’t match a classification or inclusion list entry.

    pendingPatchCount
    int

    PendingPatchCount: The number of all available patches expected to be installed over the course of the patch installation operation.

    startTime
    string

    StartTime: The UTC timestamp when the operation began.

    status
    LastPatchInstallationSummaryStatusStatus

    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_StatusARM

    (Appears on:VirtualMachinePatchStatus_StatusARM)

    Field Description
    error
    ApiError_StatusARM

    Error: The errors that were encountered during execution of the operation. The details array contains the list of them.

    excludedPatchCount
    int

    ExcludedPatchCount: The number of all available patches but excluded explicitly by a customer-specified exclusion list match.

    failedPatchCount
    int

    FailedPatchCount: The count of patches that failed installation.

    installationActivityId
    string

    InstallationActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.

    installedPatchCount
    int

    InstalledPatchCount: The count of patches that successfully installed.

    lastModifiedTime
    string

    LastModifiedTime: The UTC timestamp when the operation began.

    maintenanceWindowExceeded
    bool

    MaintenanceWindowExceeded: Describes whether the operation ran out of time before it completed all its intended actions

    notSelectedPatchCount
    int

    NotSelectedPatchCount: The number of all available patches but not going to be installed because it didn’t match a classification or inclusion list entry.

    pendingPatchCount
    int

    PendingPatchCount: The number of all available patches expected to be installed over the course of the patch installation operation.

    startTime
    string

    StartTime: The UTC timestamp when the operation began.

    status
    LastPatchInstallationSummaryStatusStatus

    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.”

    LinuxConfiguration

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfile, VirtualMachines_Spec_Properties_OsProfile)

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettings

    PatchSettings: Specifies settings related to VM Guest Patching on Linux.

    provisionVMAgent
    bool

    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.

    ssh
    SshConfiguration

    Ssh: SSH configuration for Linux based VMs running on Azure

    LinuxConfigurationARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfileARM, VirtualMachines_Spec_Properties_OsProfileARM)

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettingsARM

    PatchSettings: Specifies settings related to VM Guest Patching on Linux.

    provisionVMAgent
    bool

    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.

    ssh
    SshConfigurationARM

    Ssh: SSH configuration for Linux based VMs running on Azure

    LinuxConfiguration_Status

    (Appears on:OSProfile_Status, VirtualMachineScaleSetOSProfile_Status)

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettings_Status

    PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Linux.

    provisionVMAgent
    bool

    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.

    ssh
    SshConfiguration_Status

    Ssh: Specifies the ssh key configuration for a Linux OS.

    LinuxConfiguration_StatusARM

    (Appears on:OSProfile_StatusARM, VirtualMachineScaleSetOSProfile_StatusARM)

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettings_StatusARM

    PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Linux.

    provisionVMAgent
    bool

    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.

    ssh
    SshConfiguration_StatusARM

    Ssh: Specifies the ssh key configuration for a Linux OS.

    LinuxPatchSettings

    (Appears on:LinuxConfiguration)

    Field Description
    patchMode
    LinuxPatchSettingsPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. 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.

    LinuxPatchSettingsARM

    (Appears on:LinuxConfigurationARM)

    Field Description
    patchMode
    LinuxPatchSettingsPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. 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.

    LinuxPatchSettingsPatchMode (string alias)

    (Appears on:LinuxPatchSettings, LinuxPatchSettingsARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    LinuxPatchSettingsStatusPatchMode (string alias)

    (Appears on:LinuxPatchSettings_Status, LinuxPatchSettings_StatusARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    LinuxPatchSettings_Status

    (Appears on:LinuxConfiguration_Status)

    Field Description
    patchMode
    LinuxPatchSettingsStatusPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. 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_StatusARM

    (Appears on:LinuxConfiguration_StatusARM)

    Field Description
    patchMode
    LinuxPatchSettingsStatusPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. 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

    MaintenanceRedeployStatusStatusLastOperationResultCode (string alias)

    (Appears on:MaintenanceRedeployStatus_Status, MaintenanceRedeployStatus_StatusARM)

    Value Description

    "MaintenanceAborted"

    "MaintenanceCompleted"

    "None"

    "RetryLater"

    MaintenanceRedeployStatus_Status

    (Appears on:VirtualMachineInstanceView_Status)

    Field Description
    isCustomerInitiatedMaintenanceAllowed
    bool

    IsCustomerInitiatedMaintenanceAllowed: True, if customer is allowed to perform Maintenance.

    lastOperationMessage
    string

    LastOperationMessage: Message returned for the last Maintenance Operation.

    lastOperationResultCode
    MaintenanceRedeployStatusStatusLastOperationResultCode

    LastOperationResultCode: The Last Maintenance Operation Result Code.

    maintenanceWindowEndTime
    string

    MaintenanceWindowEndTime: End Time for the Maintenance Window.

    maintenanceWindowStartTime
    string

    MaintenanceWindowStartTime: Start Time for the Maintenance Window.

    preMaintenanceWindowEndTime
    string

    PreMaintenanceWindowEndTime: End Time for the Pre Maintenance Window.

    preMaintenanceWindowStartTime
    string

    PreMaintenanceWindowStartTime: Start Time for the Pre Maintenance Window.

    MaintenanceRedeployStatus_StatusARM

    (Appears on:VirtualMachineInstanceView_StatusARM)

    Field Description
    isCustomerInitiatedMaintenanceAllowed
    bool

    IsCustomerInitiatedMaintenanceAllowed: True, if customer is allowed to perform Maintenance.

    lastOperationMessage
    string

    LastOperationMessage: Message returned for the last Maintenance Operation.

    lastOperationResultCode
    MaintenanceRedeployStatusStatusLastOperationResultCode

    LastOperationResultCode: The Last Maintenance Operation Result Code.

    maintenanceWindowEndTime
    string

    MaintenanceWindowEndTime: End Time for the Maintenance Window.

    maintenanceWindowStartTime
    string

    MaintenanceWindowStartTime: Start Time for the Maintenance Window.

    preMaintenanceWindowEndTime
    string

    PreMaintenanceWindowEndTime: End Time for the Pre Maintenance Window.

    preMaintenanceWindowStartTime
    string

    PreMaintenanceWindowStartTime: Start Time for the Pre Maintenance Window.

    ManagedDiskParameters

    (Appears on:DataDisk, OSDisk)

    Field Description
    diskEncryptionSet
    DiskEncryptionSetParameters

    DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

    reference
    genruntime.ResourceReference

    Reference: Resource Id

    storageAccountType
    ManagedDiskParametersStorageAccountType

    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.

    ManagedDiskParametersARM

    (Appears on:DataDiskARM, OSDiskARM)

    Field Description
    diskEncryptionSet
    DiskEncryptionSetParametersARM

    DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

    id
    string
    storageAccountType
    ManagedDiskParametersStorageAccountType

    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.

    ManagedDiskParametersStorageAccountType (string alias)

    (Appears on:ManagedDiskParameters, ManagedDiskParametersARM)

    Value Description

    "Premium_LRS"

    "Premium_ZRS"

    "Standard_LRS"

    "StandardSSD_LRS"

    "StandardSSD_ZRS"

    "UltraSSD_LRS"

    ManagedDiskParameters_Status

    (Appears on:DataDisk_Status, OSDisk_Status)

    Field Description
    diskEncryptionSet
    SubResource_Status

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.

    id
    string

    Id: Resource Id

    storageAccountType
    StorageAccountType_Status

    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.

    ManagedDiskParameters_StatusARM

    (Appears on:DataDisk_StatusARM, OSDisk_StatusARM)

    Field Description
    diskEncryptionSet
    SubResource_StatusARM

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.

    id
    string

    Id: Resource Id

    storageAccountType
    StorageAccountType_Status

    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.

    NetworkInterfaceReferencePropertiesARM

    (Appears on:VirtualMachines_Spec_Properties_NetworkProfile_NetworkInterfacesARM)

    Field Description
    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    NetworkInterfaceReferenceProperties_StatusARM

    (Appears on:NetworkInterfaceReference_StatusARM)

    Field Description
    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    NetworkInterfaceReference_Status

    (Appears on:NetworkProfile_Status)

    Field Description
    id
    string

    Id: Resource Id

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    NetworkInterfaceReference_StatusARM

    (Appears on:NetworkProfile_StatusARM)

    Field Description
    id
    string

    Id: Resource Id

    properties
    NetworkInterfaceReferenceProperties_StatusARM

    NetworkProfile_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    networkInterfaces
    []NetworkInterfaceReference_Status

    NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

    NetworkProfile_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM)

    Field Description
    networkInterfaces
    []NetworkInterfaceReference_StatusARM

    NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

    OSDisk

    (Appears on:StorageProfile)

    Field Description
    caching
    OSDiskCaching

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

    createOption
    OSDiskCreateOption

    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.

    diffDiskSettings
    DiffDiskSettings

    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.

    diskSizeGB
    int

    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

    encryptionSettings
    DiskEncryptionSettings

    EncryptionSettings: Describes a Encryption Settings for a Disk

    image
    VirtualHardDisk

    Image: Describes the uri of a disk.

    managedDisk
    ManagedDiskParameters

    ManagedDisk: The parameters of a managed disk.

    name
    string

    Name: The disk name.

    osType
    OSDiskOsType

    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.

    vhd
    VirtualHardDisk

    Vhd: Describes the uri of a disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    OSDiskARM

    (Appears on:StorageProfileARM)

    Field Description
    caching
    OSDiskCaching

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

    createOption
    OSDiskCreateOption

    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.

    diffDiskSettings
    DiffDiskSettingsARM

    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.

    diskSizeGB
    int

    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

    encryptionSettings
    DiskEncryptionSettingsARM

    EncryptionSettings: Describes a Encryption Settings for a Disk

    image
    VirtualHardDiskARM

    Image: Describes the uri of a disk.

    managedDisk
    ManagedDiskParametersARM

    ManagedDisk: The parameters of a managed disk.

    name
    string

    Name: The disk name.

    osType
    OSDiskOsType

    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.

    vhd
    VirtualHardDiskARM

    Vhd: Describes the uri of a disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    OSDiskCaching (string alias)

    (Appears on:OSDisk, OSDiskARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    OSDiskCreateOption (string alias)

    (Appears on:OSDisk, OSDiskARM)

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    OSDiskOsType (string alias)

    (Appears on:OSDisk, OSDiskARM)

    Value Description

    "Linux"

    "Windows"

    OSDiskStatusOsType (string alias)

    (Appears on:OSDisk_Status, OSDisk_StatusARM)

    Value Description

    "Linux"

    "Windows"

    OSDisk_Status

    (Appears on:StorageProfile_Status)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    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.

    diffDiskSettings
    DiffDiskSettings_Status

    DiffDiskSettings: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

    diskSizeGB
    int

    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

    encryptionSettings
    DiskEncryptionSettings_Status

    EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

    image
    VirtualHardDisk_Status

    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.

    managedDisk
    ManagedDiskParameters_Status

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    OSDiskStatusOsType

    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

    vhd
    VirtualHardDisk_Status

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    OSDisk_StatusARM

    (Appears on:StorageProfile_StatusARM)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    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.

    diffDiskSettings
    DiffDiskSettings_StatusARM

    DiffDiskSettings: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

    diskSizeGB
    int

    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

    encryptionSettings
    DiskEncryptionSettings_StatusARM

    EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

    image
    VirtualHardDisk_StatusARM

    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.

    managedDisk
    ManagedDiskParameters_StatusARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    OSDiskStatusOsType

    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

    vhd
    VirtualHardDisk_StatusARM

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    OSProfile_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • allowExtensionOperations
    bool

    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.

    computerName
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. 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

    linuxConfiguration
    LinuxConfiguration_Status

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. Note: This property is for private testing only, and all customers must not set the property to false.

    secrets
    []VaultSecretGroup_Status

    Secrets: Specifies set of certificates that should be installed onto the virtual machine.

    windowsConfiguration
    WindowsConfiguration_Status

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    OSProfile_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM)

    Field Description
    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • allowExtensionOperations
    bool

    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.

    computerName
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. 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

    linuxConfiguration
    LinuxConfiguration_StatusARM

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. Note: This property is for private testing only, and all customers must not set the property to false.

    secrets
    []VaultSecretGroup_StatusARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machine.

    windowsConfiguration
    WindowsConfiguration_StatusARM

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    OrchestrationMode_Status (string alias)

    (Appears on:VirtualMachineScaleSetProperties_StatusARM, VirtualMachineScaleSet_Status)

    Value Description

    "Flexible"

    "Uniform"

    PatchSettings

    (Appears on:WindowsConfiguration)

    Field Description
    enableHotpatching
    bool

    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’.

    patchMode
    PatchSettingsPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true.

    PatchSettingsARM

    (Appears on:WindowsConfigurationARM)

    Field Description
    enableHotpatching
    bool

    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’.

    patchMode
    PatchSettingsPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true.

    PatchSettingsPatchMode (string alias)

    (Appears on:PatchSettings, PatchSettingsARM)

    Value Description

    "AutomaticByOS"

    "AutomaticByPlatform"

    "Manual"

    PatchSettingsStatusPatchMode (string alias)

    (Appears on:PatchSettings_Status, PatchSettings_StatusARM)

    Value Description

    "AutomaticByOS"

    "AutomaticByPlatform"

    "Manual"

    PatchSettings_Status

    (Appears on:WindowsConfiguration_Status)

    Field Description
    enableHotpatching
    bool

    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’.

    patchMode
    PatchSettingsStatusPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

    PatchSettings_StatusARM

    (Appears on:WindowsConfiguration_StatusARM)

    Field Description
    enableHotpatching
    bool

    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’.

    patchMode
    PatchSettingsStatusPatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

    Plan

    (Appears on:VirtualMachineScaleSets_Spec, VirtualMachines_Spec)

    Field Description
    name
    string

    Name: The plan ID.

    product
    string

    Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

    promotionCode
    string

    PromotionCode: The promotion code.

    publisher
    string

    Publisher: The publisher ID.

    PlanARM

    (Appears on:VirtualMachineScaleSets_SpecARM, VirtualMachines_SpecARM)

    Field Description
    name
    string

    Name: The plan ID.

    product
    string

    Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

    promotionCode
    string

    PromotionCode: The promotion code.

    publisher
    string

    Publisher: The publisher ID.

    Plan_Status

    (Appears on:VirtualMachineScaleSet_Status, VirtualMachine_Status)

    Field Description
    name
    string

    Name: The plan ID.

    product
    string

    Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

    promotionCode
    string

    PromotionCode: The promotion code.

    publisher
    string

    Publisher: The publisher ID.

    Plan_StatusARM

    (Appears on:VirtualMachineScaleSet_StatusARM, VirtualMachine_StatusARM)

    Field Description
    name
    string

    Name: The plan ID.

    product
    string

    Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

    promotionCode
    string

    PromotionCode: The promotion code.

    publisher
    string

    Publisher: The publisher ID.

    Priority_Status (string alias)

    (Appears on:VirtualMachineProperties_StatusARM, VirtualMachineScaleSetVMProfile_Status, VirtualMachineScaleSetVMProfile_StatusARM, VirtualMachine_Status)

    Value Description

    "Low"

    "Regular"

    "Spot"

    RollingUpgradePolicy

    (Appears on:UpgradePolicy)

    Field Description
    enableCrossZoneUpgrade
    bool

    EnableCrossZoneUpgrade: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

    maxBatchInstancePercent
    int

    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%.

    maxUnhealthyInstancePercent
    int

    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%.

    maxUnhealthyUpgradedInstancePercent
    int

    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%.

    pauseTimeBetweenBatches
    string

    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).

    prioritizeUnhealthyInstances
    bool

    PrioritizeUnhealthyInstances: Upgrade all unhealthy instances in a scale set before any healthy instances.

    RollingUpgradePolicyARM

    (Appears on:UpgradePolicyARM)

    Field Description
    enableCrossZoneUpgrade
    bool

    EnableCrossZoneUpgrade: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

    maxBatchInstancePercent
    int

    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%.

    maxUnhealthyInstancePercent
    int

    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%.

    maxUnhealthyUpgradedInstancePercent
    int

    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%.

    pauseTimeBetweenBatches
    string

    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).

    prioritizeUnhealthyInstances
    bool

    PrioritizeUnhealthyInstances: Upgrade all unhealthy instances in a scale set before any healthy instances.

    RollingUpgradePolicy_Status

    (Appears on:UpgradePolicy_Status)

    Field Description
    enableCrossZoneUpgrade
    bool

    EnableCrossZoneUpgrade: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

    maxBatchInstancePercent
    int

    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%.

    maxUnhealthyInstancePercent
    int

    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%.

    maxUnhealthyUpgradedInstancePercent
    int

    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%.

    pauseTimeBetweenBatches
    string

    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).

    prioritizeUnhealthyInstances
    bool

    PrioritizeUnhealthyInstances: Upgrade all unhealthy instances in a scale set before any healthy instances.

    RollingUpgradePolicy_StatusARM

    (Appears on:UpgradePolicy_StatusARM)

    Field Description
    enableCrossZoneUpgrade
    bool

    EnableCrossZoneUpgrade: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

    maxBatchInstancePercent
    int

    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%.

    maxUnhealthyInstancePercent
    int

    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%.

    maxUnhealthyUpgradedInstancePercent
    int

    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%.

    pauseTimeBetweenBatches
    string

    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).

    prioritizeUnhealthyInstances
    bool

    PrioritizeUnhealthyInstances: Upgrade all unhealthy instances in a scale set before any healthy instances.

    ScaleInPolicy

    (Appears on:VirtualMachineScaleSets_Spec)

    Field Description
    rules
    []ScaleInPolicyRules

    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.

    ScaleInPolicyARM

    (Appears on:VirtualMachineScaleSets_Spec_PropertiesARM)

    Field Description
    rules
    []ScaleInPolicyRules

    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.

    ScaleInPolicyRules (string alias)

    (Appears on:ScaleInPolicy, ScaleInPolicyARM)

    Value Description

    "Default"

    "NewestVM"

    "OldestVM"

    ScaleInPolicyStatusRules (string alias)

    (Appears on:ScaleInPolicy_Status, ScaleInPolicy_StatusARM)

    Value Description

    "Default"

    "NewestVM"

    "OldestVM"

    ScaleInPolicy_Status

    (Appears on:VirtualMachineScaleSet_Status)

    Field Description
    rules
    []ScaleInPolicyStatusRules

    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_StatusARM

    (Appears on:VirtualMachineScaleSetProperties_StatusARM)

    Field Description
    rules
    []ScaleInPolicyStatusRules

    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.

    ScheduledEventsProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile

    ScheduledEventsProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfileARM

    ScheduledEventsProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile_Status

    TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

    ScheduledEventsProfile_StatusARM

    (Appears on:VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile_StatusARM

    TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

    SecurityProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile, VirtualMachines_Spec)

    Field Description
    encryptionAtHost
    bool

    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.

    securityType
    SecurityProfileSecurityType

    SecurityType: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch.

    uefiSettings
    UefiSettings

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

    SecurityProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM, VirtualMachines_Spec_PropertiesARM)

    Field Description
    encryptionAtHost
    bool

    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.

    securityType
    SecurityProfileSecurityType

    SecurityType: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch.

    uefiSettings
    UefiSettingsARM

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

    SecurityProfileSecurityType (string alias)

    (Appears on:SecurityProfile, SecurityProfileARM)

    Value Description

    "TrustedLaunch"

    SecurityProfileStatusSecurityType (string alias)

    (Appears on:SecurityProfile_Status, SecurityProfile_StatusARM)

    Value Description

    "TrustedLaunch"

    SecurityProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status, VirtualMachine_Status)

    Field Description
    encryptionAtHost
    bool

    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.

    securityType
    SecurityProfileStatusSecurityType

    SecurityType: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch.

    uefiSettings
    UefiSettings_Status

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

    SecurityProfile_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM, VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    encryptionAtHost
    bool

    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.

    securityType
    SecurityProfileStatusSecurityType

    SecurityType: Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch.

    uefiSettings
    UefiSettings_StatusARM

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

    Sku

    (Appears on:VirtualMachineScaleSets_Spec)

    Field Description
    capacity
    int

    Capacity: Specifies the number of virtual machines in the scale set.

    name
    string

    Name: The sku name.

    tier
    string

    Tier: Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

    SkuARM

    (Appears on:VirtualMachineScaleSets_SpecARM)

    Field Description
    capacity
    int

    Capacity: Specifies the number of virtual machines in the scale set.

    name
    string

    Name: The sku name.

    tier
    string

    Tier: Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

    Sku_Status

    (Appears on:VirtualMachineScaleSet_Status)

    Field Description
    capacity
    int

    Capacity: Specifies the number of virtual machines in the scale set.

    name
    string

    Name: The sku name.

    tier
    string

    Tier: Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

    Sku_StatusARM

    (Appears on:VirtualMachineScaleSet_StatusARM)

    Field Description
    capacity
    int

    Capacity: Specifies the number of virtual machines in the scale set.

    name
    string

    Name: The sku name.

    tier
    string

    Tier: Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

    SshConfiguration

    (Appears on:LinuxConfiguration)

    Field Description
    publicKeys
    []SshPublicKey

    PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.

    SshConfigurationARM

    (Appears on:LinuxConfigurationARM)

    Field Description
    publicKeys
    []SshPublicKeyARM

    PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.

    SshConfiguration_Status

    (Appears on:LinuxConfiguration_Status)

    Field Description
    publicKeys
    []SshPublicKey_Status

    PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.

    SshConfiguration_StatusARM

    (Appears on:LinuxConfiguration_StatusARM)

    Field Description
    publicKeys
    []SshPublicKey_StatusARM

    PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.

    SshPublicKey

    (Appears on:SshConfiguration)

    Field Description
    keyData
    string

    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.

    path
    string

    Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

    SshPublicKeyARM

    (Appears on:SshConfigurationARM)

    Field Description
    keyData
    string

    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.

    path
    string

    Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

    SshPublicKey_Status

    (Appears on:SshConfiguration_Status)

    Field Description
    keyData
    string

    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.

    path
    string

    Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

    SshPublicKey_StatusARM

    (Appears on:SshConfiguration_StatusARM)

    Field Description
    keyData
    string

    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.

    path
    string

    Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

    StorageAccountType_Status (string alias)

    (Appears on:ManagedDiskParameters_Status, ManagedDiskParameters_StatusARM, VirtualMachineScaleSetManagedDiskParameters_Status, VirtualMachineScaleSetManagedDiskParameters_StatusARM)

    Value Description

    "Premium_LRS"

    "Premium_ZRS"

    "Standard_LRS"

    "StandardSSD_LRS"

    "StandardSSD_ZRS"

    "UltraSSD_LRS"

    StorageProfile

    (Appears on:VirtualMachines_Spec)

    Field Description
    dataDisks
    []DataDisk

    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.

    imageReference
    ImageReference

    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.

    osDisk
    OSDisk

    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.

    StorageProfileARM

    (Appears on:VirtualMachines_Spec_PropertiesARM)

    Field Description
    dataDisks
    []DataDiskARM

    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.

    imageReference
    ImageReferenceARM

    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.

    osDisk
    OSDiskARM

    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.

    StorageProfile_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    dataDisks
    []DataDisk_Status

    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.

    imageReference
    ImageReference_Status

    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.

    osDisk
    OSDisk_Status

    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.

    StorageProfile_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM)

    Field Description
    dataDisks
    []DataDisk_StatusARM

    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.

    imageReference
    ImageReference_StatusARM

    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.

    osDisk
    OSDisk_StatusARM

    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.

    SubResource

    (Appears on:KeyVaultKeyReference, KeyVaultSecretReference, VaultSecretGroup, VirtualMachineScaleSets_Spec, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfiguration, VirtualMachines_Spec)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource Id

    SubResourceARM

    (Appears on:KeyVaultKeyReferenceARM, KeyVaultSecretReferenceARM, VaultSecretGroupARM, VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesARM, VirtualMachineScaleSets_Spec_PropertiesARM, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_PropertiesARM, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_PropertiesARM, VirtualMachines_Spec_PropertiesARM)

    Field Description
    id
    string

    SubResource_Status

    (Appears on:KeyVaultKeyReference_Status, KeyVaultSecretReference_Status, ManagedDiskParameters_Status, VaultSecretGroup_Status, VirtualMachineScaleSetIPConfiguration_Status, VirtualMachineScaleSetManagedDiskParameters_Status, VirtualMachineScaleSetNetworkConfiguration_Status, VirtualMachineScaleSetPublicIPAddressConfiguration_Status, VirtualMachineScaleSet_Status, VirtualMachine_Status)

    Field Description
    id
    string

    Id: Resource Id

    SubResource_StatusARM

    (Appears on:KeyVaultKeyReference_StatusARM, KeyVaultSecretReference_StatusARM, ManagedDiskParameters_StatusARM, VaultSecretGroup_StatusARM, VirtualMachineProperties_StatusARM, VirtualMachineScaleSetIPConfigurationProperties_StatusARM, VirtualMachineScaleSetManagedDiskParameters_StatusARM, VirtualMachineScaleSetNetworkConfigurationProperties_StatusARM, VirtualMachineScaleSetProperties_StatusARM, VirtualMachineScaleSetPublicIPAddressConfigurationProperties_StatusARM)

    Field Description
    id
    string

    Id: Resource Id

    TerminateNotificationProfile

    (Appears on:ScheduledEventsProfile)

    Field Description
    enable
    bool

    Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.

    notBeforeTimeout
    string

    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)

    TerminateNotificationProfileARM

    (Appears on:ScheduledEventsProfileARM)

    Field Description
    enable
    bool

    Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.

    notBeforeTimeout
    string

    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)

    TerminateNotificationProfile_Status

    (Appears on:ScheduledEventsProfile_Status)

    Field Description
    enable
    bool

    Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.

    notBeforeTimeout
    string

    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)

    TerminateNotificationProfile_StatusARM

    (Appears on:ScheduledEventsProfile_StatusARM)

    Field Description
    enable
    bool

    Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.

    notBeforeTimeout
    string

    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)

    UefiSettings

    (Appears on:SecurityProfile)

    Field Description
    secureBootEnabled
    bool

    SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    vTpmEnabled
    bool

    VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    UefiSettingsARM

    (Appears on:SecurityProfileARM)

    Field Description
    secureBootEnabled
    bool

    SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    vTpmEnabled
    bool

    VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    UefiSettings_Status

    (Appears on:SecurityProfile_Status)

    Field Description
    secureBootEnabled
    bool

    SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    vTpmEnabled
    bool

    VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    UefiSettings_StatusARM

    (Appears on:SecurityProfile_StatusARM)

    Field Description
    secureBootEnabled
    bool

    SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    vTpmEnabled
    bool

    VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01

    UpgradePolicy

    (Appears on:VirtualMachineScaleSets_Spec)

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy

    AutomaticOSUpgradePolicy: The configuration parameters used for performing automatic OS upgrade.

    mode
    UpgradePolicyMode

    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.

    rollingUpgradePolicy
    RollingUpgradePolicy

    RollingUpgradePolicy: The configuration parameters used while performing a rolling upgrade.

    UpgradePolicyARM

    (Appears on:VirtualMachineScaleSets_Spec_PropertiesARM)

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicyARM

    AutomaticOSUpgradePolicy: The configuration parameters used for performing automatic OS upgrade.

    mode
    UpgradePolicyMode

    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.

    rollingUpgradePolicy
    RollingUpgradePolicyARM

    RollingUpgradePolicy: The configuration parameters used while performing a rolling upgrade.

    UpgradePolicyMode (string alias)

    (Appears on:UpgradePolicy, UpgradePolicyARM)

    Value Description

    "Automatic"

    "Manual"

    "Rolling"

    UpgradePolicyStatusMode (string alias)

    (Appears on:UpgradePolicy_Status, UpgradePolicy_StatusARM)

    Value Description

    "Automatic"

    "Manual"

    "Rolling"

    UpgradePolicy_Status

    (Appears on:VirtualMachineScaleSet_Status)

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy_Status

    AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

    mode
    UpgradePolicyStatusMode

    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.

    rollingUpgradePolicy
    RollingUpgradePolicy_Status

    RollingUpgradePolicy: The configuration parameters used while performing a rolling upgrade.

    UpgradePolicy_StatusARM

    (Appears on:VirtualMachineScaleSetProperties_StatusARM)

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy_StatusARM

    AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

    mode
    UpgradePolicyStatusMode

    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.

    rollingUpgradePolicy
    RollingUpgradePolicy_StatusARM

    RollingUpgradePolicy: The configuration parameters used while performing a rolling upgrade.

    VaultCertificate

    (Appears on:VaultSecretGroup)

    Field Description
    certificateStore
    string

    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.

    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    VaultCertificateARM

    (Appears on:VaultSecretGroupARM)

    Field Description
    certificateStore
    string

    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.

    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    VaultCertificate_Status

    (Appears on:VaultSecretGroup_Status)

    Field Description
    certificateStore
    string

    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.

    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    VaultCertificate_StatusARM

    (Appears on:VaultSecretGroup_StatusARM)

    Field Description
    certificateStore
    string

    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.

    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    VaultSecretGroup

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfile, VirtualMachines_Spec_Properties_OsProfile)

    Field Description
    sourceVault
    SubResource
    vaultCertificates
    []VaultCertificate

    VaultCertificates: The list of key vault references in SourceVault which contain certificates.

    VaultSecretGroupARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfileARM, VirtualMachines_Spec_Properties_OsProfileARM)

    Field Description
    sourceVault
    SubResourceARM
    vaultCertificates
    []VaultCertificateARM

    VaultCertificates: The list of key vault references in SourceVault which contain certificates.

    VaultSecretGroup_Status

    (Appears on:OSProfile_Status, VirtualMachineScaleSetOSProfile_Status)

    Field Description
    sourceVault
    SubResource_Status

    SourceVault: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

    vaultCertificates
    []VaultCertificate_Status

    VaultCertificates: The list of key vault references in SourceVault which contain certificates.

    VaultSecretGroup_StatusARM

    (Appears on:OSProfile_StatusARM, VirtualMachineScaleSetOSProfile_StatusARM)

    Field Description
    sourceVault
    SubResource_StatusARM

    SourceVault: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

    vaultCertificates
    []VaultCertificate_StatusARM

    VaultCertificates: The list of key vault references in SourceVault which contain certificates.

    VirtualHardDisk

    (Appears on:DataDisk, OSDisk, VirtualMachineScaleSetOSDisk)

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualHardDiskARM

    (Appears on:DataDiskARM, OSDiskARM, VirtualMachineScaleSetOSDiskARM)

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualHardDisk_Status

    (Appears on:DataDisk_Status, OSDisk_Status, VirtualMachineScaleSetOSDisk_Status)

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualHardDisk_StatusARM

    (Appears on:DataDisk_StatusARM, OSDisk_StatusARM, VirtualMachineScaleSetOSDisk_StatusARM)

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualMachine

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualMachines_Spec


    additionalCapabilities
    AdditionalCapabilities

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

    availabilitySet
    SubResource
    azureName
    string

    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.

    billingProfile
    BillingProfile

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

    diagnosticsProfile
    DiagnosticsProfile

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

    evictionPolicy
    VirtualMachinesSpecPropertiesEvictionPolicy

    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    extensionsTimeBudget
    string

    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

    hardwareProfile
    HardwareProfile

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource
    hostGroup
    SubResource
    identity
    VirtualMachineIdentity

    Identity: Identity for the virtual machine.

    licenseType
    string

    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

    location
    string

    Location: Location to deploy resource to

    networkProfile
    VirtualMachines_Spec_Properties_NetworkProfile

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    VirtualMachines_Spec_Properties_OsProfile

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

    owner
    genruntime.KnownResourceReference

    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

    plan
    Plan

    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.

    platformFaultDomain
    int

    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

  • priority
    VirtualMachinesSpecPropertiesPriority

    Priority: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01.

    proximityPlacementGroup
    SubResource
    securityProfile
    SecurityProfile

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

    storageProfile
    StorageProfile

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    virtualMachineScaleSet
    SubResource
    zones
    []string

    Zones: The virtual machine zones.

    status
    VirtualMachine_Status

    VirtualMachineAgentInstanceView_Status

    (Appears on:VirtualMachineInstanceView_Status)

    Field Description
    extensionHandlers
    []VirtualMachineExtensionHandlerInstanceView_Status

    ExtensionHandlers: The virtual machine extension handler instance view.

    statuses
    []InstanceViewStatus_Status

    Statuses: The resource status information.

    vmAgentVersion
    string

    VmAgentVersion: The VM Agent full version.

    VirtualMachineAgentInstanceView_StatusARM

    (Appears on:VirtualMachineInstanceView_StatusARM)

    Field Description
    extensionHandlers
    []VirtualMachineExtensionHandlerInstanceView_StatusARM

    ExtensionHandlers: The virtual machine extension handler instance view.

    statuses
    []InstanceViewStatus_StatusARM

    Statuses: The resource status information.

    vmAgentVersion
    string

    VmAgentVersion: The VM Agent full version.

    VirtualMachineExtensionHandlerInstanceView_Status

    (Appears on:VirtualMachineAgentInstanceView_Status)

    Field Description
    status
    InstanceViewStatus_Status

    Status: The extension handler status.

    type
    string

    Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtensionHandlerInstanceView_StatusARM

    (Appears on:VirtualMachineAgentInstanceView_StatusARM)

    Field Description
    status
    InstanceViewStatus_StatusARM

    Status: The extension handler status.

    type
    string

    Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtensionInstanceView_Status

    (Appears on:VirtualMachineExtension_Status, VirtualMachineInstanceView_Status)

    Field Description
    name
    string

    Name: The virtual machine extension name.

    statuses
    []InstanceViewStatus_Status

    Statuses: The resource status information.

    substatuses
    []InstanceViewStatus_Status

    Substatuses: The resource status information.

    type
    string

    Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtensionInstanceView_StatusARM

    (Appears on:VirtualMachineExtensionProperties_StatusARM, VirtualMachineInstanceView_StatusARM)

    Field Description
    name
    string

    Name: The virtual machine extension name.

    statuses
    []InstanceViewStatus_StatusARM

    Statuses: The resource status information.

    substatuses
    []InstanceViewStatus_StatusARM

    Substatuses: The resource status information.

    type
    string

    Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtensionProperties_StatusARM

    (Appears on:VirtualMachineExtension_StatusARM)

    Field Description
    autoUpgradeMinorVersion
    bool

    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.

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

    forceUpdateTag
    string

    ForceUpdateTag: How the extension handler should be forced to update even if the extension configuration has not changed.

    instanceView
    VirtualMachineExtensionInstanceView_StatusARM

    InstanceView: The virtual machine extension instance view.

    protectedSettings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    ProtectedSettings: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    publisher
    string

    Publisher: The name of the extension handler publisher.

    settings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Settings: Json formatted public settings for the extension.

    type
    string

    Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtension_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    autoUpgradeMinorVersion
    bool

    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.

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

    forceUpdateTag
    string

    ForceUpdateTag: How the extension handler should be forced to update even if the extension configuration has not changed.

    id
    string

    Id: Resource Id

    instanceView
    VirtualMachineExtensionInstanceView_Status

    InstanceView: The virtual machine extension instance view.

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    properties_type
    string

    PropertiesType: Specifies the type of the extension; an example is “CustomScriptExtension”.

    protectedSettings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    ProtectedSettings: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    publisher
    string

    Publisher: The name of the extension handler publisher.

    settings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Settings: Json formatted public settings for the extension.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtension_StatusARM

    (Appears on:VirtualMachine_StatusARM)

    Field Description
    id
    string

    Id: Resource Id

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    properties
    VirtualMachineExtensionProperties_StatusARM
    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    VirtualMachineHealthStatus_Status

    (Appears on:VirtualMachineInstanceView_Status)

    Field Description
    status
    InstanceViewStatus_Status

    Status: The health status information for the VM.

    VirtualMachineHealthStatus_StatusARM

    (Appears on:VirtualMachineInstanceView_StatusARM)

    Field Description
    status
    InstanceViewStatus_StatusARM

    Status: The health status information for the VM.

    VirtualMachineIdentity

    (Appears on:VirtualMachines_Spec)

    Field Description
    type
    VirtualMachineIdentityType

    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.

    VirtualMachineIdentityARM

    (Appears on:VirtualMachines_SpecARM)

    Field Description
    type
    VirtualMachineIdentityType

    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.

    VirtualMachineIdentityStatusType (string alias)

    (Appears on:VirtualMachineIdentity_Status, VirtualMachineIdentity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineIdentityType (string alias)

    (Appears on:VirtualMachineIdentity, VirtualMachineIdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineIdentity_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    principalId
    string

    PrincipalId: The principal id of virtual machine identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.

    type
    VirtualMachineIdentityStatusType

    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_StatusARM

    (Appears on:VirtualMachine_StatusARM)

    Field Description
    principalId
    string

    PrincipalId: The principal id of virtual machine identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.

    type
    VirtualMachineIdentityStatusType

    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.

    VirtualMachineInstanceViewStatusHyperVGeneration (string alias)

    (Appears on:VirtualMachineInstanceView_Status, VirtualMachineInstanceView_StatusARM)

    Value Description

    "V1"

    "V2"

    VirtualMachineInstanceView_Status

    (Appears on:VirtualMachine_Status)

    Field Description
    assignedHost
    string

    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.

    bootDiagnostics
    BootDiagnosticsInstanceView_Status

    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.

    computerName
    string

    ComputerName: The computer name assigned to the virtual machine.

    disks
    []DiskInstanceView_Status

    Disks: The virtual machine disk information.

    extensions
    []VirtualMachineExtensionInstanceView_Status

    Extensions: The extensions information.

    hyperVGeneration
    VirtualMachineInstanceViewStatusHyperVGeneration

    HyperVGeneration: Specifies the HyperVGeneration Type associated with a resource

    maintenanceRedeployStatus
    MaintenanceRedeployStatus_Status

    MaintenanceRedeployStatus: The Maintenance Operation status on the virtual machine.

    osName
    string

    OsName: The Operating System running on the virtual machine.

    osVersion
    string

    OsVersion: The version of Operating System running on the virtual machine.

    patchStatus
    VirtualMachinePatchStatus_Status

    PatchStatus: [Preview Feature] The status of virtual machine patch operations.

    platformFaultDomain
    int

    PlatformFaultDomain: Specifies the fault domain of the virtual machine.

    platformUpdateDomain
    int

    PlatformUpdateDomain: Specifies the update domain of the virtual machine.

    rdpThumbPrint
    string

    RdpThumbPrint: The Remote desktop certificate thumbprint.

    statuses
    []InstanceViewStatus_Status

    Statuses: The resource status information.

    vmAgent
    VirtualMachineAgentInstanceView_Status

    VmAgent: The VM Agent running on the virtual machine.

    vmHealth
    VirtualMachineHealthStatus_Status

    VmHealth: The health status for the VM.

    VirtualMachineInstanceView_StatusARM

    (Appears on:VirtualMachineProperties_StatusARM)

    Field Description
    assignedHost
    string

    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.

    bootDiagnostics
    BootDiagnosticsInstanceView_StatusARM

    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.

    computerName
    string

    ComputerName: The computer name assigned to the virtual machine.

    disks
    []DiskInstanceView_StatusARM

    Disks: The virtual machine disk information.

    extensions
    []VirtualMachineExtensionInstanceView_StatusARM

    Extensions: The extensions information.

    hyperVGeneration
    VirtualMachineInstanceViewStatusHyperVGeneration

    HyperVGeneration: Specifies the HyperVGeneration Type associated with a resource

    maintenanceRedeployStatus
    MaintenanceRedeployStatus_StatusARM

    MaintenanceRedeployStatus: The Maintenance Operation status on the virtual machine.

    osName
    string

    OsName: The Operating System running on the virtual machine.

    osVersion
    string

    OsVersion: The version of Operating System running on the virtual machine.

    patchStatus
    VirtualMachinePatchStatus_StatusARM

    PatchStatus: [Preview Feature] The status of virtual machine patch operations.

    platformFaultDomain
    int

    PlatformFaultDomain: Specifies the fault domain of the virtual machine.

    platformUpdateDomain
    int

    PlatformUpdateDomain: Specifies the update domain of the virtual machine.

    rdpThumbPrint
    string

    RdpThumbPrint: The Remote desktop certificate thumbprint.

    statuses
    []InstanceViewStatus_StatusARM

    Statuses: The resource status information.

    vmAgent
    VirtualMachineAgentInstanceView_StatusARM

    VmAgent: The VM Agent running on the virtual machine.

    vmHealth
    VirtualMachineHealthStatus_StatusARM

    VmHealth: The health status for the VM.

    VirtualMachinePatchStatus_Status

    (Appears on:VirtualMachineInstanceView_Status)

    Field Description
    availablePatchSummary
    AvailablePatchSummary_Status

    AvailablePatchSummary: The available patch summary of the latest assessment operation for the virtual machine.

    configurationStatuses
    []InstanceViewStatus_Status

    ConfigurationStatuses: The enablement status of the specified patchMode

    lastPatchInstallationSummary
    LastPatchInstallationSummary_Status

    LastPatchInstallationSummary: The installation summary of the latest installation operation for the virtual machine.

    VirtualMachinePatchStatus_StatusARM

    (Appears on:VirtualMachineInstanceView_StatusARM)

    Field Description
    availablePatchSummary
    AvailablePatchSummary_StatusARM

    AvailablePatchSummary: The available patch summary of the latest assessment operation for the virtual machine.

    configurationStatuses
    []InstanceViewStatus_StatusARM

    ConfigurationStatuses: The enablement status of the specified patchMode

    lastPatchInstallationSummary
    LastPatchInstallationSummary_StatusARM

    LastPatchInstallationSummary: The installation summary of the latest installation operation for the virtual machine.

    VirtualMachineProperties_StatusARM

    (Appears on:VirtualMachine_StatusARM)

    Field Description
    additionalCapabilities
    AdditionalCapabilities_StatusARM

    AdditionalCapabilities: Specifies additional capabilities enabled or disabled on the virtual machine.

    availabilitySet
    SubResource_StatusARM

    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 Manage the availability of virtual machines. For more information on Azure planned maintenance, see Planned maintenance 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.

    billingProfile
    BillingProfile_StatusARM

    BillingProfile: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.

    diagnosticsProfile
    DiagnosticsProfile_StatusARM

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

    evictionPolicy
    EvictionPolicy_Status

    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.

    extensionsTimeBudget
    string

    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

    hardwareProfile
    HardwareProfile_StatusARM

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource_StatusARM

    Host: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.

    hostGroup
    SubResource_StatusARM

    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.

    instanceView
    VirtualMachineInstanceView_StatusARM

    InstanceView: The virtual machine instance view.

    licenseType
    string

    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

    networkProfile
    NetworkProfile_StatusARM

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    OSProfile_StatusARM

    OsProfile: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

    platformFaultDomain
    int

    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

  • priority
    Priority_Status

    Priority: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    proximityPlacementGroup
    SubResource_StatusARM

    ProximityPlacementGroup: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.

    securityProfile
    SecurityProfile_StatusARM

    SecurityProfile: Specifies the Security related profile settings for the virtual machine.

    storageProfile
    StorageProfile_StatusARM

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    virtualMachineScaleSet
    SubResource_StatusARM

    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

    vmId
    string

    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.

    VirtualMachineScaleSet

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualMachineScaleSets_Spec


    additionalCapabilities
    AdditionalCapabilities

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

    automaticRepairsPolicy
    AutomaticRepairsPolicy

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

    azureName
    string

    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.

    doNotRunExtensionsOnOverprovisionedVMs
    bool

    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    hostGroup
    SubResource
    identity
    VirtualMachineScaleSetIdentity

    Identity: Identity for the virtual machine scale set.

    location
    string

    Location: Location to deploy resource to

    orchestrationMode
    VirtualMachineScaleSetsSpecPropertiesOrchestrationMode

    OrchestrationMode: Specifies the orchestration mode for the virtual machine scale set.

    overprovision
    bool

    Overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    owner
    genruntime.KnownResourceReference

    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

    plan
    Plan

    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.

    platformFaultDomainCount
    int

    PlatformFaultDomainCount: Fault Domain count for each placement group.

    proximityPlacementGroup
    SubResource
    scaleInPolicy
    ScaleInPolicy

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

    singlePlacementGroup
    bool

    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.

    sku
    Sku

    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.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    upgradePolicy
    UpgradePolicy

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

    virtualMachineProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile

    VirtualMachineProfile: Describes a virtual machine scale set virtual machine profile.

    zoneBalance
    bool

    ZoneBalance: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    zones
    []string

    Zones: The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set

    status
    VirtualMachineScaleSet_Status

    VirtualMachineScaleSetDataDisk

    (Appears on:VirtualMachineScaleSetStorageProfile)

    Field Description
    caching
    VirtualMachineScaleSetDataDiskCaching

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

    createOption
    VirtualMachineScaleSetDataDiskCreateOption

    CreateOption: The create option.

    diskIOPSReadWrite
    int

    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.

    diskMBpsReadWrite
    int

    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.

    diskSizeGB
    int

    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

    lun
    int

    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.

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters

    ManagedDisk: Describes the parameters of a ScaleSet managed disk.

    name
    string

    Name: The disk name.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetDataDiskARM

    (Appears on:VirtualMachineScaleSetStorageProfileARM)

    Field Description
    caching
    VirtualMachineScaleSetDataDiskCaching

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

    createOption
    VirtualMachineScaleSetDataDiskCreateOption

    CreateOption: The create option.

    diskIOPSReadWrite
    int

    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.

    diskMBpsReadWrite
    int

    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.

    diskSizeGB
    int

    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

    lun
    int

    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.

    managedDisk
    VirtualMachineScaleSetManagedDiskParametersARM

    ManagedDisk: Describes the parameters of a ScaleSet managed disk.

    name
    string

    Name: The disk name.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetDataDiskCaching (string alias)

    (Appears on:VirtualMachineScaleSetDataDisk, VirtualMachineScaleSetDataDiskARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    VirtualMachineScaleSetDataDiskCreateOption (string alias)

    (Appears on:VirtualMachineScaleSetDataDisk, VirtualMachineScaleSetDataDiskARM)

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    VirtualMachineScaleSetDataDisk_Status

    (Appears on:VirtualMachineScaleSetStorageProfile_Status)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    CreateOption: The create option.

    diskIOPSReadWrite
    int

    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.

    diskMBpsReadWrite
    int

    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.

    diskSizeGB
    int

    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

    lun
    int

    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.

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters_Status

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetDataDisk_StatusARM

    (Appears on:VirtualMachineScaleSetStorageProfile_StatusARM)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    CreateOption: The create option.

    diskIOPSReadWrite
    int

    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.

    diskMBpsReadWrite
    int

    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.

    diskSizeGB
    int

    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

    lun
    int

    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.

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters_StatusARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetExtensionProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status)

    Field Description
    extensions
    []VirtualMachineScaleSetExtension_Status

    Extensions: The virtual machine scale set child extension resources.

    extensionsTimeBudget
    string

    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

    VirtualMachineScaleSetExtensionProfile_StatusARM

    (Appears on:VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    extensions
    []VirtualMachineScaleSetExtension_StatusARM

    Extensions: The virtual machine scale set child extension resources.

    extensionsTimeBudget
    string

    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

    VirtualMachineScaleSetExtensionProperties_StatusARM

    (Appears on:VirtualMachineScaleSetExtension_StatusARM)

    Field Description
    autoUpgradeMinorVersion
    bool

    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.

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

    forceUpdateTag
    string

    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.

    protectedSettings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    ProtectedSettings: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    provisionAfterExtensions
    []string

    ProvisionAfterExtensions: Collection of extension names after which this extension needs to be provisioned.

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    publisher
    string

    Publisher: The name of the extension handler publisher.

    settings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Settings: Json formatted public settings for the extension.

    type
    string

    Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSetExtension_Status

    (Appears on:VirtualMachineScaleSetExtensionProfile_Status)

    Field Description
    autoUpgradeMinorVersion
    bool

    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.

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

    forceUpdateTag
    string

    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.

    id
    string

    Id: Resource Id

    name
    string

    Name: The name of the extension.

    properties_type
    string

    PropertiesType: Specifies the type of the extension; an example is “CustomScriptExtension”.

    protectedSettings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    ProtectedSettings: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

    provisionAfterExtensions
    []string

    ProvisionAfterExtensions: Collection of extension names after which this extension needs to be provisioned.

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    publisher
    string

    Publisher: The name of the extension handler publisher.

    settings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Settings: Json formatted public settings for the extension.

    type
    string

    Type: Resource type

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSetExtension_StatusARM

    (Appears on:VirtualMachineScaleSetExtensionProfile_StatusARM)

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The name of the extension.

    properties
    VirtualMachineScaleSetExtensionProperties_StatusARM
    type
    string

    Type: Resource type

    VirtualMachineScaleSetIPConfigurationPropertiesStatusPrivateIPAddressVersion (string alias)

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_StatusARM, VirtualMachineScaleSetIPConfiguration_Status)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetIPConfigurationProperties_StatusARM

    (Appears on:VirtualMachineScaleSetIPConfiguration_StatusARM)

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_StatusARM

    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.

    applicationSecurityGroups
    []SubResource_StatusARM

    ApplicationSecurityGroups: Specifies an array of references to application security group.

    loadBalancerBackendAddressPools
    []SubResource_StatusARM

    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.

    loadBalancerInboundNatPools
    []SubResource_StatusARM

    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.

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    privateIPAddressVersion
    VirtualMachineScaleSetIPConfigurationPropertiesStatusPrivateIPAddressVersion

    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’.

    publicIPAddressConfiguration
    VirtualMachineScaleSetPublicIPAddressConfiguration_StatusARM

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    ApiEntityReference_StatusARM

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineScaleSetIPConfiguration_Status

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_Status)

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_Status

    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.

    applicationSecurityGroups
    []SubResource_Status

    ApplicationSecurityGroups: Specifies an array of references to application security group.

    id
    string

    Id: Resource Id

    loadBalancerBackendAddressPools
    []SubResource_Status

    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.

    loadBalancerInboundNatPools
    []SubResource_Status

    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.

    name
    string

    Name: The IP configuration name.

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    privateIPAddressVersion
    VirtualMachineScaleSetIPConfigurationPropertiesStatusPrivateIPAddressVersion

    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’.

    publicIPAddressConfiguration
    VirtualMachineScaleSetPublicIPAddressConfiguration_Status

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    ApiEntityReference_Status

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineScaleSetIPConfiguration_StatusARM

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_StatusARM)

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The IP configuration name.

    properties
    VirtualMachineScaleSetIPConfigurationProperties_StatusARM

    VirtualMachineScaleSetIdentity

    (Appears on:VirtualMachineScaleSets_Spec)

    Field Description
    type
    VirtualMachineScaleSetIdentityType

    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.

    VirtualMachineScaleSetIdentityARM

    (Appears on:VirtualMachineScaleSets_SpecARM)

    Field Description
    type
    VirtualMachineScaleSetIdentityType

    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.

    VirtualMachineScaleSetIdentityStatusType (string alias)

    (Appears on:VirtualMachineScaleSetIdentity_Status, VirtualMachineScaleSetIdentity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineScaleSetIdentityType (string alias)

    (Appears on:VirtualMachineScaleSetIdentity, VirtualMachineScaleSetIdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineScaleSetIdentity_Status

    (Appears on:VirtualMachineScaleSet_Status)

    Field Description
    principalId
    string

    PrincipalId: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.

    type
    VirtualMachineScaleSetIdentityStatusType

    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_StatusARM

    (Appears on:VirtualMachineScaleSet_StatusARM)

    Field Description
    principalId
    string

    PrincipalId: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.

    type
    VirtualMachineScaleSetIdentityStatusType

    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.

    VirtualMachineScaleSetIpTag

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfiguration)

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: IP tag associated with the public IP. Example: SQL, Storage etc.

    VirtualMachineScaleSetIpTagARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesARM)

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: IP tag associated with the public IP. Example: SQL, Storage etc.

    VirtualMachineScaleSetIpTag_Status

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration_Status)

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: IP tag associated with the public IP. Example: SQL, Storage etc.

    VirtualMachineScaleSetIpTag_StatusARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_StatusARM)

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: IP tag associated with the public IP. Example: SQL, Storage etc.

    VirtualMachineScaleSetManagedDiskParameters

    (Appears on:VirtualMachineScaleSetDataDisk, VirtualMachineScaleSetOSDisk)

    Field Description
    diskEncryptionSet
    DiskEncryptionSetParameters

    DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

    storageAccountType
    VirtualMachineScaleSetManagedDiskParametersStorageAccountType

    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.

    VirtualMachineScaleSetManagedDiskParametersARM

    (Appears on:VirtualMachineScaleSetDataDiskARM, VirtualMachineScaleSetOSDiskARM)

    Field Description
    diskEncryptionSet
    DiskEncryptionSetParametersARM

    DiskEncryptionSet: Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

    storageAccountType
    VirtualMachineScaleSetManagedDiskParametersStorageAccountType

    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.

    VirtualMachineScaleSetManagedDiskParametersStorageAccountType (string alias)

    (Appears on:VirtualMachineScaleSetManagedDiskParameters, VirtualMachineScaleSetManagedDiskParametersARM)

    Value Description

    "Premium_LRS"

    "Premium_ZRS"

    "Standard_LRS"

    "StandardSSD_LRS"

    "StandardSSD_ZRS"

    "UltraSSD_LRS"

    VirtualMachineScaleSetManagedDiskParameters_Status

    (Appears on:VirtualMachineScaleSetDataDisk_Status, VirtualMachineScaleSetOSDisk_Status)

    Field Description
    diskEncryptionSet
    SubResource_Status

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.

    storageAccountType
    StorageAccountType_Status

    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.

    VirtualMachineScaleSetManagedDiskParameters_StatusARM

    (Appears on:VirtualMachineScaleSetDataDisk_StatusARM, VirtualMachineScaleSetOSDisk_StatusARM)

    Field Description
    diskEncryptionSet
    SubResource_StatusARM

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.

    storageAccountType
    StorageAccountType_Status

    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.

    VirtualMachineScaleSetNetworkConfigurationDnsSettings

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations)

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationDnsSettingsARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_PropertiesARM)

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationDnsSettings_Status

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_Status)

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationDnsSettings_StatusARM

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_StatusARM)

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationProperties_StatusARM

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_StatusARM)

    Field Description
    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettings_StatusARM

    DnsSettings: The dns settings to be applied on the network interfaces.

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: Specifies whether the network interface is accelerated networking-enabled.

    enableFpga
    bool

    EnableFpga: Specifies whether the network interface is FPGA networking-enabled.

    enableIPForwarding
    bool

    EnableIPForwarding: Whether IP forwarding enabled on this NIC.

    ipConfigurations
    []VirtualMachineScaleSetIPConfiguration_StatusARM

    IpConfigurations: Specifies the IP configurations of the network interface.

    networkSecurityGroup
    SubResource_StatusARM

    NetworkSecurityGroup: The network security group.

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    VirtualMachineScaleSetNetworkConfiguration_Status

    (Appears on:VirtualMachineScaleSetNetworkProfile_Status)

    Field Description
    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettings_Status

    DnsSettings: The dns settings to be applied on the network interfaces.

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: Specifies whether the network interface is accelerated networking-enabled.

    enableFpga
    bool

    EnableFpga: Specifies whether the network interface is FPGA networking-enabled.

    enableIPForwarding
    bool

    EnableIPForwarding: Whether IP forwarding enabled on this NIC.

    id
    string

    Id: Resource Id

    ipConfigurations
    []VirtualMachineScaleSetIPConfiguration_Status

    IpConfigurations: Specifies the IP configurations of the network interface.

    name
    string

    Name: The network configuration name.

    networkSecurityGroup
    SubResource_Status

    NetworkSecurityGroup: The network security group.

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    VirtualMachineScaleSetNetworkConfiguration_StatusARM

    (Appears on:VirtualMachineScaleSetNetworkProfile_StatusARM)

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The network configuration name.

    properties
    VirtualMachineScaleSetNetworkConfigurationProperties_StatusARM

    VirtualMachineScaleSetNetworkProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status)

    Field Description
    healthProbe
    ApiEntityReference_Status

    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}’.

    networkInterfaceConfigurations
    []VirtualMachineScaleSetNetworkConfiguration_Status

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSetNetworkProfile_StatusARM

    (Appears on:VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    healthProbe
    ApiEntityReference_StatusARM

    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}’.

    networkInterfaceConfigurations
    []VirtualMachineScaleSetNetworkConfiguration_StatusARM

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSetOSDisk

    (Appears on:VirtualMachineScaleSetStorageProfile)

    Field Description
    caching
    VirtualMachineScaleSetOSDiskCaching

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

    createOption
    VirtualMachineScaleSetOSDiskCreateOption

    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.

    diffDiskSettings
    DiffDiskSettings

    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.

    diskSizeGB
    int

    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

    image
    VirtualHardDisk

    Image: Describes the uri of a disk.

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters

    ManagedDisk: Describes the parameters of a ScaleSet managed disk.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDiskOsType

    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.

    vhdContainers
    []string

    VhdContainers: Specifies the container urls that are used to store operating system disks for the scale set.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetOSDiskARM

    (Appears on:VirtualMachineScaleSetStorageProfileARM)

    Field Description
    caching
    VirtualMachineScaleSetOSDiskCaching

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

    createOption
    VirtualMachineScaleSetOSDiskCreateOption

    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.

    diffDiskSettings
    DiffDiskSettingsARM

    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.

    diskSizeGB
    int

    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

    image
    VirtualHardDiskARM

    Image: Describes the uri of a disk.

    managedDisk
    VirtualMachineScaleSetManagedDiskParametersARM

    ManagedDisk: Describes the parameters of a ScaleSet managed disk.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDiskOsType

    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.

    vhdContainers
    []string

    VhdContainers: Specifies the container urls that are used to store operating system disks for the scale set.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetOSDiskCaching (string alias)

    (Appears on:VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDiskARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    VirtualMachineScaleSetOSDiskCreateOption (string alias)

    (Appears on:VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDiskARM)

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    VirtualMachineScaleSetOSDiskOsType (string alias)

    (Appears on:VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDiskARM)

    Value Description

    "Linux"

    "Windows"

    VirtualMachineScaleSetOSDiskStatusOsType (string alias)

    (Appears on:VirtualMachineScaleSetOSDisk_Status, VirtualMachineScaleSetOSDisk_StatusARM)

    Value Description

    "Linux"

    "Windows"

    VirtualMachineScaleSetOSDisk_Status

    (Appears on:VirtualMachineScaleSetStorageProfile_Status)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    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.

    diffDiskSettings
    DiffDiskSettings_Status

    DiffDiskSettings: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.

    diskSizeGB
    int

    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

    image
    VirtualHardDisk_Status

    Image: Specifies information about the unmanaged user image to base the scale set on.

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters_Status

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDiskStatusOsType

    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

    vhdContainers
    []string

    VhdContainers: Specifies the container urls that are used to store operating system disks for the scale set.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetOSDisk_StatusARM

    (Appears on:VirtualMachineScaleSetStorageProfile_StatusARM)

    Field Description
    caching
    Caching_Status

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

    createOption
    CreateOption_Status

    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.

    diffDiskSettings
    DiffDiskSettings_StatusARM

    DiffDiskSettings: Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.

    diskSizeGB
    int

    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

    image
    VirtualHardDisk_StatusARM

    Image: Specifies information about the unmanaged user image to base the scale set on.

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters_StatusARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDiskStatusOsType

    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

    vhdContainers
    []string

    VhdContainers: Specifies the container urls that are used to store operating system disks for the scale set.

    writeAcceleratorEnabled
    bool

    WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

    VirtualMachineScaleSetOSProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status)

    Field Description
    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • computerNamePrefix
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    linuxConfiguration
    LinuxConfiguration_Status

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    secrets
    []VaultSecretGroup_Status

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    WindowsConfiguration_Status

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    VirtualMachineScaleSetOSProfile_StatusARM

    (Appears on:VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • computerNamePrefix
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    linuxConfiguration
    LinuxConfiguration_StatusARM

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    secrets
    []VaultSecretGroup_StatusARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    WindowsConfiguration_StatusARM

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    VirtualMachineScaleSetProperties_StatusARM

    (Appears on:VirtualMachineScaleSet_StatusARM)

    Field Description
    additionalCapabilities
    AdditionalCapabilities_StatusARM

    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.

    automaticRepairsPolicy
    AutomaticRepairsPolicy_StatusARM

    AutomaticRepairsPolicy: Policy for automatic repairs.

    doNotRunExtensionsOnOverprovisionedVMs
    bool

    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.

    hostGroup
    SubResource_StatusARM

    HostGroup: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.

    orchestrationMode
    OrchestrationMode_Status

    OrchestrationMode: Specifies the orchestration mode for the virtual machine scale set.

    overprovision
    bool

    Overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    platformFaultDomainCount
    int

    PlatformFaultDomainCount: Fault Domain count for each placement group.

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    proximityPlacementGroup
    SubResource_StatusARM

    ProximityPlacementGroup: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.

    scaleInPolicy
    ScaleInPolicy_StatusARM

    ScaleInPolicy: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.

    singlePlacementGroup
    bool

    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.

    uniqueId
    string

    UniqueId: Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

    upgradePolicy
    UpgradePolicy_StatusARM

    UpgradePolicy: The upgrade policy.

    virtualMachineProfile
    VirtualMachineScaleSetVMProfile_StatusARM

    VirtualMachineProfile: The virtual machine profile.

    zoneBalance
    bool

    ZoneBalance: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfiguration)

    Field Description
    domainNameLabel
    string

    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

    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesARM)

    Field Description
    domainNameLabel
    string

    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

    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_Status

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration_Status)

    Field Description
    domainNameLabel
    string

    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

    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_StatusARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_StatusARM)

    Field Description
    domainNameLabel
    string

    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

    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfigurationARM)

    Field Description
    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsARM

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineScaleSetIpTagARM

    IpTags: The list of IP tags associated with the public IP address.

    publicIPAddressVersion
    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesPublicIPAddressVersion

    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’.

    publicIPPrefix
    SubResourceARM

    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesPublicIPAddressVersion (string alias)

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesARM, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfiguration)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesStatusPublicIPAddressVersion (string alias)

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_StatusARM, VirtualMachineScaleSetPublicIPAddressConfiguration_Status)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_StatusARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration_StatusARM)

    Field Description
    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_StatusARM

    DnsSettings: The dns settings to be applied on the publicIP addresses .

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineScaleSetIpTag_StatusARM

    IpTags: The list of IP tags associated with the public IP address.

    publicIPAddressVersion
    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesStatusPublicIPAddressVersion

    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’.

    publicIPPrefix
    SubResource_StatusARM

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    VirtualMachineScaleSetPublicIPAddressConfiguration_Status

    (Appears on:VirtualMachineScaleSetIPConfiguration_Status)

    Field Description
    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_Status

    DnsSettings: The dns settings to be applied on the publicIP addresses .

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineScaleSetIpTag_Status

    IpTags: The list of IP tags associated with the public IP address.

    name
    string

    Name: The publicIP address configuration name.

    publicIPAddressVersion
    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesStatusPublicIPAddressVersion

    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’.

    publicIPPrefix
    SubResource_Status

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    VirtualMachineScaleSetPublicIPAddressConfiguration_StatusARM

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_StatusARM)

    Field Description
    name
    string

    Name: The publicIP address configuration name.

    properties
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_StatusARM

    VirtualMachineScaleSetStorageProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile)

    Field Description
    dataDisks
    []VirtualMachineScaleSetDataDisk

    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.

    imageReference
    ImageReference

    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.

    osDisk
    VirtualMachineScaleSetOSDisk

    OsDisk: Describes a virtual machine scale set operating system disk.

    VirtualMachineScaleSetStorageProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Field Description
    dataDisks
    []VirtualMachineScaleSetDataDiskARM

    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.

    imageReference
    ImageReferenceARM

    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.

    osDisk
    VirtualMachineScaleSetOSDiskARM

    OsDisk: Describes a virtual machine scale set operating system disk.

    VirtualMachineScaleSetStorageProfile_Status

    (Appears on:VirtualMachineScaleSetVMProfile_Status)

    Field Description
    dataDisks
    []VirtualMachineScaleSetDataDisk_Status

    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.

    imageReference
    ImageReference_Status

    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.

    osDisk
    VirtualMachineScaleSetOSDisk_Status

    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.

    VirtualMachineScaleSetStorageProfile_StatusARM

    (Appears on:VirtualMachineScaleSetVMProfile_StatusARM)

    Field Description
    dataDisks
    []VirtualMachineScaleSetDataDisk_StatusARM

    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.

    imageReference
    ImageReference_StatusARM

    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.

    osDisk
    VirtualMachineScaleSetOSDisk_StatusARM

    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.

    VirtualMachineScaleSetVMProfile_Status

    (Appears on:VirtualMachineScaleSet_Status)

    Field Description
    billingProfile
    BillingProfile_Status

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

    diagnosticsProfile
    DiagnosticsProfile_Status

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

    evictionPolicy
    EvictionPolicy_Status

    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.

    extensionProfile
    VirtualMachineScaleSetExtensionProfile_Status

    ExtensionProfile: Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    licenseType
    string

    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

    networkProfile
    VirtualMachineScaleSetNetworkProfile_Status

    NetworkProfile: Specifies properties of the network interfaces of the virtual machines in the scale set.

    osProfile
    VirtualMachineScaleSetOSProfile_Status

    OsProfile: Specifies the operating system settings for the virtual machines in the scale set.

    priority
    Priority_Status

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

    scheduledEventsProfile
    ScheduledEventsProfile_Status

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile_Status

    SecurityProfile: Specifies the Security related profile settings for the virtual machines in the scale set.

    storageProfile
    VirtualMachineScaleSetStorageProfile_Status

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    VirtualMachineScaleSetVMProfile_StatusARM

    (Appears on:VirtualMachineScaleSetProperties_StatusARM)

    Field Description
    billingProfile
    BillingProfile_StatusARM

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

    diagnosticsProfile
    DiagnosticsProfile_StatusARM

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

    evictionPolicy
    EvictionPolicy_Status

    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.

    extensionProfile
    VirtualMachineScaleSetExtensionProfile_StatusARM

    ExtensionProfile: Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    licenseType
    string

    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

    networkProfile
    VirtualMachineScaleSetNetworkProfile_StatusARM

    NetworkProfile: Specifies properties of the network interfaces of the virtual machines in the scale set.

    osProfile
    VirtualMachineScaleSetOSProfile_StatusARM

    OsProfile: Specifies the operating system settings for the virtual machines in the scale set.

    priority
    Priority_Status

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

    scheduledEventsProfile
    ScheduledEventsProfile_StatusARM

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile_StatusARM

    SecurityProfile: Specifies the Security related profile settings for the virtual machines in the scale set.

    storageProfile
    VirtualMachineScaleSetStorageProfile_StatusARM

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    VirtualMachineScaleSet_Status

    (Appears on:VirtualMachineScaleSet)

    Field Description
    additionalCapabilities
    AdditionalCapabilities_Status

    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.

    automaticRepairsPolicy
    AutomaticRepairsPolicy_Status

    AutomaticRepairsPolicy: Policy for automatic repairs.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    doNotRunExtensionsOnOverprovisionedVMs
    bool

    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.

    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the Virtual Machine Scale Set.

    hostGroup
    SubResource_Status

    HostGroup: Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.

    id
    string

    Id: Resource Id

    identity
    VirtualMachineScaleSetIdentity_Status

    Identity: The identity of the virtual machine scale set, if configured.

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    orchestrationMode
    OrchestrationMode_Status

    OrchestrationMode: Specifies the orchestration mode for the virtual machine scale set.

    overprovision
    bool

    Overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    plan
    Plan_Status

    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.

    platformFaultDomainCount
    int

    PlatformFaultDomainCount: Fault Domain count for each placement group.

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    proximityPlacementGroup
    SubResource_Status

    ProximityPlacementGroup: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.

    scaleInPolicy
    ScaleInPolicy_Status

    ScaleInPolicy: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.

    singlePlacementGroup
    bool

    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.

    sku
    Sku_Status

    Sku: The virtual machine scale set sku.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    uniqueId
    string

    UniqueId: Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

    upgradePolicy
    UpgradePolicy_Status

    UpgradePolicy: The upgrade policy.

    virtualMachineProfile
    VirtualMachineScaleSetVMProfile_Status

    VirtualMachineProfile: The virtual machine profile.

    zoneBalance
    bool

    ZoneBalance: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    zones
    []string

    Zones: The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set

    VirtualMachineScaleSet_StatusARM

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the Virtual Machine Scale Set.

    id
    string

    Id: Resource Id

    identity
    VirtualMachineScaleSetIdentity_StatusARM

    Identity: The identity of the virtual machine scale set, if configured.

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    plan
    Plan_StatusARM

    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.

    properties
    VirtualMachineScaleSetProperties_StatusARM
    sku
    Sku_StatusARM

    Sku: The virtual machine scale set sku.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    zones
    []string

    Zones: The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set

    VirtualMachineScaleSetsSpecPropertiesOrchestrationMode (string alias)

    (Appears on:VirtualMachineScaleSets_Spec, VirtualMachineScaleSets_Spec_PropertiesARM)

    Value Description

    "Flexible"

    "Uniform"

    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfileEvictionPolicy (string alias)

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Value Description

    "Deallocate"

    "Delete"

    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfileNetworkProfileNetworkInterfaceConfigurationsPropertiesIpConfigurationsPropertiesPrivateIPAddressVersion (string alias)

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_PropertiesARM)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfilePriority (string alias)

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile, VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Value Description

    "Low"

    "Regular"

    "Spot"

    VirtualMachineScaleSets_Spec

    (Appears on:VirtualMachineScaleSet)

    Field Description
    additionalCapabilities
    AdditionalCapabilities

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

    automaticRepairsPolicy
    AutomaticRepairsPolicy

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

    azureName
    string

    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.

    doNotRunExtensionsOnOverprovisionedVMs
    bool

    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    hostGroup
    SubResource
    identity
    VirtualMachineScaleSetIdentity

    Identity: Identity for the virtual machine scale set.

    location
    string

    Location: Location to deploy resource to

    orchestrationMode
    VirtualMachineScaleSetsSpecPropertiesOrchestrationMode

    OrchestrationMode: Specifies the orchestration mode for the virtual machine scale set.

    overprovision
    bool

    Overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    owner
    genruntime.KnownResourceReference

    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

    plan
    Plan

    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.

    platformFaultDomainCount
    int

    PlatformFaultDomainCount: Fault Domain count for each placement group.

    proximityPlacementGroup
    SubResource
    scaleInPolicy
    ScaleInPolicy

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

    singlePlacementGroup
    bool

    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.

    sku
    Sku

    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.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    upgradePolicy
    UpgradePolicy

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

    virtualMachineProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile

    VirtualMachineProfile: Describes a virtual machine scale set virtual machine profile.

    zoneBalance
    bool

    ZoneBalance: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    zones
    []string

    Zones: The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set

    VirtualMachineScaleSets_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The complex type of the extended location.

    identity
    VirtualMachineScaleSetIdentityARM

    Identity: Identity for the virtual machine scale set.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the VM scale set to create or update.

    plan
    PlanARM

    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.

    properties
    VirtualMachineScaleSets_Spec_PropertiesARM

    Properties: Describes the properties of a Virtual Machine Scale Set.

    sku
    SkuARM

    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.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set

    VirtualMachineScaleSets_Spec_PropertiesARM

    (Appears on:VirtualMachineScaleSets_SpecARM)

    Field Description
    additionalCapabilities
    AdditionalCapabilitiesARM

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

    automaticRepairsPolicy
    AutomaticRepairsPolicyARM

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

    doNotRunExtensionsOnOverprovisionedVMs
    bool

    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.

    hostGroup
    SubResourceARM
    orchestrationMode
    VirtualMachineScaleSetsSpecPropertiesOrchestrationMode

    OrchestrationMode: Specifies the orchestration mode for the virtual machine scale set.

    overprovision
    bool

    Overprovision: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    platformFaultDomainCount
    int

    PlatformFaultDomainCount: Fault Domain count for each placement group.

    proximityPlacementGroup
    SubResourceARM
    scaleInPolicy
    ScaleInPolicyARM

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

    singlePlacementGroup
    bool

    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.

    upgradePolicy
    UpgradePolicyARM

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

    virtualMachineProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM

    VirtualMachineProfile: Describes a virtual machine scale set virtual machine profile.

    zoneBalance
    bool

    ZoneBalance: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile

    (Appears on:VirtualMachineScaleSets_Spec)

    Field Description
    billingProfile
    BillingProfile

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

    diagnosticsProfile
    DiagnosticsProfile

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

    evictionPolicy
    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfileEvictionPolicy

    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.

    extensionProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile

    ExtensionProfile: Describes a virtual machine scale set extension profile.

    licenseType
    string

    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

    networkProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile

    NetworkProfile: Describes a virtual machine scale set network profile.

    osProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfile

    OsProfile: Describes a virtual machine scale set OS profile.

    priority
    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfilePriority

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

    scheduledEventsProfile
    ScheduledEventsProfile
    securityProfile
    SecurityProfile

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

    storageProfile
    VirtualMachineScaleSetStorageProfile

    StorageProfile: Describes a virtual machine scale set storage profile.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_PropertiesARM)

    Field Description
    billingProfile
    BillingProfileARM

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

    diagnosticsProfile
    DiagnosticsProfileARM

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

    evictionPolicy
    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfileEvictionPolicy

    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.

    extensionProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfileARM

    ExtensionProfile: Describes a virtual machine scale set extension profile.

    licenseType
    string

    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

    networkProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfileARM

    NetworkProfile: Describes a virtual machine scale set network profile.

    osProfile
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfileARM

    OsProfile: Describes a virtual machine scale set OS profile.

    priority
    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfilePriority

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

    scheduledEventsProfile
    ScheduledEventsProfileARM
    securityProfile
    SecurityProfileARM

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

    storageProfile
    VirtualMachineScaleSetStorageProfileARM

    StorageProfile: Describes a virtual machine scale set storage profile.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile)

    Field Description
    extensions
    []VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile_Extensions

    Extensions: The virtual machine scale set child extension resources.

    extensionsTimeBudget
    string

    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

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Field Description
    extensions
    []VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile_ExtensionsARM

    Extensions: The virtual machine scale set child extension resources.

    extensionsTimeBudget
    string

    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

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile_Extensions

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile)

    Field Description
    name
    string

    Name: The name of the extension.

    publisher
    string

    Publisher: Microsoft.Compute/extensions - Publisher

    settings
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Settings: Microsoft.Compute/extensions - Settings

    type
    string

    Type: Microsoft.Compute/extensions - Type

    typeHandlerVersion
    string

    TypeHandlerVersion: Microsoft.Compute/extensions - Type handler version

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfile_ExtensionsARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_ExtensionProfileARM)

    Field Description
    name
    string

    Name: The name of the extension.

    properties
    GenericExtensionARM

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile)

    Field Description
    healthProbe
    ApiEntityReference

    HealthProbe: The API entity reference.

    networkInterfaceConfigurations
    []VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Field Description
    healthProbe
    ApiEntityReferenceARM

    HealthProbe: The API entity reference.

    networkInterfaceConfigurations
    []VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurationsARM

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile)

    Field Description
    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettings

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

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: Specifies whether the network interface is accelerated networking-enabled.

    enableFpga
    bool

    EnableFpga: Specifies whether the network interface is FPGA networking-enabled.

    enableIPForwarding
    bool

    EnableIPForwarding: Whether IP forwarding enabled on this NIC.

    id
    string

    Id: Resource Id

    ipConfigurations
    []VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations

    IpConfigurations: Specifies the IP configurations of the network interface.

    name
    string

    Name: The network configuration name.

    networkSecurityGroup
    SubResource
    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurationsARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfileARM)

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The network configuration name.

    properties
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_PropertiesARM

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

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_PropertiesARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurationsARM)

    Field Description
    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettingsARM

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

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: Specifies whether the network interface is accelerated networking-enabled.

    enableFpga
    bool

    EnableFpga: Specifies whether the network interface is FPGA networking-enabled.

    enableIPForwarding
    bool

    EnableIPForwarding: Whether IP forwarding enabled on this NIC.

    ipConfigurations
    []VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurationsARM

    IpConfigurations: Specifies the IP configurations of the network interface.

    networkSecurityGroup
    SubResourceARM
    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations)

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource

    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.

    applicationSecurityGroups
    []SubResource

    ApplicationSecurityGroups: Specifies an array of references to application security group.

    id
    string

    Id: Resource Id

    loadBalancerBackendAddressPools
    []SubResource

    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.

    loadBalancerInboundNatPools
    []SubResource

    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.

    name
    string

    Name: The IP configuration name.

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    privateIPAddressVersion
    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfileNetworkProfileNetworkInterfaceConfigurationsPropertiesIpConfigurationsPropertiesPrivateIPAddressVersion

    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’.

    publicIPAddressConfiguration
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfiguration

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

    subnet
    ApiEntityReference

    Subnet: The API entity reference.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurationsARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_PropertiesARM)

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The IP configuration name.

    properties
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_PropertiesARM

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

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_PropertiesARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurationsARM)

    Field Description
    applicationGatewayBackendAddressPools
    []SubResourceARM

    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.

    applicationSecurityGroups
    []SubResourceARM

    ApplicationSecurityGroups: Specifies an array of references to application security group.

    loadBalancerBackendAddressPools
    []SubResourceARM

    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.

    loadBalancerInboundNatPools
    []SubResourceARM

    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.

    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    privateIPAddressVersion
    VirtualMachineScaleSetsSpecPropertiesVirtualMachineProfileNetworkProfileNetworkInterfaceConfigurationsPropertiesIpConfigurationsPropertiesPrivateIPAddressVersion

    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’.

    publicIPAddressConfiguration
    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfigurationARM

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

    subnet
    ApiEntityReferenceARM

    Subnet: The API entity reference.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfiguration

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations)

    Field Description
    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineScaleSetIpTag

    IpTags: The list of IP tags associated with the public IP address.

    name
    string

    Name: The publicIP address configuration name.

    publicIPAddressVersion
    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesPublicIPAddressVersion

    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’.

    publicIPPrefix
    SubResource

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_Properties_PublicIPAddressConfigurationARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_NetworkProfile_NetworkInterfaceConfigurations_Properties_IpConfigurations_PropertiesARM)

    Field Description
    name
    string

    Name: The publicIP address configuration name.

    properties
    VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesARM

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

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfile

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile)

    Field Description
    adminPassword
    genruntime.SecretReference

    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

    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • computerNamePrefix
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    linuxConfiguration
    LinuxConfiguration

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    secrets
    []VaultSecretGroup

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    WindowsConfiguration

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfileARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfileARM)

    Field Description
    adminPassword
    string

    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

    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • computerNamePrefix
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    linuxConfiguration
    LinuxConfigurationARM

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    secrets
    []VaultSecretGroupARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    WindowsConfigurationARM

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    VirtualMachine_Status

    (Appears on:VirtualMachine)

    Field Description
    additionalCapabilities
    AdditionalCapabilities_Status

    AdditionalCapabilities: Specifies additional capabilities enabled or disabled on the virtual machine.

    availabilitySet
    SubResource_Status

    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 Manage the availability of virtual machines. For more information on Azure planned maintenance, see Planned maintenance 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.

    billingProfile
    BillingProfile_Status

    BillingProfile: Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    diagnosticsProfile
    DiagnosticsProfile_Status

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

    evictionPolicy
    EvictionPolicy_Status

    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.

    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the Virtual Machine.

    extensionsTimeBudget
    string

    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

    hardwareProfile
    HardwareProfile_Status

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource_Status

    Host: Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.

    hostGroup
    SubResource_Status

    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.

    id
    string

    Id: Resource Id

    identity
    VirtualMachineIdentity_Status

    Identity: The identity of the virtual machine, if configured.

    instanceView
    VirtualMachineInstanceView_Status

    InstanceView: The virtual machine instance view.

    licenseType
    string

    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

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    networkProfile
    NetworkProfile_Status

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    OSProfile_Status

    OsProfile: Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

    plan
    Plan_Status

    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.

    platformFaultDomain
    int

    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

  • priority
    Priority_Status

    Priority: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01

    provisioningState
    string

    ProvisioningState: The provisioning state, which only appears in the response.

    proximityPlacementGroup
    SubResource_Status

    ProximityPlacementGroup: Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.

    resources
    []VirtualMachineExtension_Status

    Resources: The virtual machine child extension resources.

    securityProfile
    SecurityProfile_Status

    SecurityProfile: Specifies the Security related profile settings for the virtual machine.

    storageProfile
    StorageProfile_Status

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    virtualMachineScaleSet
    SubResource_Status

    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

    vmId
    string

    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.

    zones
    []string

    Zones: The virtual machine zones.

    VirtualMachine_StatusARM

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the Virtual Machine.

    id
    string

    Id: Resource Id

    identity
    VirtualMachineIdentity_StatusARM

    Identity: The identity of the virtual machine, if configured.

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    plan
    Plan_StatusARM

    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.

    properties
    VirtualMachineProperties_StatusARM
    resources
    []VirtualMachineExtension_StatusARM

    Resources: The virtual machine child extension resources.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    zones
    []string

    Zones: The virtual machine zones.

    VirtualMachinesSpecPropertiesEvictionPolicy (string alias)

    (Appears on:VirtualMachines_Spec, VirtualMachines_Spec_PropertiesARM)

    Value Description

    "Deallocate"

    "Delete"

    VirtualMachinesSpecPropertiesPriority (string alias)

    (Appears on:VirtualMachines_Spec, VirtualMachines_Spec_PropertiesARM)

    Value Description

    "Low"

    "Regular"

    "Spot"

    VirtualMachines_Spec

    (Appears on:VirtualMachine)

    Field Description
    additionalCapabilities
    AdditionalCapabilities

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

    availabilitySet
    SubResource
    azureName
    string

    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.

    billingProfile
    BillingProfile

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

    diagnosticsProfile
    DiagnosticsProfile

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

    evictionPolicy
    VirtualMachinesSpecPropertiesEvictionPolicy

    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The complex type of the extended location.

    extensionsTimeBudget
    string

    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

    hardwareProfile
    HardwareProfile

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource
    hostGroup
    SubResource
    identity
    VirtualMachineIdentity

    Identity: Identity for the virtual machine.

    licenseType
    string

    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

    location
    string

    Location: Location to deploy resource to

    networkProfile
    VirtualMachines_Spec_Properties_NetworkProfile

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    VirtualMachines_Spec_Properties_OsProfile

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

    owner
    genruntime.KnownResourceReference

    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

    plan
    Plan

    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.

    platformFaultDomain
    int

    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

  • priority
    VirtualMachinesSpecPropertiesPriority

    Priority: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01.

    proximityPlacementGroup
    SubResource
    securityProfile
    SecurityProfile

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

    storageProfile
    StorageProfile

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    virtualMachineScaleSet
    SubResource
    zones
    []string

    Zones: The virtual machine zones.

    VirtualMachines_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The complex type of the extended location.

    identity
    VirtualMachineIdentityARM

    Identity: Identity for the virtual machine.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: The name of the virtual machine.

    plan
    PlanARM

    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.

    properties
    VirtualMachines_Spec_PropertiesARM

    Properties: Describes the properties of a Virtual Machine.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

    Zones: The virtual machine zones.

    VirtualMachines_Spec_PropertiesARM

    (Appears on:VirtualMachines_SpecARM)

    Field Description
    additionalCapabilities
    AdditionalCapabilitiesARM

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

    availabilitySet
    SubResourceARM
    billingProfile
    BillingProfileARM

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

    diagnosticsProfile
    DiagnosticsProfileARM

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

    evictionPolicy
    VirtualMachinesSpecPropertiesEvictionPolicy

    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.

    extensionsTimeBudget
    string

    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

    hardwareProfile
    HardwareProfileARM

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResourceARM
    hostGroup
    SubResourceARM
    licenseType
    string

    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

    networkProfile
    VirtualMachines_Spec_Properties_NetworkProfileARM

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    VirtualMachines_Spec_Properties_OsProfileARM

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

    platformFaultDomain
    int

    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

  • priority
    VirtualMachinesSpecPropertiesPriority

    Priority: Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01.

    proximityPlacementGroup
    SubResourceARM
    securityProfile
    SecurityProfileARM

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

    storageProfile
    StorageProfileARM

    StorageProfile: Specifies the storage settings for the virtual machine disks.

    virtualMachineScaleSet
    SubResourceARM

    VirtualMachines_Spec_Properties_NetworkProfile

    (Appears on:VirtualMachines_Spec)

    Field Description
    networkInterfaces
    []VirtualMachines_Spec_Properties_NetworkProfile_NetworkInterfaces

    NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

    VirtualMachines_Spec_Properties_NetworkProfileARM

    (Appears on:VirtualMachines_Spec_PropertiesARM)

    Field Description
    networkInterfaces
    []VirtualMachines_Spec_Properties_NetworkProfile_NetworkInterfacesARM

    NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

    VirtualMachines_Spec_Properties_NetworkProfile_NetworkInterfaces

    (Appears on:VirtualMachines_Spec_Properties_NetworkProfile)

    Field Description
    primary
    bool

    Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    reference
    genruntime.ResourceReference

    Reference: Resource Id

    VirtualMachines_Spec_Properties_NetworkProfile_NetworkInterfacesARM

    (Appears on:VirtualMachines_Spec_Properties_NetworkProfileARM)

    Field Description
    id
    string
    properties
    NetworkInterfaceReferencePropertiesARM

    Properties: Describes a network interface reference properties.

    VirtualMachines_Spec_Properties_OsProfile

    (Appears on:VirtualMachines_Spec)

    Field Description
    adminPassword
    genruntime.SecretReference

    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

    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • allowExtensionOperations
    bool

    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.

    computerName
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. 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

    linuxConfiguration
    LinuxConfiguration

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. Note: This property is for private testing only, and all customers must not set the property to false.

    secrets
    []VaultSecretGroup

    Secrets: Specifies set of certificates that should be installed onto the virtual machine.

    windowsConfiguration
    WindowsConfiguration

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    VirtualMachines_Spec_Properties_OsProfileARM

    (Appears on:VirtualMachines_Spec_PropertiesARM)

    Field Description
    adminPassword
    string

    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

    adminUsername
    string

    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

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • allowExtensionOperations
    bool

    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.

    computerName
    string

    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.

    customData
    string

    CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. 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

    linuxConfiguration
    LinuxConfigurationARM

    LinuxConfiguration: Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Specifies whether the guest provision signal is required to infer provision success of the virtual machine. Note: This property is for private testing only, and all customers must not set the property to false.

    secrets
    []VaultSecretGroupARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machine.

    windowsConfiguration
    WindowsConfigurationARM

    WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

    WinRMConfiguration

    (Appears on:WindowsConfiguration)

    Field Description
    listeners
    []WinRMListener

    Listeners: The list of Windows Remote Management listeners

    WinRMConfigurationARM

    (Appears on:WindowsConfigurationARM)

    Field Description
    listeners
    []WinRMListenerARM

    Listeners: The list of Windows Remote Management listeners

    WinRMConfiguration_Status

    (Appears on:WindowsConfiguration_Status)

    Field Description
    listeners
    []WinRMListener_Status

    Listeners: The list of Windows Remote Management listeners

    WinRMConfiguration_StatusARM

    (Appears on:WindowsConfiguration_StatusARM)

    Field Description
    listeners
    []WinRMListener_StatusARM

    Listeners: The list of Windows Remote Management listeners

    WinRMListener

    (Appears on:WinRMConfiguration)

    Field Description
    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    protocol
    WinRMListenerProtocol

    Protocol: Specifies the protocol of WinRM listener. Possible values are: http https.

    WinRMListenerARM

    (Appears on:WinRMConfigurationARM)

    Field Description
    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    protocol
    WinRMListenerProtocol

    Protocol: Specifies the protocol of WinRM listener. Possible values are: http https.

    WinRMListenerProtocol (string alias)

    (Appears on:WinRMListener, WinRMListenerARM)

    Value Description

    "Http"

    "Https"

    WinRMListenerStatusProtocol (string alias)

    (Appears on:WinRMListener_Status, WinRMListener_StatusARM)

    Value Description

    "Http"

    "Https"

    WinRMListener_Status

    (Appears on:WinRMConfiguration_Status)

    Field Description
    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    protocol
    WinRMListenerStatusProtocol

    Protocol: Specifies the protocol of WinRM listener. Possible values are: http https

    WinRMListener_StatusARM

    (Appears on:WinRMConfiguration_StatusARM)

    Field Description
    certificateUrl
    string

    CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” }

    protocol
    WinRMListenerStatusProtocol

    Protocol: Specifies the protocol of WinRM listener. Possible values are: http https

    WindowsConfiguration

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfile, VirtualMachines_Spec_Properties_OsProfile)

    Field Description
    additionalUnattendContent
    []AdditionalUnattendContent

    AdditionalUnattendContent: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    enableAutomaticUpdates
    bool

    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.

    patchSettings
    PatchSettings

    PatchSettings: Specifies settings related to VM Guest Patching on Windows.

    provisionVMAgent
    bool

    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.

    timeZone
    string

    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.

    winRM
    WinRMConfiguration

    WinRM: Describes Windows Remote Management configuration of the VM

    WindowsConfigurationARM

    (Appears on:VirtualMachineScaleSets_Spec_Properties_VirtualMachineProfile_OsProfileARM, VirtualMachines_Spec_Properties_OsProfileARM)

    Field Description
    additionalUnattendContent
    []AdditionalUnattendContentARM

    AdditionalUnattendContent: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    enableAutomaticUpdates
    bool

    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.

    patchSettings
    PatchSettingsARM

    PatchSettings: Specifies settings related to VM Guest Patching on Windows.

    provisionVMAgent
    bool

    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.

    timeZone
    string

    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.

    winRM
    WinRMConfigurationARM

    WinRM: Describes Windows Remote Management configuration of the VM

    WindowsConfiguration_Status

    (Appears on:OSProfile_Status, VirtualMachineScaleSetOSProfile_Status)

    Field Description
    additionalUnattendContent
    []AdditionalUnattendContent_Status

    AdditionalUnattendContent: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    enableAutomaticUpdates
    bool

    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.

    patchSettings
    PatchSettings_Status

    PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Windows.

    provisionVMAgent
    bool

    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.

    timeZone
    string

    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.

    winRM
    WinRMConfiguration_Status

    WinRM: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    WindowsConfiguration_StatusARM

    (Appears on:OSProfile_StatusARM, VirtualMachineScaleSetOSProfile_StatusARM)

    Field Description
    additionalUnattendContent
    []AdditionalUnattendContent_StatusARM

    AdditionalUnattendContent: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    enableAutomaticUpdates
    bool

    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.

    patchSettings
    PatchSettings_StatusARM

    PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Windows.

    provisionVMAgent
    bool

    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.

    timeZone
    string

    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.

    winRM
    WinRMConfiguration_StatusARM

    WinRM: Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.