compute.azure.com/v1api20220301

compute.azure.com/v1api20220301

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

Resource Types:

    APIVersion (string alias)

    Value Description

    "2022-03-01"

    AdditionalCapabilities

    (Appears on:VirtualMachineScaleSet_Spec, VirtualMachine_Spec)

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

    Field Description
    hibernationEnabled
    bool

    HibernationEnabled: The flag that enables or disables hibernation capability on the VM.

    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_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetProperties_ARM)

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

    Field Description
    hibernationEnabled
    bool

    HibernationEnabled: The flag that enables or disables hibernation capability on the VM.

    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)

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

    Field Description
    hibernationEnabled
    bool

    HibernationEnabled: The flag that enables or disables hibernation capability on the VM.

    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_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetProperties_STATUS_ARM)

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

    Field Description
    hibernationEnabled
    bool

    HibernationEnabled: The flag that enables or disables hibernation capability on the VM.

    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)

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

    Field Description
    componentName
    AdditionalUnattendContent_ComponentName

    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
    AdditionalUnattendContent_PassName

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

    settingName
    AdditionalUnattendContent_SettingName

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

    AdditionalUnattendContent_ARM

    (Appears on:WindowsConfiguration_ARM)

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

    Field Description
    componentName
    AdditionalUnattendContent_ComponentName

    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
    AdditionalUnattendContent_PassName

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

    settingName
    AdditionalUnattendContent_SettingName

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

    AdditionalUnattendContent_ComponentName (string alias)

    (Appears on:AdditionalUnattendContent, AdditionalUnattendContent_ARM)

    Value Description

    "Microsoft-Windows-Shell-Setup"

    AdditionalUnattendContent_ComponentName_STATUS (string alias)

    (Appears on:AdditionalUnattendContent_STATUS, AdditionalUnattendContent_STATUS_ARM)

    Value Description

    "Microsoft-Windows-Shell-Setup"

    AdditionalUnattendContent_PassName (string alias)

    (Appears on:AdditionalUnattendContent, AdditionalUnattendContent_ARM)

    Value Description

    "OobeSystem"

    AdditionalUnattendContent_PassName_STATUS (string alias)

    (Appears on:AdditionalUnattendContent_STATUS, AdditionalUnattendContent_STATUS_ARM)

    Value Description

    "OobeSystem"

    AdditionalUnattendContent_STATUS

    (Appears on:WindowsConfiguration_STATUS)

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

    Field Description
    componentName
    AdditionalUnattendContent_ComponentName_STATUS

    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
    AdditionalUnattendContent_PassName_STATUS

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

    settingName
    AdditionalUnattendContent_SettingName_STATUS

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

    AdditionalUnattendContent_STATUS_ARM

    (Appears on:WindowsConfiguration_STATUS_ARM)

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

    Field Description
    componentName
    AdditionalUnattendContent_ComponentName_STATUS

    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
    AdditionalUnattendContent_PassName_STATUS

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

    settingName
    AdditionalUnattendContent_SettingName_STATUS

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

    AdditionalUnattendContent_SettingName (string alias)

    (Appears on:AdditionalUnattendContent, AdditionalUnattendContent_ARM)

    Value Description

    "AutoLogon"

    "FirstLogonCommands"

    AdditionalUnattendContent_SettingName_STATUS (string alias)

    (Appears on:AdditionalUnattendContent_STATUS, AdditionalUnattendContent_STATUS_ARM)

    Value Description

    "AutoLogon"

    "FirstLogonCommands"

    ApiEntityReference

    (Appears on:VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetNetworkProfile)

    The API entity reference.

    Field Description
    reference
    genruntime.ResourceReference

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

    ApiEntityReference_ARM

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_ARM, VirtualMachineScaleSetNetworkProfile_ARM)

    The API entity reference.

    Field Description
    id
    string

    ApiEntityReference_STATUS

    (Appears on:VirtualMachineScaleSetIPConfiguration_STATUS, VirtualMachineScaleSetNetworkProfile_STATUS)

    The API entity reference.

    Field Description
    id
    string

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

    ApiEntityReference_STATUS_ARM

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetNetworkProfile_STATUS_ARM)

    The API entity reference.

    Field Description
    id
    string

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

    ApiErrorBase_STATUS

    (Appears on:ApiError_STATUS)

    Api error base.

    Field Description
    code
    string

    Code: The error code.

    message
    string

    Message: The error message.

    target
    string

    Target: The target of the particular error.

    ApiErrorBase_STATUS_ARM

    (Appears on:ApiError_STATUS_ARM)

    Api error base.

    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)

    Api error.

    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_STATUS_ARM

    (Appears on:AvailablePatchSummary_STATUS_ARM, LastPatchInstallationSummary_STATUS_ARM)

    Api error.

    Field Description
    code
    string

    Code: The error code.

    details
    []ApiErrorBase_STATUS_ARM

    Details: The Api error details

    innererror
    InnerError_STATUS_ARM

    Innererror: The Api inner error

    message
    string

    Message: The error message.

    target
    string

    Target: The target of the particular error.

    ApplicationProfile

    (Appears on:VirtualMachineScaleSetVMProfile, VirtualMachine_Spec)

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

    Field Description
    galleryApplications
    []VMGalleryApplication

    GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS

    ApplicationProfile_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile_ARM)

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

    Field Description
    galleryApplications
    []VMGalleryApplication_ARM

    GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS

    ApplicationProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS, VirtualMachine_STATUS)

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

    Field Description
    galleryApplications
    []VMGalleryApplication_STATUS

    GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS

    ApplicationProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS_ARM)

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

    Field Description
    galleryApplications
    []VMGalleryApplication_STATUS_ARM

    GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS

    AutomaticOSUpgradePolicy

    (Appears on:UpgradePolicy)

    The configuration parameters used for performing automatic OS upgrade.

    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.

    useRollingUpgradePolicy
    bool

    UseRollingUpgradePolicy: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

    AutomaticOSUpgradePolicy_ARM

    (Appears on:UpgradePolicy_ARM)

    The configuration parameters used for performing automatic OS upgrade.

    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.

    useRollingUpgradePolicy
    bool

    UseRollingUpgradePolicy: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

    AutomaticOSUpgradePolicy_STATUS

    (Appears on:UpgradePolicy_STATUS)

    The configuration parameters used for performing automatic OS upgrade.

    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.

    useRollingUpgradePolicy
    bool

    UseRollingUpgradePolicy: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

    AutomaticOSUpgradePolicy_STATUS_ARM

    (Appears on:UpgradePolicy_STATUS_ARM)

    The configuration parameters used for performing automatic OS upgrade.

    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.

    useRollingUpgradePolicy
    bool

    UseRollingUpgradePolicy: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

    AutomaticRepairsPolicy

    (Appears on:VirtualMachineScaleSet_Spec)

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

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

    repairAction
    AutomaticRepairsPolicy_RepairAction

    RepairAction: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

    AutomaticRepairsPolicy_ARM

    (Appears on:VirtualMachineScaleSetProperties_ARM)

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

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

    repairAction
    AutomaticRepairsPolicy_RepairAction

    RepairAction: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

    AutomaticRepairsPolicy_RepairAction (string alias)

    (Appears on:AutomaticRepairsPolicy, AutomaticRepairsPolicy_ARM)

    Value Description

    "Reimage"

    "Replace"

    "Restart"

    AutomaticRepairsPolicy_RepairAction_STATUS (string alias)

    (Appears on:AutomaticRepairsPolicy_STATUS, AutomaticRepairsPolicy_STATUS_ARM)

    Value Description

    "Reimage"

    "Replace"

    "Restart"

    AutomaticRepairsPolicy_STATUS

    (Appears on:VirtualMachineScaleSet_STATUS)

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

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

    repairAction
    AutomaticRepairsPolicy_RepairAction_STATUS

    RepairAction: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

    AutomaticRepairsPolicy_STATUS_ARM

    (Appears on:VirtualMachineScaleSetProperties_STATUS_ARM)

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

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

    repairAction
    AutomaticRepairsPolicy_RepairAction_STATUS

    RepairAction: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

    AvailablePatchSummary_STATUS

    (Appears on:VirtualMachinePatchStatus_STATUS)

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

    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
    AvailablePatchSummary_Status_STATUS

    Status: The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Unknown”, “Failed”, “Succeeded”, or “CompletedWithWarnings.”

    AvailablePatchSummary_STATUS_ARM

    (Appears on:VirtualMachinePatchStatus_STATUS_ARM)

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

    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_ARM

    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
    AvailablePatchSummary_Status_STATUS

    Status: The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Unknown”, “Failed”, “Succeeded”, or “CompletedWithWarnings.”

    AvailablePatchSummary_Status_STATUS (string alias)

    (Appears on:AvailablePatchSummary_STATUS, AvailablePatchSummary_STATUS_ARM)

    Value Description

    "CompletedWithWarnings"

    "Failed"

    "InProgress"

    "Succeeded"

    "Unknown"

    BillingProfile

    (Appears on:VirtualMachineScaleSetVMProfile, VirtualMachine_Spec)

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

    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_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile_ARM)

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

    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)

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

    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_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS_ARM)

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

    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)

    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.

    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)

    The instance view of a virtual machine boot diagnostics.

    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_STATUS_ARM

    (Appears on:VirtualMachineInstanceView_STATUS_ARM)

    The instance view of a virtual machine boot diagnostics.

    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_ARM

    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_ARM

    (Appears on:DiagnosticsProfile_ARM)

    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.

    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_STATUS

    (Appears on:DiagnosticsProfile_STATUS)

    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.

    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_STATUS_ARM

    (Appears on:DiagnosticsProfile_STATUS_ARM)

    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.

    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 (string alias)

    (Appears on:DataDisk, DataDisk_ARM, OSDisk, OSDisk_ARM, VirtualMachineScaleSetDataDisk, VirtualMachineScaleSetDataDisk_ARM, VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDisk_ARM)

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

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    Caching_STATUS (string alias)

    (Appears on:DataDisk_STATUS, DataDisk_STATUS_ARM, OSDisk_STATUS, OSDisk_STATUS_ARM, VirtualMachineScaleSetDataDisk_STATUS, VirtualMachineScaleSetDataDisk_STATUS_ARM, VirtualMachineScaleSetOSDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS_ARM)

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

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    CapacityReservationProfile

    (Appears on:VirtualMachineScaleSetVMProfile, VirtualMachine_Spec)

    The parameters of a capacity reservation Profile.

    Field Description
    capacityReservationGroup
    SubResource

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

    CapacityReservationProfile_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile_ARM)

    The parameters of a capacity reservation Profile.

    Field Description
    capacityReservationGroup
    SubResource_ARM

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

    CapacityReservationProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS, VirtualMachine_STATUS)

    The parameters of a capacity reservation Profile.

    Field Description
    capacityReservationGroup
    SubResource_STATUS

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

    CapacityReservationProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS_ARM)

    The parameters of a capacity reservation Profile.

    Field Description
    capacityReservationGroup
    SubResource_STATUS_ARM

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

    CreateOption (string alias)

    (Appears on:DataDisk, DataDisk_ARM, OSDisk, OSDisk_ARM, VirtualMachineScaleSetDataDisk, VirtualMachineScaleSetDataDisk_ARM, VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDisk_ARM)

    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.

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    CreateOption_STATUS (string alias)

    (Appears on:DataDisk_STATUS, DataDisk_STATUS_ARM, OSDisk_STATUS, OSDisk_STATUS_ARM, VirtualMachineScaleSetDataDisk_STATUS, VirtualMachineScaleSetDataDisk_STATUS_ARM, VirtualMachineScaleSetOSDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS_ARM)

    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.

    Value Description

    "Attach"

    "Empty"

    "FromImage"

    DataDisk

    (Appears on:StorageProfile)

    Describes a data disk.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    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.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach

    detachOption
    DetachOption

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

    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

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

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

    DataDisk_ARM

    (Appears on:StorageProfile_ARM)

    Describes a data disk.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    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.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach

    detachOption
    DetachOption

    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_ARM

    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_ARM

    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_ARM

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

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

    DataDisk_STATUS

    (Appears on:StorageProfile_STATUS)

    Describes a data disk.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach

    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_STATUS_ARM

    (Appears on:StorageProfile_STATUS_ARM)

    Describes a data disk.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach

    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_ARM

    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_ARM

    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_ARM

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

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

    DeleteOption (string alias)

    (Appears on:DataDisk, DataDisk_ARM, OSDisk, OSDisk_ARM, VirtualMachineScaleSetDataDisk, VirtualMachineScaleSetDataDisk_ARM, VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDisk_ARM)

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

    Value Description

    "Delete"

    "Detach"

    DeleteOption_STATUS (string alias)

    (Appears on:DataDisk_STATUS, DataDisk_STATUS_ARM, OSDisk_STATUS, OSDisk_STATUS_ARM, VirtualMachineScaleSetDataDisk_STATUS, VirtualMachineScaleSetDataDisk_STATUS_ARM, VirtualMachineScaleSetOSDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS_ARM)

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

    Value Description

    "Delete"

    "Detach"

    DetachOption (string alias)

    (Appears on:DataDisk, DataDisk_ARM)

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

    Value Description

    "ForceDetach"

    DetachOption_STATUS (string alias)

    (Appears on:DataDisk_STATUS, DataDisk_STATUS_ARM)

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

    Value Description

    "ForceDetach"

    DiagnosticsProfile

    (Appears on:VirtualMachineScaleSetVMProfile, VirtualMachine_Spec)

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

    Field Description
    bootDiagnostics
    BootDiagnostics

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

    DiagnosticsProfile_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile_ARM)

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

    Field Description
    bootDiagnostics
    BootDiagnostics_ARM

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

    DiagnosticsProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS, VirtualMachine_STATUS)

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

    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. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

    DiagnosticsProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS_ARM)

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

    Field Description
    bootDiagnostics
    BootDiagnostics_STATUS_ARM

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

    DiffDiskOption (string alias)

    (Appears on:DiffDiskSettings, DiffDiskSettings_ARM)

    Specifies the ephemeral disk option for operating system disk.

    Value Description

    "Local"

    DiffDiskOption_STATUS (string alias)

    (Appears on:DiffDiskSettings_STATUS, DiffDiskSettings_STATUS_ARM)

    Specifies the ephemeral disk option for operating system disk.

    Value Description

    "Local"

    DiffDiskPlacement (string alias)

    (Appears on:DiffDiskSettings, DiffDiskSettings_ARM)

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

    Value Description

    "CacheDisk"

    "ResourceDisk"

    DiffDiskPlacement_STATUS (string alias)

    (Appears on:DiffDiskSettings_STATUS, DiffDiskSettings_STATUS_ARM)

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

    Value Description

    "CacheDisk"

    "ResourceDisk"

    DiffDiskSettings

    (Appears on:OSDisk, VirtualMachineScaleSetOSDisk)

    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.

    Field Description
    option
    DiffDiskOption

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

    placement
    DiffDiskPlacement

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

    DiffDiskSettings_ARM

    (Appears on:OSDisk_ARM, VirtualMachineScaleSetOSDisk_ARM)

    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.

    Field Description
    option
    DiffDiskOption

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

    placement
    DiffDiskPlacement

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

    DiffDiskSettings_STATUS

    (Appears on:OSDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS)

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

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

    DiffDiskSettings_STATUS_ARM

    (Appears on:OSDisk_STATUS_ARM, VirtualMachineScaleSetOSDisk_STATUS_ARM)

    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.

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

    DiskEncryptionSettings

    (Appears on:OSDisk)

    Describes a Encryption Settings for a Disk

    Field Description
    diskEncryptionKey
    KeyVaultSecretReference

    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

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

    DiskEncryptionSettings_ARM

    (Appears on:OSDisk_ARM)

    Describes a Encryption Settings for a Disk

    Field Description
    diskEncryptionKey
    KeyVaultSecretReference_ARM

    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_ARM

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

    DiskEncryptionSettings_STATUS

    (Appears on:DiskInstanceView_STATUS, OSDisk_STATUS)

    Describes a Encryption Settings for a Disk

    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_STATUS_ARM

    (Appears on:DiskInstanceView_STATUS_ARM, OSDisk_STATUS_ARM)

    Describes a Encryption Settings for a Disk

    Field Description
    diskEncryptionKey
    KeyVaultSecretReference_STATUS_ARM

    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_ARM

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

    DiskInstanceView_STATUS

    (Appears on:VirtualMachineInstanceView_STATUS)

    The instance view of the disk.

    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_STATUS_ARM

    (Appears on:VirtualMachineInstanceView_STATUS_ARM)

    The instance view of the disk.

    Field Description
    encryptionSettings
    []DiskEncryptionSettings_STATUS_ARM

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

    name
    string

    Name: The disk name.

    statuses
    []InstanceViewStatus_STATUS_ARM

    Statuses: The resource status information.

    EvictionPolicy (string alias)

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile, VirtualMachineScaleSetVMProfile_ARM, VirtualMachine_Spec)

    Specifies the eviction policy for the Azure Spot VM/VMSS

    Value Description

    "Deallocate"

    "Delete"

    EvictionPolicy_STATUS (string alias)

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS, VirtualMachineScaleSetVMProfile_STATUS_ARM, VirtualMachine_STATUS)

    Specifies the eviction policy for the Azure Spot VM/VMSS

    Value Description

    "Deallocate"

    "Delete"

    ExtendedLocation

    (Appears on:Image_Spec, VirtualMachineScaleSet_Spec, VirtualMachine_Spec)

    The complex type of the extended location.

    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, ExtendedLocation_ARM)

    The type of extendedLocation.

    Value Description

    "EdgeZone"

    ExtendedLocationType_STATUS (string alias)

    (Appears on:ExtendedLocation_STATUS, ExtendedLocation_STATUS_ARM)

    The type of extendedLocation.

    Value Description

    "EdgeZone"

    ExtendedLocation_ARM

    (Appears on:Image_Spec_ARM, VirtualMachineScaleSet_Spec_ARM, VirtualMachine_Spec_ARM)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocation_STATUS

    (Appears on:Image_STATUS, VirtualMachineScaleSet_STATUS, VirtualMachine_STATUS)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS

    Type: The type of the extended location.

    ExtendedLocation_STATUS_ARM

    (Appears on:Image_STATUS_ARM, VirtualMachineScaleSet_STATUS_ARM, VirtualMachine_STATUS_ARM)

    The complex type of the extended location.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS

    Type: The type of the extended location.

    HardwareProfile

    (Appears on:VirtualMachine_Spec)

    Specifies the hardware settings for the virtual machine.

    Field Description
    vmSize
    string

    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.

    vmSizeProperties
    VMSizeProperties

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

    HardwareProfile_ARM

    (Appears on:VirtualMachineProperties_ARM)

    Specifies the hardware settings for the virtual machine.

    Field Description
    vmSize
    string

    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.

    vmSizeProperties
    VMSizeProperties_ARM

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

    HardwareProfile_STATUS

    (Appears on:VirtualMachine_STATUS)

    Specifies the hardware settings for the virtual machine.

    Field Description
    vmSize
    HardwareProfile_VmSize_STATUS

    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.

    vmSizeProperties
    VMSizeProperties_STATUS

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

    HardwareProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM)

    Specifies the hardware settings for the virtual machine.

    Field Description
    vmSize
    HardwareProfile_VmSize_STATUS

    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.

    vmSizeProperties
    VMSizeProperties_STATUS_ARM

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

    HardwareProfile_VmSize_STATUS (string alias)

    (Appears on:HardwareProfile_STATUS, HardwareProfile_STATUS_ARM)

    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"

    HyperVGenerationType (string alias)

    (Appears on:ImageProperties_ARM, Image_Spec)

    Specifies the HyperVGeneration Type

    Value Description

    "V1"

    "V2"

    HyperVGenerationType_STATUS (string alias)

    (Appears on:ImageProperties_STATUS_ARM, Image_STATUS)

    Specifies the HyperVGeneration Type

    Value Description

    "V1"

    "V2"

    Image

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

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


    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the Image.

    hyperVGeneration
    HyperVGenerationType

    HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

    location
    string

    Location: Resource location

    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

    sourceVirtualMachine
    SubResource

    SourceVirtualMachine: The source virtual machine from which Image is created.

    storageProfile
    ImageStorageProfile

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

    tags
    map[string]string

    Tags: Resource tags

    status
    Image_STATUS

    ImageDataDisk

    (Appears on:ImageStorageProfile)

    Describes a data disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageDataDisk_Caching

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

    diskEncryptionSet
    SubResource

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    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
    SubResource

    ManagedDisk: The managedDisk.

    snapshot
    SubResource

    Snapshot: The snapshot.

    storageAccountType
    StorageAccountType

    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.

    ImageDataDisk_ARM

    (Appears on:ImageStorageProfile_ARM)

    Describes a data disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageDataDisk_Caching

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

    diskEncryptionSet
    SubResource_ARM

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    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
    SubResource_ARM

    ManagedDisk: The managedDisk.

    snapshot
    SubResource_ARM

    Snapshot: The snapshot.

    storageAccountType
    StorageAccountType

    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.

    ImageDataDisk_Caching (string alias)

    (Appears on:ImageDataDisk, ImageDataDisk_ARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    ImageDataDisk_Caching_STATUS (string alias)

    (Appears on:ImageDataDisk_STATUS, ImageDataDisk_STATUS_ARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    ImageDataDisk_STATUS

    (Appears on:ImageStorageProfile_STATUS)

    Describes a data disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageDataDisk_Caching_STATUS

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

    diskEncryptionSet
    SubResource_STATUS

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    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
    SubResource_STATUS

    ManagedDisk: The managedDisk.

    snapshot
    SubResource_STATUS

    Snapshot: The snapshot.

    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.

    ImageDataDisk_STATUS_ARM

    (Appears on:ImageStorageProfile_STATUS_ARM)

    Describes a data disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageDataDisk_Caching_STATUS

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

    diskEncryptionSet
    SubResource_STATUS_ARM

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    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
    SubResource_STATUS_ARM

    ManagedDisk: The managedDisk.

    snapshot
    SubResource_STATUS_ARM

    Snapshot: The snapshot.

    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.

    ImageOSDisk

    (Appears on:ImageStorageProfile)

    Describes an Operating System disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageOSDisk_Caching

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

    diskEncryptionSet
    SubResource

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    managedDisk
    SubResource

    ManagedDisk: The managedDisk.

    osState
    ImageOSDisk_OsState

    OsState: The OS State. For managed images, use Generalized.

    osType
    ImageOSDisk_OsType

    OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux

    snapshot
    SubResource

    Snapshot: The snapshot.

    storageAccountType
    StorageAccountType

    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.

    ImageOSDisk_ARM

    (Appears on:ImageStorageProfile_ARM)

    Describes an Operating System disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageOSDisk_Caching

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

    diskEncryptionSet
    SubResource_ARM

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    managedDisk
    SubResource_ARM

    ManagedDisk: The managedDisk.

    osState
    ImageOSDisk_OsState

    OsState: The OS State. For managed images, use Generalized.

    osType
    ImageOSDisk_OsType

    OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux

    snapshot
    SubResource_ARM

    Snapshot: The snapshot.

    storageAccountType
    StorageAccountType

    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.

    ImageOSDisk_Caching (string alias)

    (Appears on:ImageOSDisk, ImageOSDisk_ARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    ImageOSDisk_Caching_STATUS (string alias)

    (Appears on:ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    ImageOSDisk_OsState (string alias)

    (Appears on:ImageOSDisk, ImageOSDisk_ARM)

    Value Description

    "Generalized"

    "Specialized"

    ImageOSDisk_OsState_STATUS (string alias)

    (Appears on:ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

    Value Description

    "Generalized"

    "Specialized"

    ImageOSDisk_OsType (string alias)

    (Appears on:ImageOSDisk, ImageOSDisk_ARM)

    Value Description

    "Linux"

    "Windows"

    ImageOSDisk_OsType_STATUS (string alias)

    (Appears on:ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM)

    Value Description

    "Linux"

    "Windows"

    ImageOSDisk_STATUS

    (Appears on:ImageStorageProfile_STATUS)

    Describes an Operating System disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageOSDisk_Caching_STATUS

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

    diskEncryptionSet
    SubResource_STATUS

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    managedDisk
    SubResource_STATUS

    ManagedDisk: The managedDisk.

    osState
    ImageOSDisk_OsState_STATUS

    OsState: The OS State. For managed images, use Generalized.

    osType
    ImageOSDisk_OsType_STATUS

    OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux

    snapshot
    SubResource_STATUS

    Snapshot: The snapshot.

    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.

    ImageOSDisk_STATUS_ARM

    (Appears on:ImageStorageProfile_STATUS_ARM)

    Describes an Operating System disk.

    Field Description
    blobUri
    string

    BlobUri: The Virtual Hard Disk.

    caching
    ImageOSDisk_Caching_STATUS

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

    diskEncryptionSet
    SubResource_STATUS_ARM

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

    diskSizeGB
    int

    DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

    managedDisk
    SubResource_STATUS_ARM

    ManagedDisk: The managedDisk.

    osState
    ImageOSDisk_OsState_STATUS

    OsState: The OS State. For managed images, use Generalized.

    osType
    ImageOSDisk_OsType_STATUS

    OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux

    snapshot
    SubResource_STATUS_ARM

    Snapshot: The snapshot.

    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.

    ImageProperties_ARM

    (Appears on:Image_Spec_ARM)

    Describes the properties of an Image.

    Field Description
    hyperVGeneration
    HyperVGenerationType

    HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

    sourceVirtualMachine
    SubResource_ARM

    SourceVirtualMachine: The source virtual machine from which Image is created.

    storageProfile
    ImageStorageProfile_ARM

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

    ImageProperties_STATUS_ARM

    (Appears on:Image_STATUS_ARM)

    Describes the properties of an Image.

    Field Description
    hyperVGeneration
    HyperVGenerationType_STATUS

    HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

    provisioningState
    string

    ProvisioningState: The provisioning state.

    sourceVirtualMachine
    SubResource_STATUS_ARM

    SourceVirtualMachine: The source virtual machine from which Image is created.

    storageProfile
    ImageStorageProfile_STATUS_ARM

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

    ImageReference

    (Appears on:StorageProfile, VirtualMachineScaleSetStorageProfile)

    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.

    Field Description
    communityGalleryImageId
    string

    CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

    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

    sharedGalleryImageId
    string

    SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

    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. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ‘latest’ version of gallery image, just set ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​images/​{imageName}’ in the ‘id’ field without version input.

    ImageReference_ARM

    (Appears on:StorageProfile_ARM, VirtualMachineScaleSetStorageProfile_ARM)

    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.

    Field Description
    communityGalleryImageId
    string

    CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

    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.

    sharedGalleryImageId
    string

    SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

    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. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ‘latest’ version of gallery image, just set ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​images/​{imageName}’ in the ‘id’ field without version input.

    ImageReference_STATUS

    (Appears on:StorageProfile_STATUS, VirtualMachineScaleSetStorageProfile_STATUS)

    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.

    Field Description
    communityGalleryImageId
    string

    CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

    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.

    sharedGalleryImageId
    string

    SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

    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. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ‘latest’ version of gallery image, just set ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​images/​{imageName}’ in the ‘id’ field without version input.

    ImageReference_STATUS_ARM

    (Appears on:StorageProfile_STATUS_ARM, VirtualMachineScaleSetStorageProfile_STATUS_ARM)

    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.

    Field Description
    communityGalleryImageId
    string

    CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

    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.

    sharedGalleryImageId
    string

    SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

    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. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ‘latest’ version of gallery image, just set ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​images/​{imageName}’ in the ‘id’ field without version input.

    ImageStorageProfile

    (Appears on:Image_Spec)

    Describes a storage profile.

    Field Description
    dataDisks
    []ImageDataDisk

    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.

    osDisk
    ImageOSDisk

    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.

    zoneResilient
    bool

    ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

    ImageStorageProfile_ARM

    (Appears on:ImageProperties_ARM)

    Describes a storage profile.

    Field Description
    dataDisks
    []ImageDataDisk_ARM

    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.

    osDisk
    ImageOSDisk_ARM

    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.

    zoneResilient
    bool

    ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

    ImageStorageProfile_STATUS

    (Appears on:Image_STATUS)

    Describes a storage profile.

    Field Description
    dataDisks
    []ImageDataDisk_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.

    osDisk
    ImageOSDisk_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.

    zoneResilient
    bool

    ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

    ImageStorageProfile_STATUS_ARM

    (Appears on:ImageProperties_STATUS_ARM)

    Describes a storage profile.

    Field Description
    dataDisks
    []ImageDataDisk_STATUS_ARM

    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.

    osDisk
    ImageOSDisk_STATUS_ARM

    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.

    zoneResilient
    bool

    ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

    Image_STATUS

    (Appears on: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.

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: The extended location of the Image.

    hyperVGeneration
    HyperVGenerationType_STATUS

    HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

    id
    string

    Id: Resource Id

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    provisioningState
    string

    ProvisioningState: The provisioning state.

    sourceVirtualMachine
    SubResource_STATUS

    SourceVirtualMachine: The source virtual machine from which Image is created.

    storageProfile
    ImageStorageProfile_STATUS

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

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    Image_STATUS_ARM

    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.

    Field Description
    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the Image.

    id
    string

    Id: Resource Id

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    properties
    ImageProperties_STATUS_ARM

    Properties: Describes the properties of an Image.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    Image_Spec

    (Appears on:Image)

    Field Description
    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the Image.

    hyperVGeneration
    HyperVGenerationType

    HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

    location
    string

    Location: Resource location

    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

    sourceVirtualMachine
    SubResource

    SourceVirtualMachine: The source virtual machine from which Image is created.

    storageProfile
    ImageStorageProfile

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

    tags
    map[string]string

    Tags: Resource tags

    Image_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the Image.

    location
    string

    Location: Resource location

    name
    string
    properties
    ImageProperties_ARM

    Properties: Describes the properties of an Image.

    tags
    map[string]string

    Tags: Resource tags

    InnerError_STATUS

    (Appears on:ApiError_STATUS)

    Inner error details.

    Field Description
    errordetail
    string

    Errordetail: The internal error message or exception dump.

    exceptiontype
    string

    Exceptiontype: The exception type.

    InnerError_STATUS_ARM

    (Appears on:ApiError_STATUS_ARM)

    Inner error details.

    Field Description
    errordetail
    string

    Errordetail: The internal error message or exception dump.

    exceptiontype
    string

    Exceptiontype: The exception type.

    InstanceViewStatus

    (Appears on:VirtualMachineExtensionInstanceView)

    Instance view status.

    Field Description
    code
    string

    Code: The status code.

    displayStatus
    string

    DisplayStatus: The short localizable label for the status.

    level
    InstanceViewStatus_Level

    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_ARM

    (Appears on:VirtualMachineExtensionInstanceView_ARM)

    Instance view status.

    Field Description
    code
    string

    Code: The status code.

    displayStatus
    string

    DisplayStatus: The short localizable label for the status.

    level
    InstanceViewStatus_Level

    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_Level (string alias)

    (Appears on:InstanceViewStatus, InstanceViewStatus_ARM)

    Value Description

    "Error"

    "Info"

    "Warning"

    InstanceViewStatus_Level_STATUS (string alias)

    (Appears on:InstanceViewStatus_STATUS, InstanceViewStatus_STATUS_ARM)

    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)

    Instance view status.

    Field Description
    code
    string

    Code: The status code.

    displayStatus
    string

    DisplayStatus: The short localizable label for the status.

    level
    InstanceViewStatus_Level_STATUS

    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_STATUS_ARM

    (Appears on:BootDiagnosticsInstanceView_STATUS_ARM, DiskInstanceView_STATUS_ARM, VirtualMachineAgentInstanceView_STATUS_ARM, VirtualMachineExtensionHandlerInstanceView_STATUS_ARM, VirtualMachineExtensionInstanceView_STATUS_ARM, VirtualMachineHealthStatus_STATUS_ARM, VirtualMachineInstanceView_STATUS_ARM, VirtualMachinePatchStatus_STATUS_ARM)

    Instance view status.

    Field Description
    code
    string

    Code: The status code.

    displayStatus
    string

    DisplayStatus: The short localizable label for the status.

    level
    InstanceViewStatus_Level_STATUS

    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)

    Describes a reference to Key Vault Key

    Field Description
    keyUrl
    string

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

    sourceVault
    SubResource

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

    KeyVaultKeyReference_ARM

    (Appears on:DiskEncryptionSettings_ARM)

    Describes a reference to Key Vault Key

    Field Description
    keyUrl
    string

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

    sourceVault
    SubResource_ARM

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

    KeyVaultKeyReference_STATUS

    (Appears on:DiskEncryptionSettings_STATUS)

    Describes a reference to Key Vault Key

    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_STATUS_ARM

    (Appears on:DiskEncryptionSettings_STATUS_ARM)

    Describes a reference to Key Vault Key

    Field Description
    keyUrl
    string

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

    sourceVault
    SubResource_STATUS_ARM

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

    KeyVaultSecretReference

    (Appears on:DiskEncryptionSettings, VirtualMachineScaleSetExtension, VirtualMachineScaleSets_Extension_Spec, VirtualMachines_Extension_Spec)

    Describes a reference to Key Vault Secret

    Field Description
    secretUrl
    string

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

    sourceVault
    SubResource

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

    KeyVaultSecretReference_ARM

    (Appears on:DiskEncryptionSettings_ARM, VirtualMachineExtensionProperties_ARM, VirtualMachineScaleSetExtensionProperties_ARM)

    Describes a reference to Key Vault Secret

    Field Description
    secretUrl
    string

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

    sourceVault
    SubResource_ARM

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

    KeyVaultSecretReference_STATUS

    (Appears on:DiskEncryptionSettings_STATUS, VirtualMachineExtension_STATUS, VirtualMachineScaleSetExtension_STATUS, VirtualMachineScaleSets_Extension_STATUS, VirtualMachines_Extension_STATUS)

    Describes a reference to Key Vault Secret

    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_STATUS_ARM

    (Appears on:DiskEncryptionSettings_STATUS_ARM, VirtualMachineExtensionProperties_STATUS_ARM, VirtualMachineScaleSetExtensionProperties_STATUS_ARM)

    Describes a reference to Key Vault Secret

    Field Description
    secretUrl
    string

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

    sourceVault
    SubResource_STATUS_ARM

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

    LastPatchInstallationSummary_STATUS

    (Appears on:VirtualMachinePatchStatus_STATUS)

    Describes the properties of the last installed patch summary.

    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
    LastPatchInstallationSummary_Status_STATUS

    Status: The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Unknown”, “Failed”, “Succeeded”, or “CompletedWithWarnings.”

    LastPatchInstallationSummary_STATUS_ARM

    (Appears on:VirtualMachinePatchStatus_STATUS_ARM)

    Describes the properties of the last installed patch summary.

    Field Description
    error
    ApiError_STATUS_ARM

    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
    LastPatchInstallationSummary_Status_STATUS

    Status: The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Unknown”, “Failed”, “Succeeded”, or “CompletedWithWarnings.”

    LastPatchInstallationSummary_Status_STATUS (string alias)

    (Appears on:LastPatchInstallationSummary_STATUS, LastPatchInstallationSummary_STATUS_ARM)

    Value Description

    "CompletedWithWarnings"

    "Failed"

    "InProgress"

    "Succeeded"

    "Unknown"

    LinuxConfiguration

    (Appears on:OSProfile, VirtualMachineScaleSetOSProfile)

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

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettings

    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

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

    LinuxConfiguration_ARM

    (Appears on:OSProfile_ARM, VirtualMachineScaleSetOSProfile_ARM)

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

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettings_ARM

    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_ARM

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

    LinuxConfiguration_STATUS

    (Appears on:OSProfile_STATUS, VirtualMachineScaleSetOSProfile_STATUS)

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

    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_STATUS_ARM

    (Appears on:OSProfile_STATUS_ARM, VirtualMachineScaleSetOSProfile_STATUS_ARM)

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

    Field Description
    disablePasswordAuthentication
    bool

    DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

    patchSettings
    LinuxPatchSettings_STATUS_ARM

    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_ARM

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

    LinuxPatchSettings

    (Appears on:LinuxConfiguration)

    Specifies settings related to VM Guest Patching on Linux.

    Field Description
    assessmentMode
    LinuxPatchSettings_AssessmentMode

    AssessmentMode: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    LinuxVMGuestPatchAutomaticByPlatformSettings

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

    patchMode
    LinuxPatchSettings_PatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine’s default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

    LinuxPatchSettings_ARM

    (Appears on:LinuxConfiguration_ARM)

    Specifies settings related to VM Guest Patching on Linux.

    Field Description
    assessmentMode
    LinuxPatchSettings_AssessmentMode

    AssessmentMode: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    LinuxVMGuestPatchAutomaticByPlatformSettings_ARM

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

    patchMode
    LinuxPatchSettings_PatchMode

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine’s default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

    LinuxPatchSettings_AssessmentMode (string alias)

    (Appears on:LinuxPatchSettings, LinuxPatchSettings_ARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    LinuxPatchSettings_AssessmentMode_STATUS (string alias)

    (Appears on:LinuxPatchSettings_STATUS, LinuxPatchSettings_STATUS_ARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    LinuxPatchSettings_PatchMode (string alias)

    (Appears on:LinuxPatchSettings, LinuxPatchSettings_ARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    LinuxPatchSettings_PatchMode_STATUS (string alias)

    (Appears on:LinuxPatchSettings_STATUS, LinuxPatchSettings_STATUS_ARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    LinuxPatchSettings_STATUS

    (Appears on:LinuxConfiguration_STATUS)

    Specifies settings related to VM Guest Patching on Linux.

    Field Description
    assessmentMode
    LinuxPatchSettings_AssessmentMode_STATUS

    AssessmentMode: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

    patchMode
    LinuxPatchSettings_PatchMode_STATUS

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine’s default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

    LinuxPatchSettings_STATUS_ARM

    (Appears on:LinuxConfiguration_STATUS_ARM)

    Specifies settings related to VM Guest Patching on Linux.

    Field Description
    assessmentMode
    LinuxPatchSettings_AssessmentMode_STATUS

    AssessmentMode: Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS_ARM

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

    patchMode
    LinuxPatchSettings_PatchMode_STATUS

    PatchMode: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine’s default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

    LinuxVMGuestPatchAutomaticByPlatformSettings

    (Appears on:LinuxPatchSettings)

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

    Field Description
    rebootSetting
    LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting

    RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

    LinuxVMGuestPatchAutomaticByPlatformSettings_ARM

    (Appears on:LinuxPatchSettings_ARM)

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

    Field Description
    rebootSetting
    LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting

    RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

    LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting (string alias)

    (Appears on:LinuxVMGuestPatchAutomaticByPlatformSettings, LinuxVMGuestPatchAutomaticByPlatformSettings_ARM)

    Value Description

    "Always"

    "IfRequired"

    "Never"

    "Unknown"

    LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS (string alias)

    (Appears on:LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS, LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS_ARM)

    Value Description

    "Always"

    "IfRequired"

    "Never"

    "Unknown"

    LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS

    (Appears on:LinuxPatchSettings_STATUS)

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

    Field Description
    rebootSetting
    LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS

    RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

    LinuxVMGuestPatchAutomaticByPlatformSettings_STATUS_ARM

    (Appears on:LinuxPatchSettings_STATUS_ARM)

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

    Field Description
    rebootSetting
    LinuxVMGuestPatchAutomaticByPlatformSettings_RebootSetting_STATUS

    RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

    MaintenanceRedeployStatus_LastOperationResultCode_STATUS (string alias)

    (Appears on:MaintenanceRedeployStatus_STATUS, MaintenanceRedeployStatus_STATUS_ARM)

    Value Description

    "MaintenanceAborted"

    "MaintenanceCompleted"

    "None"

    "RetryLater"

    MaintenanceRedeployStatus_STATUS

    (Appears on:VirtualMachineInstanceView_STATUS)

    Maintenance Operation 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
    MaintenanceRedeployStatus_LastOperationResultCode_STATUS

    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_STATUS_ARM

    (Appears on:VirtualMachineInstanceView_STATUS_ARM)

    Maintenance Operation 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
    MaintenanceRedeployStatus_LastOperationResultCode_STATUS

    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)

    The parameters of a managed disk.

    Field Description
    diskEncryptionSet
    SubResource

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

    reference
    genruntime.ResourceReference

    Reference: Resource Id

    securityProfile
    VMDiskSecurityProfile

    SecurityProfile: Specifies the security profile for the managed disk.

    storageAccountType
    StorageAccountType

    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.

    ManagedDiskParameters_ARM

    (Appears on:DataDisk_ARM, OSDisk_ARM)

    The parameters of a managed disk.

    Field Description
    diskEncryptionSet
    SubResource_ARM

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

    id
    string
    securityProfile
    VMDiskSecurityProfile_ARM

    SecurityProfile: Specifies the security profile for the managed disk.

    storageAccountType
    StorageAccountType

    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.

    ManagedDiskParameters_STATUS

    (Appears on:DataDisk_STATUS, OSDisk_STATUS)

    The parameters of a managed disk.

    Field Description
    diskEncryptionSet
    SubResource_STATUS

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

    id
    string

    Id: Resource Id

    securityProfile
    VMDiskSecurityProfile_STATUS

    SecurityProfile: Specifies the security profile 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.

    ManagedDiskParameters_STATUS_ARM

    (Appears on:DataDisk_STATUS_ARM, OSDisk_STATUS_ARM)

    The parameters of a managed disk.

    Field Description
    diskEncryptionSet
    SubResource_STATUS_ARM

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

    id
    string

    Id: Resource Id

    securityProfile
    VMDiskSecurityProfile_STATUS_ARM

    SecurityProfile: Specifies the security profile 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.

    NetworkInterfaceReference

    (Appears on:NetworkProfile)

    Describes a network interface reference.

    Field Description
    deleteOption
    NetworkInterfaceReferenceProperties_DeleteOption

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    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

    NetworkInterfaceReferenceProperties_ARM

    (Appears on:NetworkInterfaceReference_ARM)

    Describes a network interface reference properties.

    Field Description
    deleteOption
    NetworkInterfaceReferenceProperties_DeleteOption

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    primary
    bool

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

    NetworkInterfaceReferenceProperties_DeleteOption (string alias)

    (Appears on:NetworkInterfaceReference, NetworkInterfaceReferenceProperties_ARM)

    Value Description

    "Delete"

    "Detach"

    NetworkInterfaceReferenceProperties_DeleteOption_STATUS (string alias)

    (Appears on:NetworkInterfaceReferenceProperties_STATUS_ARM, NetworkInterfaceReference_STATUS)

    Value Description

    "Delete"

    "Detach"

    NetworkInterfaceReferenceProperties_STATUS_ARM

    (Appears on:NetworkInterfaceReference_STATUS_ARM)

    Describes a network interface reference properties.

    Field Description
    deleteOption
    NetworkInterfaceReferenceProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    primary
    bool

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

    NetworkInterfaceReference_ARM

    (Appears on:NetworkProfile_ARM)

    Describes a network interface reference.

    Field Description
    id
    string
    properties
    NetworkInterfaceReferenceProperties_ARM

    Properties: Describes a network interface reference properties.

    NetworkInterfaceReference_STATUS

    (Appears on:NetworkProfile_STATUS)

    Describes a network interface reference.

    Field Description
    deleteOption
    NetworkInterfaceReferenceProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    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_STATUS_ARM

    (Appears on:NetworkProfile_STATUS_ARM)

    Describes a network interface reference.

    Field Description
    id
    string

    Id: Resource Id

    properties
    NetworkInterfaceReferenceProperties_STATUS_ARM

    Properties: Describes a network interface reference properties.

    NetworkProfile

    (Appears on:VirtualMachine_Spec)

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

    Field Description
    networkApiVersion
    NetworkProfile_NetworkApiVersion

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations

    networkInterfaceConfigurations
    []VirtualMachineNetworkInterfaceConfiguration

    NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine networking resources.

    networkInterfaces
    []NetworkInterfaceReference

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

    NetworkProfile_ARM

    (Appears on:VirtualMachineProperties_ARM)

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

    Field Description
    networkApiVersion
    NetworkProfile_NetworkApiVersion

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations

    networkInterfaceConfigurations
    []VirtualMachineNetworkInterfaceConfiguration_ARM

    NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine networking resources.

    networkInterfaces
    []NetworkInterfaceReference_ARM

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

    NetworkProfile_NetworkApiVersion (string alias)

    (Appears on:NetworkProfile, NetworkProfile_ARM)

    Value Description

    "2020-11-01"

    NetworkProfile_NetworkApiVersion_STATUS (string alias)

    (Appears on:NetworkProfile_STATUS, NetworkProfile_STATUS_ARM)

    Value Description

    "2020-11-01"

    NetworkProfile_STATUS

    (Appears on:VirtualMachine_STATUS)

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

    Field Description
    networkApiVersion
    NetworkProfile_NetworkApiVersion_STATUS

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations

    networkInterfaceConfigurations
    []VirtualMachineNetworkInterfaceConfiguration_STATUS

    NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine networking resources.

    networkInterfaces
    []NetworkInterfaceReference_STATUS

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

    NetworkProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM)

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

    Field Description
    networkApiVersion
    NetworkProfile_NetworkApiVersion_STATUS

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations

    networkInterfaceConfigurations
    []VirtualMachineNetworkInterfaceConfiguration_STATUS_ARM

    NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine networking resources.

    networkInterfaces
    []NetworkInterfaceReference_STATUS_ARM

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

    OSDisk

    (Appears on:StorageProfile)

    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.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    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.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

    diffDiskSettings
    DiffDiskSettings

    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

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

    image
    VirtualHardDisk

    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

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    OSDisk_OsType

    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: The virtual hard disk.

    writeAcceleratorEnabled
    bool

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

    OSDisk_ARM

    (Appears on:StorageProfile_ARM)

    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.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    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.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

    diffDiskSettings
    DiffDiskSettings_ARM

    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_ARM

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

    image
    VirtualHardDisk_ARM

    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_ARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    OSDisk_OsType

    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_ARM

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

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

    OSDisk_OsType (string alias)

    (Appears on:OSDisk, OSDisk_ARM)

    Value Description

    "Linux"

    "Windows"

    OSDisk_OsType_STATUS (string alias)

    (Appears on:OSDisk_STATUS, OSDisk_STATUS_ARM)

    Value Description

    "Linux"

    "Windows"

    OSDisk_STATUS

    (Appears on:StorageProfile_STATUS)

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

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

    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
    OSDisk_OsType_STATUS

    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_STATUS_ARM

    (Appears on:StorageProfile_STATUS_ARM)

    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.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

    diffDiskSettings
    DiffDiskSettings_STATUS_ARM

    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_ARM

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

    image
    VirtualHardDisk_STATUS_ARM

    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_ARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    OSDisk_OsType_STATUS

    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_ARM

    Vhd: The virtual hard disk.

    writeAcceleratorEnabled
    bool

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

    OSProfile

    (Appears on:VirtualMachine_Spec)

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

    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.

    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.

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.

    secrets
    []VaultSecretGroup

    Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration

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

    OSProfile_ARM

    (Appears on:VirtualMachineProperties_ARM)

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

    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.

    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_ARM

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

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.

    secrets
    []VaultSecretGroup_ARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration_ARM

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

    OSProfile_STATUS

    (Appears on:VirtualMachine_STATUS)

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

    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.

    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.

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.

    secrets
    []VaultSecretGroup_STATUS

    Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration_STATUS

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

    OSProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM)

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

    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.

    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_ARM

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

    requireGuestProvisionSignal
    bool

    RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.

    secrets
    []VaultSecretGroup_STATUS_ARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration_STATUS_ARM

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

    OrchestrationMode (string alias)

    (Appears on:VirtualMachineScaleSetProperties_ARM, VirtualMachineScaleSet_Spec)

    Specifies the orchestration mode for the virtual machine scale set.

    Value Description

    "Flexible"

    "Uniform"

    OrchestrationMode_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetProperties_STATUS_ARM, VirtualMachineScaleSet_STATUS)

    Specifies the orchestration mode for the virtual machine scale set.

    Value Description

    "Flexible"

    "Uniform"

    PatchSettings

    (Appears on:WindowsConfiguration)

    Specifies settings related to VM Guest Patching on Windows.

    Field Description
    assessmentMode
    PatchSettings_AssessmentMode

    AssessmentMode: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    WindowsVMGuestPatchAutomaticByPlatformSettings

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

    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
    PatchSettings_PatchMode

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

    PatchSettings_ARM

    (Appears on:WindowsConfiguration_ARM)

    Specifies settings related to VM Guest Patching on Windows.

    Field Description
    assessmentMode
    PatchSettings_AssessmentMode

    AssessmentMode: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    WindowsVMGuestPatchAutomaticByPlatformSettings_ARM

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

    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
    PatchSettings_PatchMode

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

    PatchSettings_AssessmentMode (string alias)

    (Appears on:PatchSettings, PatchSettings_ARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    PatchSettings_AssessmentMode_STATUS (string alias)

    (Appears on:PatchSettings_STATUS, PatchSettings_STATUS_ARM)

    Value Description

    "AutomaticByPlatform"

    "ImageDefault"

    PatchSettings_PatchMode (string alias)

    (Appears on:PatchSettings, PatchSettings_ARM)

    Value Description

    "AutomaticByOS"

    "AutomaticByPlatform"

    "Manual"

    PatchSettings_PatchMode_STATUS (string alias)

    (Appears on:PatchSettings_STATUS, PatchSettings_STATUS_ARM)

    Value Description

    "AutomaticByOS"

    "AutomaticByPlatform"

    "Manual"

    PatchSettings_STATUS

    (Appears on:WindowsConfiguration_STATUS)

    Specifies settings related to VM Guest Patching on Windows.

    Field Description
    assessmentMode
    PatchSettings_AssessmentMode_STATUS

    AssessmentMode: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    WindowsVMGuestPatchAutomaticByPlatformSettings_STATUS

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

    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
    PatchSettings_PatchMode_STATUS

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

    PatchSettings_STATUS_ARM

    (Appears on:WindowsConfiguration_STATUS_ARM)

    Specifies settings related to VM Guest Patching on Windows.

    Field Description
    assessmentMode
    PatchSettings_AssessmentMode_STATUS

    AssessmentMode: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

    automaticByPlatformSettings
    WindowsVMGuestPatchAutomaticByPlatformSettings_STATUS_ARM

    AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

    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
    PatchSettings_PatchMode_STATUS

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

    Plan

    (Appears on:VirtualMachineScaleSet_Spec, VirtualMachine_Spec)

    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.

    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_ARM

    (Appears on:VirtualMachineScaleSet_Spec_ARM, VirtualMachine_Spec_ARM)

    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.

    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)

    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.

    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_ARM

    (Appears on:VirtualMachineScaleSet_STATUS_ARM, VirtualMachine_STATUS_ARM)

    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.

    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 (string alias)

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile, VirtualMachineScaleSetVMProfile_ARM, VirtualMachine_Spec)

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

    Value Description

    "Low"

    "Regular"

    "Spot"

    Priority_STATUS (string alias)

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS, VirtualMachineScaleSetVMProfile_STATUS_ARM, VirtualMachine_STATUS)

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

    Value Description

    "Low"

    "Regular"

    "Spot"

    PublicIPAddressSku

    (Appears on:VirtualMachinePublicIPAddressConfiguration, VirtualMachineScaleSetPublicIPAddressConfiguration)

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

    Field Description
    name
    PublicIPAddressSku_Name

    Name: Specify public IP sku name

    tier
    PublicIPAddressSku_Tier

    Tier: Specify public IP sku tier

    PublicIPAddressSku_ARM

    (Appears on:VirtualMachinePublicIPAddressConfiguration_ARM, VirtualMachineScaleSetPublicIPAddressConfiguration_ARM)

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

    Field Description
    name
    PublicIPAddressSku_Name

    Name: Specify public IP sku name

    tier
    PublicIPAddressSku_Tier

    Tier: Specify public IP sku tier

    PublicIPAddressSku_Name (string alias)

    (Appears on:PublicIPAddressSku, PublicIPAddressSku_ARM)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSku_Name_STATUS (string alias)

    (Appears on:PublicIPAddressSku_STATUS, PublicIPAddressSku_STATUS_ARM)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSku_STATUS

    (Appears on:VirtualMachinePublicIPAddressConfiguration_STATUS, VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS)

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

    Field Description
    name
    PublicIPAddressSku_Name_STATUS

    Name: Specify public IP sku name

    tier
    PublicIPAddressSku_Tier_STATUS

    Tier: Specify public IP sku tier

    PublicIPAddressSku_STATUS_ARM

    (Appears on:VirtualMachinePublicIPAddressConfiguration_STATUS_ARM, VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS_ARM)

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

    Field Description
    name
    PublicIPAddressSku_Name_STATUS

    Name: Specify public IP sku name

    tier
    PublicIPAddressSku_Tier_STATUS

    Tier: Specify public IP sku tier

    PublicIPAddressSku_Tier (string alias)

    (Appears on:PublicIPAddressSku, PublicIPAddressSku_ARM)

    Value Description

    "Global"

    "Regional"

    PublicIPAddressSku_Tier_STATUS (string alias)

    (Appears on:PublicIPAddressSku_STATUS, PublicIPAddressSku_STATUS_ARM)

    Value Description

    "Global"

    "Regional"

    RollingUpgradePolicy

    (Appears on:UpgradePolicy)

    The configuration parameters used while performing a rolling upgrade.

    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_ARM

    (Appears on:UpgradePolicy_ARM)

    The configuration parameters used while performing a rolling upgrade.

    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)

    The configuration parameters used while performing a rolling upgrade.

    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_ARM

    (Appears on:UpgradePolicy_STATUS_ARM)

    The configuration parameters used while performing a rolling upgrade.

    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:VirtualMachineScaleSet_Spec)

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

    Field Description
    forceDeletion
    bool

    ForceDeletion: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)

    rules
    []ScaleInPolicy_Rules

    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_ARM

    (Appears on:VirtualMachineScaleSetProperties_ARM)

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

    Field Description
    forceDeletion
    bool

    ForceDeletion: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)

    rules
    []ScaleInPolicy_Rules

    Rules: The rules to be followed when scaling-in a virtual machine scale set. Possible values are: Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    ScaleInPolicy_Rules (string alias)

    (Appears on:ScaleInPolicy, ScaleInPolicy_ARM)

    Value Description

    "Default"

    "NewestVM"

    "OldestVM"

    ScaleInPolicy_Rules_STATUS (string alias)

    (Appears on:ScaleInPolicy_STATUS, ScaleInPolicy_STATUS_ARM)

    Value Description

    "Default"

    "NewestVM"

    "OldestVM"

    ScaleInPolicy_STATUS

    (Appears on:VirtualMachineScaleSet_STATUS)

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

    Field Description
    forceDeletion
    bool

    ForceDeletion: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)

    rules
    []ScaleInPolicy_Rules_STATUS

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetProperties_STATUS_ARM)

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

    Field Description
    forceDeletion
    bool

    ForceDeletion: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)

    rules
    []ScaleInPolicy_Rules_STATUS

    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:VirtualMachineScaleSetVMProfile, VirtualMachine_Spec)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile

    TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

    ScheduledEventsProfile_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile_ARM)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile_ARM

    TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

    ScheduledEventsProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS, VirtualMachine_STATUS)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile_STATUS

    TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

    ScheduledEventsProfile_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS_ARM)

    Field Description
    terminateNotificationProfile
    TerminateNotificationProfile_STATUS_ARM

    TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

    SecurityProfile

    (Appears on:VirtualMachineScaleSetVMProfile, VirtualMachine_Spec)

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

    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
    SecurityProfile_SecurityType

    SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

    uefiSettings
    UefiSettings

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

    SecurityProfile_ARM

    (Appears on:VirtualMachineProperties_ARM, VirtualMachineScaleSetVMProfile_ARM)

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

    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
    SecurityProfile_SecurityType

    SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

    uefiSettings
    UefiSettings_ARM

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

    SecurityProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS, VirtualMachine_STATUS)

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

    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
    SecurityProfile_SecurityType_STATUS

    SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

    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_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM, VirtualMachineScaleSetVMProfile_STATUS_ARM)

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

    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
    SecurityProfile_SecurityType_STATUS

    SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

    uefiSettings
    UefiSettings_STATUS_ARM

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

    SecurityProfile_SecurityType (string alias)

    (Appears on:SecurityProfile, SecurityProfile_ARM)

    Value Description

    "ConfidentialVM"

    "TrustedLaunch"

    SecurityProfile_SecurityType_STATUS (string alias)

    (Appears on:SecurityProfile_STATUS, SecurityProfile_STATUS_ARM)

    Value Description

    "ConfidentialVM"

    "TrustedLaunch"

    Sku

    (Appears on:VirtualMachineScaleSet_Spec)

    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.

    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_ARM

    (Appears on:VirtualMachineScaleSet_Spec_ARM)

    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.

    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)

    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.

    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_ARM

    (Appears on:VirtualMachineScaleSet_STATUS_ARM)

    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.

    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

    SpotRestorePolicy

    (Appears on:VirtualMachineScaleSet_Spec)

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

    Field Description
    enabled
    bool

    Enabled: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

    restoreTimeout
    string

    RestoreTimeout: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

    SpotRestorePolicy_ARM

    (Appears on:VirtualMachineScaleSetProperties_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

    restoreTimeout
    string

    RestoreTimeout: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

    SpotRestorePolicy_STATUS

    (Appears on:VirtualMachineScaleSet_STATUS)

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

    Field Description
    enabled
    bool

    Enabled: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

    restoreTimeout
    string

    RestoreTimeout: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

    SpotRestorePolicy_STATUS_ARM

    (Appears on:VirtualMachineScaleSetProperties_STATUS_ARM)

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

    Field Description
    enabled
    bool

    Enabled: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

    restoreTimeout
    string

    RestoreTimeout: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

    SshConfiguration

    (Appears on:LinuxConfiguration)

    SSH configuration for Linux based VMs running on Azure

    Field Description
    publicKeys
    []SshPublicKeySpec

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

    SshConfiguration_ARM

    (Appears on:LinuxConfiguration_ARM)

    SSH configuration for Linux based VMs running on Azure

    Field Description
    publicKeys
    []SshPublicKeySpec_ARM

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

    SshConfiguration_STATUS

    (Appears on:LinuxConfiguration_STATUS)

    SSH configuration for Linux based VMs running on Azure

    Field Description
    publicKeys
    []SshPublicKey_STATUS

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

    SshConfiguration_STATUS_ARM

    (Appears on:LinuxConfiguration_STATUS_ARM)

    SSH configuration for Linux based VMs running on Azure

    Field Description
    publicKeys
    []SshPublicKey_STATUS_ARM

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

    SshPublicKeySpec

    (Appears on:SshConfiguration)

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

    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]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

    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

    SshPublicKeySpec_ARM

    (Appears on:SshConfiguration_ARM)

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

    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]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

    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)

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

    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]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

    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_ARM

    (Appears on:SshConfiguration_STATUS_ARM)

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

    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]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

    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 (string alias)

    (Appears on:ImageDataDisk, ImageDataDisk_ARM, ImageOSDisk, ImageOSDisk_ARM, ManagedDiskParameters, ManagedDiskParameters_ARM, VirtualMachineScaleSetManagedDiskParameters, VirtualMachineScaleSetManagedDiskParameters_ARM)

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

    Value Description

    "PremiumV2_LRS"

    "Premium_LRS"

    "Premium_ZRS"

    "StandardSSD_LRS"

    "StandardSSD_ZRS"

    "Standard_LRS"

    "UltraSSD_LRS"

    StorageAccountType_STATUS (string alias)

    (Appears on:ImageDataDisk_STATUS, ImageDataDisk_STATUS_ARM, ImageOSDisk_STATUS, ImageOSDisk_STATUS_ARM, ManagedDiskParameters_STATUS, ManagedDiskParameters_STATUS_ARM, VirtualMachineScaleSetManagedDiskParameters_STATUS, VirtualMachineScaleSetManagedDiskParameters_STATUS_ARM)

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

    Value Description

    "PremiumV2_LRS"

    "Premium_LRS"

    "Premium_ZRS"

    "StandardSSD_LRS"

    "StandardSSD_ZRS"

    "Standard_LRS"

    "UltraSSD_LRS"

    StorageProfile

    (Appears on:VirtualMachine_Spec)

    Specifies the storage settings for the virtual machine disks.

    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.

    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.

    StorageProfile_ARM

    (Appears on:VirtualMachineProperties_ARM)

    Specifies the storage settings for the virtual machine disks.

    Field Description
    dataDisks
    []DataDisk_ARM

    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_ARM

    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_ARM

    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)

    Specifies the storage settings for the virtual machine disks.

    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_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM)

    Specifies the storage settings for the virtual machine disks.

    Field Description
    dataDisks
    []DataDisk_STATUS_ARM

    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_ARM

    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_ARM

    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:CapacityReservationProfile, ImageDataDisk, ImageOSDisk, Image_Spec, KeyVaultKeyReference, KeyVaultSecretReference, ManagedDiskParameters, VMDiskSecurityProfile, VaultSecretGroup, VirtualMachineNetworkInterfaceConfiguration, VirtualMachineNetworkInterfaceIPConfiguration, VirtualMachinePublicIPAddressConfiguration, VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetManagedDiskParameters, VirtualMachineScaleSetNetworkConfiguration, VirtualMachineScaleSetPublicIPAddressConfiguration, VirtualMachineScaleSet_Spec, VirtualMachine_Spec)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource Id

    SubResource_ARM

    (Appears on:CapacityReservationProfile_ARM, ImageDataDisk_ARM, ImageOSDisk_ARM, ImageProperties_ARM, KeyVaultKeyReference_ARM, KeyVaultSecretReference_ARM, ManagedDiskParameters_ARM, VMDiskSecurityProfile_ARM, VaultSecretGroup_ARM, VirtualMachineNetworkInterfaceConfigurationProperties_ARM, VirtualMachineNetworkInterfaceIPConfigurationProperties_ARM, VirtualMachineProperties_ARM, VirtualMachinePublicIPAddressConfigurationProperties_ARM, VirtualMachineScaleSetIPConfigurationProperties_ARM, VirtualMachineScaleSetManagedDiskParameters_ARM, VirtualMachineScaleSetNetworkConfigurationProperties_ARM, VirtualMachineScaleSetProperties_ARM, VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM)

    Field Description
    id
    string

    SubResource_STATUS

    (Appears on:CapacityReservationProfile_STATUS, ImageDataDisk_STATUS, ImageOSDisk_STATUS, Image_STATUS, KeyVaultKeyReference_STATUS, KeyVaultSecretReference_STATUS, ManagedDiskParameters_STATUS, VMDiskSecurityProfile_STATUS, VaultSecretGroup_STATUS, VirtualMachineNetworkInterfaceConfiguration_STATUS, VirtualMachineNetworkInterfaceIPConfiguration_STATUS, VirtualMachinePublicIPAddressConfiguration_STATUS, VirtualMachineScaleSetIPConfiguration_STATUS, VirtualMachineScaleSetManagedDiskParameters_STATUS, VirtualMachineScaleSetNetworkConfiguration_STATUS, VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS, VirtualMachineScaleSet_STATUS, VirtualMachine_STATUS)

    Field Description
    id
    string

    Id: Resource Id

    SubResource_STATUS_ARM

    (Appears on:CapacityReservationProfile_STATUS_ARM, ImageDataDisk_STATUS_ARM, ImageOSDisk_STATUS_ARM, ImageProperties_STATUS_ARM, KeyVaultKeyReference_STATUS_ARM, KeyVaultSecretReference_STATUS_ARM, ManagedDiskParameters_STATUS_ARM, VMDiskSecurityProfile_STATUS_ARM, VaultSecretGroup_STATUS_ARM, VirtualMachineNetworkInterfaceConfigurationProperties_STATUS_ARM, VirtualMachineNetworkInterfaceIPConfigurationProperties_STATUS_ARM, VirtualMachineProperties_STATUS_ARM, VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetIPConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetManagedDiskParameters_STATUS_ARM, VirtualMachineScaleSetNetworkConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetProperties_STATUS_ARM, VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM)

    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)

    TerminateNotificationProfile_ARM

    (Appears on:ScheduledEventsProfile_ARM)

    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_STATUS_ARM

    (Appears on:ScheduledEventsProfile_STATUS_ARM)

    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)

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

    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_ARM

    (Appears on:SecurityProfile_ARM)

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

    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)

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

    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_ARM

    (Appears on:SecurityProfile_STATUS_ARM)

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

    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:VirtualMachineScaleSet_Spec)

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

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy

    AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

    mode
    UpgradePolicy_Mode

    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.

    UpgradePolicy_ARM

    (Appears on:VirtualMachineScaleSetProperties_ARM)

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

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy_ARM

    AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

    mode
    UpgradePolicy_Mode

    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_ARM

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

    UpgradePolicy_Mode (string alias)

    (Appears on:UpgradePolicy, UpgradePolicy_ARM)

    Value Description

    "Automatic"

    "Manual"

    "Rolling"

    UpgradePolicy_Mode_STATUS (string alias)

    (Appears on:UpgradePolicy_STATUS, UpgradePolicy_STATUS_ARM)

    Value Description

    "Automatic"

    "Manual"

    "Rolling"

    UpgradePolicy_STATUS

    (Appears on:VirtualMachineScaleSet_STATUS)

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

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy_STATUS

    AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

    mode
    UpgradePolicy_Mode_STATUS

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetProperties_STATUS_ARM)

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

    Field Description
    automaticOSUpgradePolicy
    AutomaticOSUpgradePolicy_STATUS_ARM

    AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

    mode
    UpgradePolicy_Mode_STATUS

    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_ARM

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

    UserAssignedIdentityDetails

    (Appears on:VirtualMachineIdentity, VirtualMachineScaleSetIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:VirtualMachineIdentity_ARM, VirtualMachineScaleSetIdentity_ARM)

    Information about the user assigned identity for the resource

    VMDiskSecurityProfile

    (Appears on:ManagedDiskParameters, VirtualMachineScaleSetManagedDiskParameters)

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

    Field Description
    diskEncryptionSet
    SubResource

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.

    securityEncryptionType
    VMDiskSecurityProfile_SecurityEncryptionType

    SecurityEncryptionType: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.

    VMDiskSecurityProfile_ARM

    (Appears on:ManagedDiskParameters_ARM, VirtualMachineScaleSetManagedDiskParameters_ARM)

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

    Field Description
    diskEncryptionSet
    SubResource_ARM

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.

    securityEncryptionType
    VMDiskSecurityProfile_SecurityEncryptionType

    SecurityEncryptionType: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.

    VMDiskSecurityProfile_STATUS

    (Appears on:ManagedDiskParameters_STATUS, VirtualMachineScaleSetManagedDiskParameters_STATUS)

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

    Field Description
    diskEncryptionSet
    SubResource_STATUS

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.

    securityEncryptionType
    VMDiskSecurityProfile_SecurityEncryptionType_STATUS

    SecurityEncryptionType: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.

    VMDiskSecurityProfile_STATUS_ARM

    (Appears on:ManagedDiskParameters_STATUS_ARM, VirtualMachineScaleSetManagedDiskParameters_STATUS_ARM)

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

    Field Description
    diskEncryptionSet
    SubResource_STATUS_ARM

    DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.

    securityEncryptionType
    VMDiskSecurityProfile_SecurityEncryptionType_STATUS

    SecurityEncryptionType: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.

    VMDiskSecurityProfile_SecurityEncryptionType (string alias)

    (Appears on:VMDiskSecurityProfile, VMDiskSecurityProfile_ARM)

    Value Description

    "DiskWithVMGuestState"

    "VMGuestStateOnly"

    VMDiskSecurityProfile_SecurityEncryptionType_STATUS (string alias)

    (Appears on:VMDiskSecurityProfile_STATUS, VMDiskSecurityProfile_STATUS_ARM)

    Value Description

    "DiskWithVMGuestState"

    "VMGuestStateOnly"

    VMGalleryApplication

    (Appears on:ApplicationProfile)

    Specifies the required information to reference a compute gallery application version

    Field Description
    configurationReference
    string

    ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS

    order
    int

    Order: Optional, Specifies the order in which the packages have to be installed

    packageReferenceReference
    genruntime.ResourceReference

    PackageReferenceReference: Specifies the GalleryApplicationVersion resource id on the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​applications/​{application}/​versions/​{version}

    tags
    string

    Tags: Optional, Specifies a passthrough value for more generic context.

    treatFailureAsDeploymentFailure
    bool

    TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the deployment

    VMGalleryApplication_ARM

    (Appears on:ApplicationProfile_ARM)

    Specifies the required information to reference a compute gallery application version

    Field Description
    configurationReference
    string

    ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS

    order
    int

    Order: Optional, Specifies the order in which the packages have to be installed

    packageReferenceId
    string
    tags
    string

    Tags: Optional, Specifies a passthrough value for more generic context.

    treatFailureAsDeploymentFailure
    bool

    TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the deployment

    VMGalleryApplication_STATUS

    (Appears on:ApplicationProfile_STATUS)

    Specifies the required information to reference a compute gallery application version

    Field Description
    configurationReference
    string

    ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS

    order
    int

    Order: Optional, Specifies the order in which the packages have to be installed

    packageReferenceId
    string

    PackageReferenceId: Specifies the GalleryApplicationVersion resource id on the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​applications/​{application}/​versions/​{version}

    tags
    string

    Tags: Optional, Specifies a passthrough value for more generic context.

    treatFailureAsDeploymentFailure
    bool

    TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the deployment

    VMGalleryApplication_STATUS_ARM

    (Appears on:ApplicationProfile_STATUS_ARM)

    Specifies the required information to reference a compute gallery application version

    Field Description
    configurationReference
    string

    ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided

    enableAutomaticUpgrade
    bool

    EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS

    order
    int

    Order: Optional, Specifies the order in which the packages have to be installed

    packageReferenceId
    string

    PackageReferenceId: Specifies the GalleryApplicationVersion resource id on the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​applications/​{application}/​versions/​{version}

    tags
    string

    Tags: Optional, Specifies a passthrough value for more generic context.

    treatFailureAsDeploymentFailure
    bool

    TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the deployment

    VMSizeProperties

    (Appears on:HardwareProfile, VirtualMachineScaleSetHardwareProfile)

    Specifies VM Size Property settings on the virtual machine.

    Field Description
    vCPUsAvailable
    int

    VCPUsAvailable: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

    vCPUsPerCore
    int

    VCPUsPerCore: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.

    VMSizeProperties_ARM

    (Appears on:HardwareProfile_ARM, VirtualMachineScaleSetHardwareProfile_ARM)

    Specifies VM Size Property settings on the virtual machine.

    Field Description
    vCPUsAvailable
    int

    VCPUsAvailable: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

    vCPUsPerCore
    int

    VCPUsPerCore: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.

    VMSizeProperties_STATUS

    (Appears on:HardwareProfile_STATUS, VirtualMachineScaleSetHardwareProfile_STATUS)

    Specifies VM Size Property settings on the virtual machine.

    Field Description
    vCPUsAvailable
    int

    VCPUsAvailable: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

    vCPUsPerCore
    int

    VCPUsPerCore: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.

    VMSizeProperties_STATUS_ARM

    (Appears on:HardwareProfile_STATUS_ARM, VirtualMachineScaleSetHardwareProfile_STATUS_ARM)

    Specifies VM Size Property settings on the virtual machine.

    Field Description
    vCPUsAvailable
    int

    VCPUsAvailable: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

    vCPUsPerCore
    int

    VCPUsPerCore: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.

    VaultCertificate

    (Appears on:VaultSecretGroup)

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

    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”:”” } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    VaultCertificate_ARM

    (Appears on:VaultSecretGroup_ARM)

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

    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”:”” } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    VaultCertificate_STATUS

    (Appears on:VaultSecretGroup_STATUS)

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

    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”:”” } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    VaultCertificate_STATUS_ARM

    (Appears on:VaultSecretGroup_STATUS_ARM)

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

    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”:”” } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    VaultSecretGroup

    (Appears on:OSProfile, VirtualMachineScaleSetOSProfile)

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

    Field Description
    sourceVault
    SubResource

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

    vaultCertificates
    []VaultCertificate

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

    VaultSecretGroup_ARM

    (Appears on:OSProfile_ARM, VirtualMachineScaleSetOSProfile_ARM)

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

    Field Description
    sourceVault
    SubResource_ARM

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

    vaultCertificates
    []VaultCertificate_ARM

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

    VaultSecretGroup_STATUS

    (Appears on:OSProfile_STATUS, VirtualMachineScaleSetOSProfile_STATUS)

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

    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_STATUS_ARM

    (Appears on:OSProfile_STATUS_ARM, VirtualMachineScaleSetOSProfile_STATUS_ARM)

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

    Field Description
    sourceVault
    SubResource_STATUS_ARM

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

    vaultCertificates
    []VaultCertificate_STATUS_ARM

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

    VirtualHardDisk

    (Appears on:DataDisk, OSDisk, VirtualMachineScaleSetOSDisk)

    Describes the uri of a disk.

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualHardDisk_ARM

    (Appears on:DataDisk_ARM, OSDisk_ARM, VirtualMachineScaleSetOSDisk_ARM)

    Describes the uri of a disk.

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualHardDisk_STATUS

    (Appears on:DataDisk_STATUS, OSDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS)

    Describes the uri of a disk.

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualHardDisk_STATUS_ARM

    (Appears on:DataDisk_STATUS_ARM, OSDisk_STATUS_ARM, VirtualMachineScaleSetOSDisk_STATUS_ARM)

    Describes the uri of a disk.

    Field Description
    uri
    string

    Uri: Specifies the virtual hard disk’s uri.

    VirtualMachine

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

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


    additionalCapabilities
    AdditionalCapabilities

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

    applicationProfile
    ApplicationProfile

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    availabilitySet
    SubResource

    AvailabilitySet: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

    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 virtual machine. Minimum api-version: 2019-03-01.

    capacityReservation
    CapacityReservationProfile

    CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile

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

    evictionPolicy
    EvictionPolicy

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

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource

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

    hostGroup
    SubResource

    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.

    identity
    VirtualMachineIdentity

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

    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

    networkProfile
    NetworkProfile

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    OSProfile

    OsProfile: Specifies the operating system settings used while creating 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
    Priority

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

    proximityPlacementGroup
    SubResource

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

    scheduledEventsProfile
    ScheduledEventsProfile

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile

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

    storageProfile
    StorageProfile

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

    tags
    map[string]string

    Tags: Resource tags

    userData
    string

    UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    virtualMachineScaleSet
    SubResource

    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

    zones
    []string

    Zones: The virtual machine zones.

    status
    VirtualMachine_STATUS

    VirtualMachineAgentInstanceView_STATUS

    (Appears on:VirtualMachineInstanceView_STATUS)

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

    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_STATUS_ARM

    (Appears on:VirtualMachineInstanceView_STATUS_ARM)

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

    Field Description
    extensionHandlers
    []VirtualMachineExtensionHandlerInstanceView_STATUS_ARM

    ExtensionHandlers: The virtual machine extension handler instance view.

    statuses
    []InstanceViewStatus_STATUS_ARM

    Statuses: The resource status information.

    vmAgentVersion
    string

    VmAgentVersion: The VM Agent full version.

    VirtualMachineExtensionHandlerInstanceView_STATUS

    (Appears on:VirtualMachineAgentInstanceView_STATUS)

    The instance view of a virtual machine extension handler.

    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_STATUS_ARM

    (Appears on:VirtualMachineAgentInstanceView_STATUS_ARM)

    The instance view of a virtual machine extension handler.

    Field Description
    status
    InstanceViewStatus_STATUS_ARM

    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

    (Appears on:VirtualMachines_Extension_Spec)

    The instance view of a virtual machine extension.

    Field Description
    name
    string

    Name: The virtual machine extension name.

    statuses
    []InstanceViewStatus

    Statuses: The resource status information.

    substatuses
    []InstanceViewStatus

    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_ARM

    (Appears on:VirtualMachineExtensionProperties_ARM)

    The instance view of a virtual machine extension.

    Field Description
    name
    string

    Name: The virtual machine extension name.

    statuses
    []InstanceViewStatus_ARM

    Statuses: The resource status information.

    substatuses
    []InstanceViewStatus_ARM

    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_STATUS

    (Appears on:VirtualMachineExtension_STATUS, VirtualMachineInstanceView_STATUS, VirtualMachines_Extension_STATUS)

    The instance view of a virtual machine extension.

    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_STATUS_ARM

    (Appears on:VirtualMachineExtensionProperties_STATUS_ARM, VirtualMachineInstanceView_STATUS_ARM)

    The instance view of a virtual machine extension.

    Field Description
    name
    string

    Name: The virtual machine extension name.

    statuses
    []InstanceViewStatus_STATUS_ARM

    Statuses: The resource status information.

    substatuses
    []InstanceViewStatus_STATUS_ARM

    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_ARM

    (Appears on:VirtualMachines_Extension_Spec_ARM)

    Describes the properties of a Virtual Machine Extension.

    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_ARM

    InstanceView: The virtual machine extension instance view.

    protectedSettings
    map[string]string

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_ARM

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

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

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtensionProperties_STATUS_ARM

    (Appears on:VirtualMachineExtension_STATUS_ARM, VirtualMachines_Extension_STATUS_ARM)

    Describes the properties of a Virtual Machine Extension.

    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_STATUS_ARM

    InstanceView: The virtual machine extension instance view.

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_STATUS_ARM

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    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)

    Describes a Virtual Machine Extension.

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_STATUS

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineExtension_STATUS_ARM

    (Appears on:VirtualMachine_STATUS_ARM)

    Describes a Virtual Machine Extension.

    Field Description
    id
    string

    Id: Resource Id

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    properties
    VirtualMachineExtensionProperties_STATUS_ARM

    Properties: Describes the properties of a Virtual Machine Extension.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Resource type

    VirtualMachineHealthStatus_STATUS

    (Appears on:VirtualMachineInstanceView_STATUS)

    The health status of the VM.

    Field Description
    status
    InstanceViewStatus_STATUS

    Status: The health status information for the VM.

    VirtualMachineHealthStatus_STATUS_ARM

    (Appears on:VirtualMachineInstanceView_STATUS_ARM)

    The health status of the VM.

    Field Description
    status
    InstanceViewStatus_STATUS_ARM

    Status: The health status information for the VM.

    VirtualMachineIdentity

    (Appears on:VirtualMachine_Spec)

    Identity for the virtual machine.

    Field Description
    type
    VirtualMachineIdentity_Type

    Type: The type of identity used for the virtual machine. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    VirtualMachineIdentity_ARM

    (Appears on:VirtualMachine_Spec_ARM)

    Identity for the virtual machine.

    Field Description
    type
    VirtualMachineIdentity_Type

    Type: The type of identity used for the virtual machine. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.

    userAssignedIdentities
    map[string]./api/compute/v1api20220301.UserAssignedIdentityDetails_ARM

    VirtualMachineIdentity_STATUS

    (Appears on:VirtualMachine_STATUS)

    Identity for the virtual machine.

    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
    VirtualMachineIdentity_Type_STATUS

    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.

    userAssignedIdentities
    map[string]./api/compute/v1api20220301.VirtualMachineIdentity_UserAssignedIdentities_STATUS

    UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    VirtualMachineIdentity_STATUS_ARM

    (Appears on:VirtualMachine_STATUS_ARM)

    Identity for the virtual machine.

    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
    VirtualMachineIdentity_Type_STATUS

    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.

    userAssignedIdentities
    map[string]./api/compute/v1api20220301.VirtualMachineIdentity_UserAssignedIdentities_STATUS_ARM

    UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    VirtualMachineIdentity_Type (string alias)

    (Appears on:VirtualMachineIdentity, VirtualMachineIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineIdentity_Type_STATUS (string alias)

    (Appears on:VirtualMachineIdentity_STATUS, VirtualMachineIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineIdentity_UserAssignedIdentities_STATUS

    (Appears on:VirtualMachineIdentity_STATUS)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    VirtualMachineIdentity_UserAssignedIdentities_STATUS_ARM

    (Appears on:VirtualMachineIdentity_STATUS_ARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    VirtualMachineInstanceView_HyperVGeneration_STATUS (string alias)

    (Appears on:VirtualMachineInstanceView_STATUS, VirtualMachineInstanceView_STATUS_ARM)

    Value Description

    "V1"

    "V2"

    VirtualMachineInstanceView_STATUS

    (Appears on:VirtualMachine_STATUS)

    The instance view of a virtual machine.

    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
    VirtualMachineInstanceView_HyperVGeneration_STATUS

    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_STATUS_ARM

    (Appears on:VirtualMachineProperties_STATUS_ARM)

    The instance view of a virtual machine.

    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_ARM

    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_ARM

    Disks: The virtual machine disk information.

    extensions
    []VirtualMachineExtensionInstanceView_STATUS_ARM

    Extensions: The extensions information.

    hyperVGeneration
    VirtualMachineInstanceView_HyperVGeneration_STATUS

    HyperVGeneration: Specifies the HyperVGeneration Type associated with a resource

    maintenanceRedeployStatus
    MaintenanceRedeployStatus_STATUS_ARM

    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_ARM

    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_ARM

    Statuses: The resource status information.

    vmAgent
    VirtualMachineAgentInstanceView_STATUS_ARM

    VmAgent: The VM Agent running on the virtual machine.

    vmHealth
    VirtualMachineHealthStatus_STATUS_ARM

    VmHealth: The health status for the VM.

    VirtualMachineIpTag

    (Appears on:VirtualMachinePublicIPAddressConfiguration)

    Contains the IP tag associated with the public IP address.

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

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

    VirtualMachineIpTag_ARM

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_ARM)

    Contains the IP tag associated with the public IP address.

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

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

    VirtualMachineIpTag_STATUS

    (Appears on:VirtualMachinePublicIPAddressConfiguration_STATUS)

    Contains the IP tag associated with the public IP address.

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

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

    VirtualMachineIpTag_STATUS_ARM

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM)

    Contains the IP tag associated with the public IP address.

    Field Description
    ipTagType
    string

    IpTagType: IP tag type. Example: FirstPartyUsage.

    tag
    string

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

    VirtualMachineNetworkInterfaceConfiguration

    (Appears on:NetworkProfile)

    Describes a virtual machine network interface configurations.

    Field Description
    deleteOption
    VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineNetworkInterfaceDnsSettingsConfiguration

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

    dscpConfiguration
    SubResource
    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
    []VirtualMachineNetworkInterfaceIPConfiguration

    IpConfigurations: Specifies the IP configurations of the network interface.

    name
    string

    Name: The network interface configuration name.

    networkSecurityGroup
    SubResource

    NetworkSecurityGroup: The network security group.

    primary
    bool

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

    VirtualMachineNetworkInterfaceConfigurationProperties_ARM

    (Appears on:VirtualMachineNetworkInterfaceConfiguration_ARM)

    Describes a virtual machine network profile’s IP configuration.

    Field Description
    deleteOption
    VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineNetworkInterfaceDnsSettingsConfiguration_ARM

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

    dscpConfiguration
    SubResource_ARM
    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
    []VirtualMachineNetworkInterfaceIPConfiguration_ARM

    IpConfigurations: Specifies the IP configurations of the network interface.

    networkSecurityGroup
    SubResource_ARM

    NetworkSecurityGroup: The network security group.

    primary
    bool

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

    VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption (string alias)

    (Appears on:VirtualMachineNetworkInterfaceConfiguration, VirtualMachineNetworkInterfaceConfigurationProperties_ARM)

    Value Description

    "Delete"

    "Detach"

    VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption_STATUS (string alias)

    (Appears on:VirtualMachineNetworkInterfaceConfigurationProperties_STATUS_ARM, VirtualMachineNetworkInterfaceConfiguration_STATUS)

    Value Description

    "Delete"

    "Detach"

    VirtualMachineNetworkInterfaceConfigurationProperties_STATUS_ARM

    (Appears on:VirtualMachineNetworkInterfaceConfiguration_STATUS_ARM)

    Describes a virtual machine network profile’s IP configuration.

    Field Description
    deleteOption
    VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineNetworkInterfaceDnsSettingsConfiguration_STATUS_ARM

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

    dscpConfiguration
    SubResource_STATUS_ARM
    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
    []VirtualMachineNetworkInterfaceIPConfiguration_STATUS_ARM

    IpConfigurations: Specifies the IP configurations of the network interface.

    networkSecurityGroup
    SubResource_STATUS_ARM

    NetworkSecurityGroup: The network security group.

    primary
    bool

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

    VirtualMachineNetworkInterfaceConfiguration_ARM

    (Appears on:NetworkProfile_ARM)

    Describes a virtual machine network interface configurations.

    Field Description
    name
    string

    Name: The network interface configuration name.

    properties
    VirtualMachineNetworkInterfaceConfigurationProperties_ARM

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

    VirtualMachineNetworkInterfaceConfiguration_STATUS

    (Appears on:NetworkProfile_STATUS)

    Describes a virtual machine network interface configurations.

    Field Description
    deleteOption
    VirtualMachineNetworkInterfaceConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineNetworkInterfaceDnsSettingsConfiguration_STATUS

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

    dscpConfiguration
    SubResource_STATUS
    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
    []VirtualMachineNetworkInterfaceIPConfiguration_STATUS

    IpConfigurations: Specifies the IP configurations of the network interface.

    name
    string

    Name: The network interface 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.

    VirtualMachineNetworkInterfaceConfiguration_STATUS_ARM

    (Appears on:NetworkProfile_STATUS_ARM)

    Describes a virtual machine network interface configurations.

    Field Description
    name
    string

    Name: The network interface configuration name.

    properties
    VirtualMachineNetworkInterfaceConfigurationProperties_STATUS_ARM

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

    VirtualMachineNetworkInterfaceDnsSettingsConfiguration

    (Appears on:VirtualMachineNetworkInterfaceConfiguration)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineNetworkInterfaceDnsSettingsConfiguration_ARM

    (Appears on:VirtualMachineNetworkInterfaceConfigurationProperties_ARM)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineNetworkInterfaceDnsSettingsConfiguration_STATUS

    (Appears on:VirtualMachineNetworkInterfaceConfiguration_STATUS)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineNetworkInterfaceDnsSettingsConfiguration_STATUS_ARM

    (Appears on:VirtualMachineNetworkInterfaceConfigurationProperties_STATUS_ARM)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineNetworkInterfaceIPConfiguration

    (Appears on:VirtualMachineNetworkInterfaceConfiguration)

    Describes a virtual machine network profile’s IP configuration.

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource

    ApplicationGatewayBackendAddressPools: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.

    applicationSecurityGroups
    []SubResource

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

    loadBalancerBackendAddressPools
    []SubResource

    LoadBalancerBackendAddressPools: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].

    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
    VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion

    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
    VirtualMachinePublicIPAddressConfiguration

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    SubResource

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineNetworkInterfaceIPConfigurationProperties_ARM

    (Appears on:VirtualMachineNetworkInterfaceIPConfiguration_ARM)

    Describes a virtual machine network interface IP configuration properties.

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_ARM

    ApplicationGatewayBackendAddressPools: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.

    applicationSecurityGroups
    []SubResource_ARM

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

    loadBalancerBackendAddressPools
    []SubResource_ARM

    LoadBalancerBackendAddressPools: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].

    primary
    bool

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

    privateIPAddressVersion
    VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion

    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
    VirtualMachinePublicIPAddressConfiguration_ARM

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    SubResource_ARM

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion (string alias)

    (Appears on:VirtualMachineNetworkInterfaceIPConfiguration, VirtualMachineNetworkInterfaceIPConfigurationProperties_ARM)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion_STATUS (string alias)

    (Appears on:VirtualMachineNetworkInterfaceIPConfigurationProperties_STATUS_ARM, VirtualMachineNetworkInterfaceIPConfiguration_STATUS)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineNetworkInterfaceIPConfigurationProperties_STATUS_ARM

    (Appears on:VirtualMachineNetworkInterfaceIPConfiguration_STATUS_ARM)

    Describes a virtual machine network interface IP configuration properties.

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_STATUS_ARM

    ApplicationGatewayBackendAddressPools: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.

    applicationSecurityGroups
    []SubResource_STATUS_ARM

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

    loadBalancerBackendAddressPools
    []SubResource_STATUS_ARM

    LoadBalancerBackendAddressPools: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].

    primary
    bool

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

    privateIPAddressVersion
    VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion_STATUS

    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
    VirtualMachinePublicIPAddressConfiguration_STATUS_ARM

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    SubResource_STATUS_ARM

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineNetworkInterfaceIPConfiguration_ARM

    (Appears on:VirtualMachineNetworkInterfaceConfigurationProperties_ARM)

    Describes a virtual machine network profile’s IP configuration.

    Field Description
    name
    string

    Name: The IP configuration name.

    properties
    VirtualMachineNetworkInterfaceIPConfigurationProperties_ARM

    Properties: Describes a virtual machine network interface IP configuration properties.

    VirtualMachineNetworkInterfaceIPConfiguration_STATUS

    (Appears on:VirtualMachineNetworkInterfaceConfiguration_STATUS)

    Describes a virtual machine network profile’s IP configuration.

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_STATUS

    ApplicationGatewayBackendAddressPools: Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.

    applicationSecurityGroups
    []SubResource_STATUS

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

    loadBalancerBackendAddressPools
    []SubResource_STATUS

    LoadBalancerBackendAddressPools: Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].

    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
    VirtualMachineNetworkInterfaceIPConfigurationProperties_PrivateIPAddressVersion_STATUS

    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
    VirtualMachinePublicIPAddressConfiguration_STATUS

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    SubResource_STATUS

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineNetworkInterfaceIPConfiguration_STATUS_ARM

    (Appears on:VirtualMachineNetworkInterfaceConfigurationProperties_STATUS_ARM)

    Describes a virtual machine network profile’s IP configuration.

    Field Description
    name
    string

    Name: The IP configuration name.

    properties
    VirtualMachineNetworkInterfaceIPConfigurationProperties_STATUS_ARM

    Properties: Describes a virtual machine network interface IP configuration properties.

    VirtualMachinePatchStatus_STATUS

    (Appears on:VirtualMachineInstanceView_STATUS)

    The status of virtual machine patch operations.

    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_STATUS_ARM

    (Appears on:VirtualMachineInstanceView_STATUS_ARM)

    The status of virtual machine patch operations.

    Field Description
    availablePatchSummary
    AvailablePatchSummary_STATUS_ARM

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

    configurationStatuses
    []InstanceViewStatus_STATUS_ARM

    ConfigurationStatuses: The enablement status of the specified patchMode

    lastPatchInstallationSummary
    LastPatchInstallationSummary_STATUS_ARM

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

    VirtualMachineProperties_ARM

    (Appears on:VirtualMachine_Spec_ARM)

    Describes the properties of a Virtual Machine.

    Field Description
    additionalCapabilities
    AdditionalCapabilities_ARM

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

    applicationProfile
    ApplicationProfile_ARM

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    availabilitySet
    SubResource_ARM

    AvailabilitySet: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

    billingProfile
    BillingProfile_ARM

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

    capacityReservation
    CapacityReservationProfile_ARM

    CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile_ARM

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

    evictionPolicy
    EvictionPolicy

    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_ARM

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource_ARM

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

    hostGroup
    SubResource_ARM

    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.

    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_ARM

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    OSProfile_ARM

    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

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

    proximityPlacementGroup
    SubResource_ARM

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

    scheduledEventsProfile
    ScheduledEventsProfile_ARM

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile_ARM

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

    storageProfile
    StorageProfile_ARM

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

    userData
    string

    UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    virtualMachineScaleSet
    SubResource_ARM

    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

    VirtualMachineProperties_STATUS_ARM

    (Appears on:VirtualMachine_STATUS_ARM)

    Describes the properties of a Virtual Machine.

    Field Description
    additionalCapabilities
    AdditionalCapabilities_STATUS_ARM

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

    applicationProfile
    ApplicationProfile_STATUS_ARM

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    availabilitySet
    SubResource_STATUS_ARM

    AvailabilitySet: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

    billingProfile
    BillingProfile_STATUS_ARM

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

    capacityReservation
    CapacityReservationProfile_STATUS_ARM

    CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile_STATUS_ARM

    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_STATUS_ARM

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource_STATUS_ARM

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

    hostGroup
    SubResource_STATUS_ARM

    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_STATUS_ARM

    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_STATUS_ARM

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    OSProfile_STATUS_ARM

    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_STATUS_ARM

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

    scheduledEventsProfile
    ScheduledEventsProfile_STATUS_ARM

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile_STATUS_ARM

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

    storageProfile
    StorageProfile_STATUS_ARM

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

    timeCreated
    string

    TimeCreated: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2022-03-01.

    userData
    string

    UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    virtualMachineScaleSet
    SubResource_STATUS_ARM

    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.

    VirtualMachinePublicIPAddressConfiguration

    (Appears on:VirtualMachineNetworkInterfaceIPConfiguration)

    Describes a virtual machines IP Configuration’s PublicIPAddress configuration

    Field Description
    deleteOption
    VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the public IP address when the VM is deleted

    dnsSettings
    VirtualMachinePublicIPAddressDnsSettingsConfiguration

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineIpTag

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

    name
    string

    Name: The publicIP address configuration name.

    publicIPAddressVersion
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion

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

    publicIPAllocationMethod
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod

    PublicIPAllocationMethod: Specify the public IP allocation type

    publicIPPrefix
    SubResource

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    sku
    PublicIPAddressSku

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

    VirtualMachinePublicIPAddressConfigurationProperties_ARM

    (Appears on:VirtualMachinePublicIPAddressConfiguration_ARM)

    Describes a virtual machines IP Configuration’s PublicIPAddress configuration

    Field Description
    deleteOption
    VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the public IP address when the VM is deleted

    dnsSettings
    VirtualMachinePublicIPAddressDnsSettingsConfiguration_ARM

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineIpTag_ARM

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

    publicIPAddressVersion
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion

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

    publicIPAllocationMethod
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod

    PublicIPAllocationMethod: Specify the public IP allocation type

    publicIPPrefix
    SubResource_ARM

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption (string alias)

    (Appears on:VirtualMachinePublicIPAddressConfiguration, VirtualMachinePublicIPAddressConfigurationProperties_ARM)

    Value Description

    "Delete"

    "Detach"

    VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption_STATUS (string alias)

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM, VirtualMachinePublicIPAddressConfiguration_STATUS)

    Value Description

    "Delete"

    "Detach"

    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion (string alias)

    (Appears on:VirtualMachinePublicIPAddressConfiguration, VirtualMachinePublicIPAddressConfigurationProperties_ARM)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS (string alias)

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM, VirtualMachinePublicIPAddressConfiguration_STATUS)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod (string alias)

    (Appears on:VirtualMachinePublicIPAddressConfiguration, VirtualMachinePublicIPAddressConfigurationProperties_ARM)

    Value Description

    "Dynamic"

    "Static"

    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod_STATUS (string alias)

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM, VirtualMachinePublicIPAddressConfiguration_STATUS)

    Value Description

    "Dynamic"

    "Static"

    VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM

    (Appears on:VirtualMachinePublicIPAddressConfiguration_STATUS_ARM)

    Describes a virtual machines IP Configuration’s PublicIPAddress configuration

    Field Description
    deleteOption
    VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the public IP address when the VM is deleted

    dnsSettings
    VirtualMachinePublicIPAddressDnsSettingsConfiguration_STATUS_ARM

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineIpTag_STATUS_ARM

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

    publicIPAddressVersion
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS

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

    publicIPAllocationMethod
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod_STATUS

    PublicIPAllocationMethod: Specify the public IP allocation type

    publicIPPrefix
    SubResource_STATUS_ARM

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    VirtualMachinePublicIPAddressConfiguration_ARM

    (Appears on:VirtualMachineNetworkInterfaceIPConfigurationProperties_ARM)

    Describes a virtual machines IP Configuration’s PublicIPAddress configuration

    Field Description
    name
    string

    Name: The publicIP address configuration name.

    properties
    VirtualMachinePublicIPAddressConfigurationProperties_ARM

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

    sku
    PublicIPAddressSku_ARM

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

    VirtualMachinePublicIPAddressConfiguration_STATUS

    (Appears on:VirtualMachineNetworkInterfaceIPConfiguration_STATUS)

    Describes a virtual machines IP Configuration’s PublicIPAddress configuration

    Field Description
    deleteOption
    VirtualMachinePublicIPAddressConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the public IP address when the VM is deleted

    dnsSettings
    VirtualMachinePublicIPAddressDnsSettingsConfiguration_STATUS

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineIpTag_STATUS

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

    name
    string

    Name: The publicIP address configuration name.

    publicIPAddressVersion
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS

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

    publicIPAllocationMethod
    VirtualMachinePublicIPAddressConfigurationProperties_PublicIPAllocationMethod_STATUS

    PublicIPAllocationMethod: Specify the public IP allocation type

    publicIPPrefix
    SubResource_STATUS

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    sku
    PublicIPAddressSku_STATUS

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

    VirtualMachinePublicIPAddressConfiguration_STATUS_ARM

    (Appears on:VirtualMachineNetworkInterfaceIPConfigurationProperties_STATUS_ARM)

    Describes a virtual machines IP Configuration’s PublicIPAddress configuration

    Field Description
    name
    string

    Name: The publicIP address configuration name.

    properties
    VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM

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

    sku
    PublicIPAddressSku_STATUS_ARM

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

    VirtualMachinePublicIPAddressDnsSettingsConfiguration

    (Appears on:VirtualMachinePublicIPAddressConfiguration)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    domainNameLabel
    string

    DomainNameLabel: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.

    VirtualMachinePublicIPAddressDnsSettingsConfiguration_ARM

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_ARM)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    domainNameLabel
    string

    DomainNameLabel: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.

    VirtualMachinePublicIPAddressDnsSettingsConfiguration_STATUS

    (Appears on:VirtualMachinePublicIPAddressConfiguration_STATUS)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    domainNameLabel
    string

    DomainNameLabel: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.

    VirtualMachinePublicIPAddressDnsSettingsConfiguration_STATUS_ARM

    (Appears on:VirtualMachinePublicIPAddressConfigurationProperties_STATUS_ARM)

    Describes a virtual machines network configuration’s DNS settings.

    Field Description
    domainNameLabel
    string

    DomainNameLabel: The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.

    VirtualMachineScaleSet

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

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


    additionalCapabilities
    AdditionalCapabilities

    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

    AutomaticRepairsPolicy: Policy for automatic repairs.

    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 extended location of the Virtual Machine Scale Set.

    hostGroup
    SubResource

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

    identity
    VirtualMachineScaleSetIdentity

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

    location
    string

    Location: Resource location

    orchestrationMode
    OrchestrationMode

    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

    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

    ScaleInPolicy: Specifies the policies applied when scaling in Virtual Machines in the 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: The virtual machine scale set sku.

    spotRestorePolicy
    SpotRestorePolicy

    SpotRestorePolicy: Specifies the Spot Restore properties for the virtual machine scale set.

    tags
    map[string]string

    Tags: Resource tags

    upgradePolicy
    UpgradePolicy

    UpgradePolicy: The upgrade policy.

    virtualMachineProfile
    VirtualMachineScaleSetVMProfile

    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. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

    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)

    Describes a virtual machine scale set data disk.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    CreateOption: The create option.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.

    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: 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_ARM

    (Appears on:VirtualMachineScaleSetStorageProfile_ARM)

    Describes a virtual machine scale set data disk.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    CreateOption: The create option.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.

    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_ARM

    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_STATUS

    (Appears on:VirtualMachineScaleSetStorageProfile_STATUS)

    Describes a virtual machine scale set data disk.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetStorageProfile_STATUS_ARM)

    Describes a virtual machine scale set data disk.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.

    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_ARM

    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.

    VirtualMachineScaleSetExtension

    (Appears on:VirtualMachineScaleSetExtensionProfile)

    Describes a Virtual Machine Scale Set Extension.

    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.

    name
    string

    Name: The name of the extension.

    protectedSettings
    genruntime.SecretMapReference

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    provisionAfterExtensions
    []string

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

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

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

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSetExtensionProfile

    (Appears on:VirtualMachineScaleSetVMProfile)

    Describes a virtual machine scale set extension profile.

    Field Description
    extensions
    []VirtualMachineScaleSetExtension

    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_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_ARM)

    Describes a virtual machine scale set extension profile.

    Field Description
    extensions
    []VirtualMachineScaleSetExtension_ARM

    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_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS)

    Describes a virtual machine scale set extension profile.

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS_ARM)

    Describes a virtual machine scale set extension profile.

    Field Description
    extensions
    []VirtualMachineScaleSetExtension_STATUS_ARM

    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_ARM

    (Appears on:VirtualMachineScaleSetExtension_ARM, VirtualMachineScaleSets_Extension_Spec_ARM)

    Describes the properties of a Virtual Machine Scale Set Extension.

    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]string

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_ARM

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    provisionAfterExtensions
    []string

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

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

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

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSetExtensionProperties_STATUS_ARM

    (Appears on:VirtualMachineScaleSetExtension_STATUS_ARM, VirtualMachineScaleSets_Extension_STATUS_ARM)

    Describes the properties of a Virtual Machine Scale Set Extension.

    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.

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_STATUS_ARM

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

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

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSetExtension_ARM

    (Appears on:VirtualMachineScaleSetExtensionProfile_ARM)

    Describes a Virtual Machine Scale Set Extension.

    Field Description
    name
    string

    Name: The name of the extension.

    properties
    VirtualMachineScaleSetExtensionProperties_ARM

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

    VirtualMachineScaleSetExtension_STATUS

    (Appears on:VirtualMachineScaleSetExtensionProfile_STATUS)

    Describes a Virtual Machine Scale Set Extension.

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_STATUS

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

    Type: Resource type

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSetExtension_STATUS_ARM

    (Appears on:VirtualMachineScaleSetExtensionProfile_STATUS_ARM)

    Describes a Virtual Machine Scale Set Extension.

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The name of the extension.

    properties
    VirtualMachineScaleSetExtensionProperties_STATUS_ARM

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

    type
    string

    Type: Resource type

    VirtualMachineScaleSetHardwareProfile

    (Appears on:VirtualMachineScaleSetVMProfile)

    Specifies the hardware settings for the virtual machine scale set.

    Field Description
    vmSizeProperties
    VMSizeProperties

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2022-03-01. Please follow the instructions in VM Customization for more details.

    VirtualMachineScaleSetHardwareProfile_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_ARM)

    Specifies the hardware settings for the virtual machine scale set.

    Field Description
    vmSizeProperties
    VMSizeProperties_ARM

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2022-03-01. Please follow the instructions in VM Customization for more details.

    VirtualMachineScaleSetHardwareProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS)

    Specifies the hardware settings for the virtual machine scale set.

    Field Description
    vmSizeProperties
    VMSizeProperties_STATUS

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2022-03-01. Please follow the instructions in VM Customization for more details.

    VirtualMachineScaleSetHardwareProfile_STATUS_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS_ARM)

    Specifies the hardware settings for the virtual machine scale set.

    Field Description
    vmSizeProperties
    VMSizeProperties_STATUS_ARM

    VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2022-03-01. Please follow the instructions in VM Customization for more details.

    VirtualMachineScaleSetIPConfiguration

    (Appears on:VirtualMachineScaleSetNetworkConfiguration)

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

    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.

    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
    VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion

    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

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    reference
    genruntime.ResourceReference

    Reference: Resource Id

    subnet
    ApiEntityReference

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineScaleSetIPConfigurationProperties_ARM

    (Appears on:VirtualMachineScaleSetIPConfiguration_ARM)

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

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_ARM

    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_ARM

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

    loadBalancerBackendAddressPools
    []SubResource_ARM

    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_ARM

    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
    VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion

    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_ARM

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    ApiEntityReference_ARM

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion (string alias)

    (Appears on:VirtualMachineScaleSetIPConfiguration, VirtualMachineScaleSetIPConfigurationProperties_ARM)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetIPConfiguration_STATUS)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetIPConfigurationProperties_STATUS_ARM

    (Appears on:VirtualMachineScaleSetIPConfiguration_STATUS_ARM)

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

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource_STATUS_ARM

    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_ARM

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

    loadBalancerBackendAddressPools
    []SubResource_STATUS_ARM

    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_ARM

    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
    VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion_STATUS

    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_ARM

    PublicIPAddressConfiguration: The publicIPAddressConfiguration.

    subnet
    ApiEntityReference_STATUS_ARM

    Subnet: Specifies the identifier of the subnet.

    VirtualMachineScaleSetIPConfiguration_ARM

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_ARM)

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

    Field Description
    id
    string
    name
    string

    Name: The IP configuration name.

    properties
    VirtualMachineScaleSetIPConfigurationProperties_ARM

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

    VirtualMachineScaleSetIPConfiguration_STATUS

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_STATUS)

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

    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
    VirtualMachineScaleSetIPConfigurationProperties_PrivateIPAddressVersion_STATUS

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_STATUS_ARM)

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

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The IP configuration name.

    properties
    VirtualMachineScaleSetIPConfigurationProperties_STATUS_ARM

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

    VirtualMachineScaleSetIdentity

    (Appears on:VirtualMachineScaleSet_Spec)

    Identity for the virtual machine scale set.

    Field Description
    type
    VirtualMachineScaleSetIdentity_Type

    Type: The type of identity used for the virtual machine scale set. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine scale set.

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    VirtualMachineScaleSetIdentity_ARM

    (Appears on:VirtualMachineScaleSet_Spec_ARM)

    Identity for the virtual machine scale set.

    Field Description
    type
    VirtualMachineScaleSetIdentity_Type

    Type: The type of identity used for the virtual machine scale set. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine scale set.

    userAssignedIdentities
    map[string]./api/compute/v1api20220301.UserAssignedIdentityDetails_ARM

    VirtualMachineScaleSetIdentity_STATUS

    (Appears on:VirtualMachineScaleSet_STATUS)

    Identity for the virtual machine scale set.

    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
    VirtualMachineScaleSetIdentity_Type_STATUS

    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.

    userAssignedIdentities
    map[string]./api/compute/v1api20220301.VirtualMachineScaleSetIdentity_UserAssignedIdentities_STATUS

    UserAssignedIdentities: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    VirtualMachineScaleSetIdentity_STATUS_ARM

    (Appears on:VirtualMachineScaleSet_STATUS_ARM)

    Identity for the virtual machine scale set.

    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
    VirtualMachineScaleSetIdentity_Type_STATUS

    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.

    userAssignedIdentities
    map[string]./api/compute/v1api20220301.VirtualMachineScaleSetIdentity_UserAssignedIdentities_STATUS_ARM

    UserAssignedIdentities: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    VirtualMachineScaleSetIdentity_Type (string alias)

    (Appears on:VirtualMachineScaleSetIdentity, VirtualMachineScaleSetIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineScaleSetIdentity_Type_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetIdentity_STATUS, VirtualMachineScaleSetIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    VirtualMachineScaleSetIdentity_UserAssignedIdentities_STATUS

    (Appears on:VirtualMachineScaleSetIdentity_STATUS)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    VirtualMachineScaleSetIdentity_UserAssignedIdentities_STATUS_ARM

    (Appears on:VirtualMachineScaleSetIdentity_STATUS_ARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    VirtualMachineScaleSetIpTag

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration)

    Contains the IP tag associated with the public IP address.

    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_ARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM)

    Contains the IP tag associated with the public IP address.

    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)

    Contains the IP tag associated with the public IP address.

    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_ARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM)

    Contains the IP tag associated with the public IP address.

    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)

    Describes the parameters of a ScaleSet managed disk.

    Field Description
    diskEncryptionSet
    SubResource

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

    securityProfile
    VMDiskSecurityProfile

    SecurityProfile: Specifies the security profile for the managed disk.

    storageAccountType
    StorageAccountType

    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_ARM

    (Appears on:VirtualMachineScaleSetDataDisk_ARM, VirtualMachineScaleSetOSDisk_ARM)

    Describes the parameters of a ScaleSet managed disk.

    Field Description
    diskEncryptionSet
    SubResource_ARM

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

    securityProfile
    VMDiskSecurityProfile_ARM

    SecurityProfile: Specifies the security profile for the managed disk.

    storageAccountType
    StorageAccountType

    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_STATUS

    (Appears on:VirtualMachineScaleSetDataDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS)

    Describes the parameters of a ScaleSet managed disk.

    Field Description
    diskEncryptionSet
    SubResource_STATUS

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

    securityProfile
    VMDiskSecurityProfile_STATUS

    SecurityProfile: Specifies the security profile 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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetDataDisk_STATUS_ARM, VirtualMachineScaleSetOSDisk_STATUS_ARM)

    Describes the parameters of a ScaleSet managed disk.

    Field Description
    diskEncryptionSet
    SubResource_STATUS_ARM

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

    securityProfile
    VMDiskSecurityProfile_STATUS_ARM

    SecurityProfile: Specifies the security profile 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.

    VirtualMachineScaleSetNetworkConfiguration

    (Appears on:VirtualMachineScaleSetNetworkProfile)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettings

    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

    IpConfigurations: Specifies the IP configurations of the network interface.

    name
    string

    Name: The network configuration name.

    networkSecurityGroup
    SubResource

    NetworkSecurityGroup: The network security group.

    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

    VirtualMachineScaleSetNetworkConfigurationDnsSettings

    (Appears on:VirtualMachineScaleSetNetworkConfiguration)

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

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationDnsSettings_ARM

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_ARM)

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

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationDnsSettings_STATUS

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_STATUS)

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

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationDnsSettings_STATUS_ARM

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_STATUS_ARM)

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

    Field Description
    dnsServers
    []string

    DnsServers: List of DNS servers IP addresses

    VirtualMachineScaleSetNetworkConfigurationProperties_ARM

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_ARM)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettings_ARM

    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_ARM

    IpConfigurations: Specifies the IP configurations of the network interface.

    networkSecurityGroup
    SubResource_ARM

    NetworkSecurityGroup: The network security group.

    primary
    bool

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

    VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption (string alias)

    (Appears on:VirtualMachineScaleSetNetworkConfiguration, VirtualMachineScaleSetNetworkConfigurationProperties_ARM)

    Value Description

    "Delete"

    "Detach"

    VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetNetworkConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetNetworkConfiguration_STATUS)

    Value Description

    "Delete"

    "Detach"

    VirtualMachineScaleSetNetworkConfigurationProperties_STATUS_ARM

    (Appears on:VirtualMachineScaleSetNetworkConfiguration_STATUS_ARM)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    dnsSettings
    VirtualMachineScaleSetNetworkConfigurationDnsSettings_STATUS_ARM

    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_STATUS_ARM

    IpConfigurations: Specifies the IP configurations of the network interface.

    networkSecurityGroup
    SubResource_STATUS_ARM

    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_ARM

    (Appears on:VirtualMachineScaleSetNetworkProfile_ARM)

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

    Field Description
    id
    string
    name
    string

    Name: The network configuration name.

    properties
    VirtualMachineScaleSetNetworkConfigurationProperties_ARM

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

    VirtualMachineScaleSetNetworkConfiguration_STATUS

    (Appears on:VirtualMachineScaleSetNetworkProfile_STATUS)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetNetworkConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the network interface when the VM is deleted

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetNetworkProfile_STATUS_ARM)

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

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The network configuration name.

    properties
    VirtualMachineScaleSetNetworkConfigurationProperties_STATUS_ARM

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

    VirtualMachineScaleSetNetworkProfile

    (Appears on:VirtualMachineScaleSetVMProfile)

    Describes a virtual machine scale set network profile.

    Field Description
    healthProbe
    ApiEntityReference

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

    networkApiVersion
    VirtualMachineScaleSetNetworkProfile_NetworkApiVersion

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode ‘Flexible’

    networkInterfaceConfigurations
    []VirtualMachineScaleSetNetworkConfiguration

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSetNetworkProfile_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_ARM)

    Describes a virtual machine scale set network profile.

    Field Description
    healthProbe
    ApiEntityReference_ARM

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

    networkApiVersion
    VirtualMachineScaleSetNetworkProfile_NetworkApiVersion

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode ‘Flexible’

    networkInterfaceConfigurations
    []VirtualMachineScaleSetNetworkConfiguration_ARM

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSetNetworkProfile_NetworkApiVersion (string alias)

    (Appears on:VirtualMachineScaleSetNetworkProfile, VirtualMachineScaleSetNetworkProfile_ARM)

    Value Description

    "2020-11-01"

    VirtualMachineScaleSetNetworkProfile_NetworkApiVersion_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetNetworkProfile_STATUS, VirtualMachineScaleSetNetworkProfile_STATUS_ARM)

    Value Description

    "2020-11-01"

    VirtualMachineScaleSetNetworkProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS)

    Describes a virtual machine scale set network profile.

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

    networkApiVersion
    VirtualMachineScaleSetNetworkProfile_NetworkApiVersion_STATUS

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode ‘Flexible’

    networkInterfaceConfigurations
    []VirtualMachineScaleSetNetworkConfiguration_STATUS

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSetNetworkProfile_STATUS_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS_ARM)

    Describes a virtual machine scale set network profile.

    Field Description
    healthProbe
    ApiEntityReference_STATUS_ARM

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

    networkApiVersion
    VirtualMachineScaleSetNetworkProfile_NetworkApiVersion_STATUS

    NetworkApiVersion: specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode ‘Flexible’

    networkInterfaceConfigurations
    []VirtualMachineScaleSetNetworkConfiguration_STATUS_ARM

    NetworkInterfaceConfigurations: The list of network configurations.

    VirtualMachineScaleSetOSDisk

    (Appears on:VirtualMachineScaleSetStorageProfile)

    Describes a virtual machine scale set operating system disk.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    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.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

    diffDiskSettings
    DiffDiskSettings

    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

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

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDisk_OsType

    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_ARM

    (Appears on:VirtualMachineScaleSetStorageProfile_ARM)

    Describes a virtual machine scale set operating system disk.

    Field Description
    caching
    Caching

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

    createOption
    CreateOption

    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.

    deleteOption
    DeleteOption

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

    diffDiskSettings
    DiffDiskSettings_ARM

    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_ARM

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

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters_ARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDisk_OsType

    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_OsType (string alias)

    (Appears on:VirtualMachineScaleSetOSDisk, VirtualMachineScaleSetOSDisk_ARM)

    Value Description

    "Linux"

    "Windows"

    VirtualMachineScaleSetOSDisk_OsType_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetOSDisk_STATUS, VirtualMachineScaleSetOSDisk_STATUS_ARM)

    Value Description

    "Linux"

    "Windows"

    VirtualMachineScaleSetOSDisk_STATUS

    (Appears on:VirtualMachineScaleSetStorageProfile_STATUS)

    Describes a virtual machine scale set operating system disk.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

    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
    VirtualMachineScaleSetOSDisk_OsType_STATUS

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetStorageProfile_STATUS_ARM)

    Describes a virtual machine scale set operating system disk.

    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.

    deleteOption
    DeleteOption_STATUS

    DeleteOption: Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.

    diffDiskSettings
    DiffDiskSettings_STATUS_ARM

    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_ARM

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

    managedDisk
    VirtualMachineScaleSetManagedDiskParameters_STATUS_ARM

    ManagedDisk: The managed disk parameters.

    name
    string

    Name: The disk name.

    osType
    VirtualMachineScaleSetOSDisk_OsType_STATUS

    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

    (Appears on:VirtualMachineScaleSetVMProfile)

    Describes a virtual machine scale set OS profile.

    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

    allowExtensionOperations
    bool

    AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.

    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.

    secrets
    []VaultSecretGroup

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration

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

    VirtualMachineScaleSetOSProfile_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_ARM)

    Describes a virtual machine scale set OS profile.

    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

    allowExtensionOperations
    bool

    AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.

    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_ARM

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

    secrets
    []VaultSecretGroup_ARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration_ARM

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

    VirtualMachineScaleSetOSProfile_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS)

    Describes a virtual machine scale set OS profile.

    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

    allowExtensionOperations
    bool

    AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.

    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.

    secrets
    []VaultSecretGroup_STATUS

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration_STATUS

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

    VirtualMachineScaleSetOSProfile_STATUS_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS_ARM)

    Describes a virtual machine scale set OS profile.

    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

    allowExtensionOperations
    bool

    AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.

    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_ARM

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

    secrets
    []VaultSecretGroup_STATUS_ARM

    Secrets: Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

    windowsConfiguration
    WindowsConfiguration_STATUS_ARM

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

    VirtualMachineScaleSetProperties_ARM

    (Appears on:VirtualMachineScaleSet_Spec_ARM)

    Describes the properties of a Virtual Machine Scale Set.

    Field Description
    additionalCapabilities
    AdditionalCapabilities_ARM

    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_ARM

    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_ARM

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

    orchestrationMode
    OrchestrationMode

    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
    SubResource_ARM

    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_ARM

    ScaleInPolicy: Specifies the policies applied when scaling in Virtual Machines in the 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.

    spotRestorePolicy
    SpotRestorePolicy_ARM

    SpotRestorePolicy: Specifies the Spot Restore properties for the virtual machine scale set.

    upgradePolicy
    UpgradePolicy_ARM

    UpgradePolicy: The upgrade policy.

    virtualMachineProfile
    VirtualMachineScaleSetVMProfile_ARM

    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. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

    VirtualMachineScaleSetProperties_STATUS_ARM

    (Appears on:VirtualMachineScaleSet_STATUS_ARM)

    Describes the properties of a Virtual Machine Scale Set.

    Field Description
    additionalCapabilities
    AdditionalCapabilities_STATUS_ARM

    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_ARM

    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_STATUS_ARM

    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_STATUS_ARM

    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_ARM

    ScaleInPolicy: Specifies the policies applied when scaling in Virtual Machines in the 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.

    spotRestorePolicy
    SpotRestorePolicy_STATUS_ARM

    SpotRestorePolicy: Specifies the Spot Restore properties for the virtual machine scale set.

    timeCreated
    string

    TimeCreated: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2022-03-01.

    uniqueId
    string

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

    upgradePolicy
    UpgradePolicy_STATUS_ARM

    UpgradePolicy: The upgrade policy.

    virtualMachineProfile
    VirtualMachineScaleSetVMProfile_STATUS_ARM

    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. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

    VirtualMachineScaleSetPublicIPAddressConfiguration

    (Appears on:VirtualMachineScaleSetIPConfiguration)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the public IP when the VM is deleted

    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

    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
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion

    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

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    sku
    PublicIPAddressSku

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

    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration)

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

    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_ARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM)

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

    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)

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

    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_ARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM)

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

    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

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration_ARM)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption

    DeleteOption: Specify what happens to the public IP when the VM is deleted

    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_ARM

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the public IP address.

    ipTags
    []VirtualMachineScaleSetIpTag_ARM

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

    publicIPAddressVersion
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion

    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_ARM

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption (string alias)

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration, VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM)

    Value Description

    "Delete"

    "Detach"

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS)

    Value Description

    "Delete"

    "Detach"

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion (string alias)

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration, VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS (string alias)

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM, VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS)

    Value Description

    "IPv4"

    "IPv6"

    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM

    (Appears on:VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS_ARM)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the public IP when the VM is deleted

    dnsSettings
    VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings_STATUS_ARM

    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_ARM

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

    publicIPAddressVersion
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS

    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_ARM

    PublicIPPrefix: The PublicIPPrefix from which to allocate publicIP addresses.

    VirtualMachineScaleSetPublicIPAddressConfiguration_ARM

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_ARM)

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

    Field Description
    name
    string

    Name: The publicIP address configuration name.

    properties
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_ARM

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

    sku
    PublicIPAddressSku_ARM

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

    VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS

    (Appears on:VirtualMachineScaleSetIPConfiguration_STATUS)

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

    Field Description
    deleteOption
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_DeleteOption_STATUS

    DeleteOption: Specify what happens to the public IP when the VM is deleted

    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
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_PublicIPAddressVersion_STATUS

    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.

    sku
    PublicIPAddressSku_STATUS

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

    VirtualMachineScaleSetPublicIPAddressConfiguration_STATUS_ARM

    (Appears on:VirtualMachineScaleSetIPConfigurationProperties_STATUS_ARM)

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

    Field Description
    name
    string

    Name: The publicIP address configuration name.

    properties
    VirtualMachineScaleSetPublicIPAddressConfigurationProperties_STATUS_ARM

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

    sku
    PublicIPAddressSku_STATUS_ARM

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

    VirtualMachineScaleSetStorageProfile

    (Appears on:VirtualMachineScaleSetVMProfile)

    Describes a virtual machine scale set storage profile.

    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.

    osDisk
    VirtualMachineScaleSetOSDisk

    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_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_ARM)

    Describes a virtual machine scale set storage profile.

    Field Description
    dataDisks
    []VirtualMachineScaleSetDataDisk_ARM

    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_ARM

    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_ARM

    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_STATUS

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS)

    Describes a virtual machine scale set storage profile.

    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_STATUS_ARM

    (Appears on:VirtualMachineScaleSetVMProfile_STATUS_ARM)

    Describes a virtual machine scale set storage profile.

    Field Description
    dataDisks
    []VirtualMachineScaleSetDataDisk_STATUS_ARM

    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_ARM

    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_ARM

    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

    (Appears on:VirtualMachineScaleSet_Spec)

    Describes a virtual machine scale set virtual machine profile.

    Field Description
    applicationProfile
    ApplicationProfile

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    billingProfile
    BillingProfile

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

    capacityReservation
    CapacityReservationProfile

    CapacityReservation: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile

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

    evictionPolicy
    EvictionPolicy

    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

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

    hardwareProfile
    VirtualMachineScaleSetHardwareProfile

    HardwareProfile: Specifies the hardware profile related details of a scale set. Minimum api-version: 2022-03-01.

    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

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

    osProfile
    VirtualMachineScaleSetOSProfile

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

    priority
    Priority

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

    scheduledEventsProfile
    ScheduledEventsProfile

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile

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

    storageProfile
    VirtualMachineScaleSetStorageProfile

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

    userData
    string

    UserData: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    VirtualMachineScaleSetVMProfile_ARM

    (Appears on:VirtualMachineScaleSetProperties_ARM)

    Describes a virtual machine scale set virtual machine profile.

    Field Description
    applicationProfile
    ApplicationProfile_ARM

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    billingProfile
    BillingProfile_ARM

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

    capacityReservation
    CapacityReservationProfile_ARM

    CapacityReservation: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile_ARM

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

    evictionPolicy
    EvictionPolicy

    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_ARM

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

    hardwareProfile
    VirtualMachineScaleSetHardwareProfile_ARM

    HardwareProfile: Specifies the hardware profile related details of a scale set. Minimum api-version: 2022-03-01.

    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_ARM

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

    osProfile
    VirtualMachineScaleSetOSProfile_ARM

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

    priority
    Priority

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

    scheduledEventsProfile
    ScheduledEventsProfile_ARM

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile_ARM

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

    storageProfile
    VirtualMachineScaleSetStorageProfile_ARM

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

    userData
    string

    UserData: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    VirtualMachineScaleSetVMProfile_STATUS

    (Appears on:VirtualMachineScaleSet_STATUS)

    Describes a virtual machine scale set virtual machine profile.

    Field Description
    applicationProfile
    ApplicationProfile_STATUS

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    billingProfile
    BillingProfile_STATUS

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

    capacityReservation
    CapacityReservationProfile_STATUS

    CapacityReservation: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-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.

    hardwareProfile
    VirtualMachineScaleSetHardwareProfile_STATUS

    HardwareProfile: Specifies the hardware profile related details of a scale set. Minimum api-version: 2022-03-01.

    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.

    userData
    string

    UserData: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    VirtualMachineScaleSetVMProfile_STATUS_ARM

    (Appears on:VirtualMachineScaleSetProperties_STATUS_ARM)

    Describes a virtual machine scale set virtual machine profile.

    Field Description
    applicationProfile
    ApplicationProfile_STATUS_ARM

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    billingProfile
    BillingProfile_STATUS_ARM

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

    capacityReservation
    CapacityReservationProfile_STATUS_ARM

    CapacityReservation: Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile_STATUS_ARM

    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_ARM

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

    hardwareProfile
    VirtualMachineScaleSetHardwareProfile_STATUS_ARM

    HardwareProfile: Specifies the hardware profile related details of a scale set. Minimum api-version: 2022-03-01.

    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_ARM

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

    osProfile
    VirtualMachineScaleSetOSProfile_STATUS_ARM

    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_ARM

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile_STATUS_ARM

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

    storageProfile
    VirtualMachineScaleSetStorageProfile_STATUS_ARM

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

    userData
    string

    UserData: UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    VirtualMachineScaleSet_STATUS

    (Appears on:VirtualMachineScaleSet)

    Describes a Virtual Machine Scale Set.

    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 policies applied when scaling in Virtual Machines in the 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_STATUS

    Sku: The virtual machine scale set sku.

    spotRestorePolicy
    SpotRestorePolicy_STATUS

    SpotRestorePolicy: Specifies the Spot Restore properties for the virtual machine scale set.

    tags
    map[string]string

    Tags: Resource tags

    timeCreated
    string

    TimeCreated: Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2022-03-01.

    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. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

    zones
    []string

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

    VirtualMachineScaleSet_STATUS_ARM

    Describes a Virtual Machine Scale Set.

    Field Description
    extendedLocation
    ExtendedLocation_STATUS_ARM

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

    id
    string

    Id: Resource Id

    identity
    VirtualMachineScaleSetIdentity_STATUS_ARM

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

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    plan
    Plan_STATUS_ARM

    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_STATUS_ARM

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

    sku
    Sku_STATUS_ARM

    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

    VirtualMachineScaleSet_Spec

    (Appears on:VirtualMachineScaleSet)

    Field Description
    additionalCapabilities
    AdditionalCapabilities

    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

    AutomaticRepairsPolicy: Policy for automatic repairs.

    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 extended location of the Virtual Machine Scale Set.

    hostGroup
    SubResource

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

    identity
    VirtualMachineScaleSetIdentity

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

    location
    string

    Location: Resource location

    orchestrationMode
    OrchestrationMode

    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

    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

    ScaleInPolicy: Specifies the policies applied when scaling in Virtual Machines in the 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: The virtual machine scale set sku.

    spotRestorePolicy
    SpotRestorePolicy

    SpotRestorePolicy: Specifies the Spot Restore properties for the virtual machine scale set.

    tags
    map[string]string

    Tags: Resource tags

    upgradePolicy
    UpgradePolicy

    UpgradePolicy: The upgrade policy.

    virtualMachineProfile
    VirtualMachineScaleSetVMProfile

    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. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

    zones
    []string

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

    VirtualMachineScaleSet_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

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

    identity
    VirtualMachineScaleSetIdentity_ARM

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

    location
    string

    Location: Resource location

    name
    string
    plan
    Plan_ARM

    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_ARM

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

    sku
    Sku_ARM

    Sku: The virtual machine scale set sku.

    tags
    map[string]string

    Tags: Resource tags

    zones
    []string

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

    VirtualMachineScaleSetsExtension

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

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


    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.

    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.

    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.

    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 compute.azure.com/VirtualMachineScaleSet resource

    protectedSettings
    genruntime.SecretMapReference

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    provisionAfterExtensions
    []string

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

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

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

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    status
    VirtualMachineScaleSets_Extension_STATUS

    VirtualMachineScaleSets_Extension_STATUS

    (Appears on:VirtualMachineScaleSetsExtension)

    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.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference_STATUS

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

    Type: Resource type

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSets_Extension_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id

    name
    string

    Name: The name of the extension.

    properties
    VirtualMachineScaleSetExtensionProperties_STATUS_ARM

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

    type
    string

    Type: Resource type

    VirtualMachineScaleSets_Extension_Spec

    (Appears on:VirtualMachineScaleSetsExtension)

    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.

    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.

    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.

    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 compute.azure.com/VirtualMachineScaleSet resource

    protectedSettings
    genruntime.SecretMapReference

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

    protectedSettingsFromKeyVault
    KeyVaultSecretReference

    ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

    provisionAfterExtensions
    []string

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

    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.

    suppressFailures
    bool

    SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

    type
    string

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

    typeHandlerVersion
    string

    TypeHandlerVersion: Specifies the version of the script handler.

    VirtualMachineScaleSets_Extension_Spec_ARM

    Field Description
    name
    string

    Name: The name of the extension.

    properties
    VirtualMachineScaleSetExtensionProperties_ARM

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

    VirtualMachine_STATUS

    (Appears on:VirtualMachine)

    Describes a Virtual Machine.

    Field Description
    additionalCapabilities
    AdditionalCapabilities_STATUS

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

    applicationProfile
    ApplicationProfile_STATUS

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    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 Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

    billingProfile
    BillingProfile_STATUS

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

    capacityReservation
    CapacityReservationProfile_STATUS

    CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-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.

    scheduledEventsProfile
    ScheduledEventsProfile_STATUS

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    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

    timeCreated
    string

    TimeCreated: Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2022-03-01.

    type
    string

    Type: Resource type

    userData
    string

    UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    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_STATUS_ARM

    Describes a Virtual Machine.

    Field Description
    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the Virtual Machine.

    id
    string

    Id: Resource Id

    identity
    VirtualMachineIdentity_STATUS_ARM

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

    location
    string

    Location: Resource location

    name
    string

    Name: Resource name

    plan
    Plan_STATUS_ARM

    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_STATUS_ARM

    Properties: Describes the properties of a Virtual Machine.

    resources
    []VirtualMachineExtension_STATUS_ARM

    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.

    VirtualMachine_Spec

    (Appears on:VirtualMachine)

    Field Description
    additionalCapabilities
    AdditionalCapabilities

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

    applicationProfile
    ApplicationProfile

    ApplicationProfile: Specifies the gallery applications that should be made available to the VM/VMSS

    availabilitySet
    SubResource

    AvailabilitySet: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

    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 virtual machine. Minimum api-version: 2019-03-01.

    capacityReservation
    CapacityReservationProfile

    CapacityReservation: Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

    diagnosticsProfile
    DiagnosticsProfile

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

    evictionPolicy
    EvictionPolicy

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

    HardwareProfile: Specifies the hardware settings for the virtual machine.

    host
    SubResource

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

    hostGroup
    SubResource

    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.

    identity
    VirtualMachineIdentity

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

    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

    networkProfile
    NetworkProfile

    NetworkProfile: Specifies the network interfaces of the virtual machine.

    osProfile
    OSProfile

    OsProfile: Specifies the operating system settings used while creating 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
    Priority

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

    proximityPlacementGroup
    SubResource

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

    scheduledEventsProfile
    ScheduledEventsProfile

    ScheduledEventsProfile: Specifies Scheduled Event related configurations.

    securityProfile
    SecurityProfile

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

    storageProfile
    StorageProfile

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

    tags
    map[string]string

    Tags: Resource tags

    userData
    string

    UserData: UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01

    virtualMachineScaleSet
    SubResource

    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

    zones
    []string

    Zones: The virtual machine zones.

    VirtualMachine_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the Virtual Machine.

    identity
    VirtualMachineIdentity_ARM

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

    location
    string

    Location: Resource location

    name
    string
    plan
    Plan_ARM

    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_ARM

    Properties: Describes the properties of a Virtual Machine.

    tags
    map[string]string

    Tags: Resource tags

    zones
    []string

    Zones: The virtual machine zones.

    VirtualMachinesExtension

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

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


    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.

    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.

    enableAu