azure.mgmt.compute.v2024_07_01.models module¶

class azure.mgmt.compute.v2024_07_01.models.AdditionalCapabilities(*, ultra_ssd_enabled: bool | None = None, hibernation_enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

ultra_ssd_enabled (bool) – 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.
hibernation_enabled (bool) – The flag that enables or disables hibernation capability on the VM.

Keyword Arguments:

ultra_ssd_enabled (bool) – 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.
hibernation_enabled (bool) – The flag that enables or disables hibernation capability on the VM.

class azure.mgmt.compute.v2024_07_01.models.AdditionalUnattendContent(*, pass_name: Literal['OobeSystem'] | None = None, component_name: Literal['Microsoft-Windows-Shell-Setup'] | None = None, setting_name: str | _models.SettingNames | None = None, content: str | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

Variables:

pass_name (str) – The pass name. Currently, the only allowable value is OobeSystem. Default value is “OobeSystem”.
component_name (str) – The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Default value is “Microsoft-Windows-Shell-Setup”.
setting_name (str or SettingNames) – Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Known values are: “AutoLogon” and “FirstLogonCommands”.
content (str) – 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.

Keyword Arguments:

pass_name (str) – The pass name. Currently, the only allowable value is OobeSystem. Default value is “OobeSystem”.
component_name (str) – The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Default value is “Microsoft-Windows-Shell-Setup”.
setting_name (str or SettingNames) – Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Known values are: “AutoLogon” and “FirstLogonCommands”.
content (str) – 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.

class azure.mgmt.compute.v2024_07_01.models.AllocationStrategy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.

CAPACITY_OPTIMIZED = 'CapacityOptimized'¶

LOWEST_PRICE = 'LowestPrice'¶

class azure.mgmt.compute.v2024_07_01.models.AlternativeOption(*, type: str | _models.AlternativeType | None = None, value: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the alternative option specified by the Publisher for this image when this image is deprecated.

Variables:

type (str or AlternativeType) – Describes the type of the alternative option. Known values are: “None”, “Offer”, and “Plan”.
value (str) – Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan.

Keyword Arguments:

type (str or AlternativeType) – Describes the type of the alternative option. Known values are: “None”, “Offer”, and “Plan”.
value (str) – Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan.

class azure.mgmt.compute.v2024_07_01.models.AlternativeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Describes the type of the alternative option.

NONE = 'None'¶

OFFER = 'Offer'¶

PLAN = 'Plan'¶

class azure.mgmt.compute.v2024_07_01.models.ApiEntityReference(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The API entity reference.

Variables:: id (str) – The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…
Keyword Arguments:: id (str) – The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…

class azure.mgmt.compute.v2024_07_01.models.ApiError(*, details: List[_models.ApiErrorBase] | None = None, innererror: _models.InnerError | None = None, code: str | None = None, target: str | None = None, message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Api error.

Variables:

details (list[ApiErrorBase]) – The Api error details.
innererror (InnerError) – The Api inner error.
code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

Keyword Arguments:

details (list[ApiErrorBase]) – The Api error details.
innererror (InnerError) – The Api inner error.
code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

class azure.mgmt.compute.v2024_07_01.models.ApiErrorBase(*, code: str | None = None, target: str | None = None, message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Api error base.

Variables:

code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

Keyword Arguments:

code (str) – The error code.
target (str) – The target of the particular error.
message (str) – The error message.

class azure.mgmt.compute.v2024_07_01.models.ApplicationProfile(*, gallery_applications: List[_models.VMGalleryApplication] | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:: gallery_applications (list[VMGalleryApplication]) – Specifies the gallery applications that should be made available to the VM/VMSS.
Keyword Arguments:: gallery_applications (list[VMGalleryApplication]) – Specifies the gallery applications that should be made available to the VM/VMSS.

class azure.mgmt.compute.v2024_07_01.models.ArchitectureTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the Architecture Type.

ARM64 = 'Arm64'¶

X64 = 'x64'¶

class azure.mgmt.compute.v2024_07_01.models.AttachDetachDataDisksRequest(*, data_disks_to_attach: List[_models.DataDisksToAttach] | None = None, data_disks_to_detach: List[_models.DataDisksToDetach] | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the input for attaching and detaching a list of managed data disks.

Variables:

data_disks_to_attach (list[DataDisksToAttach]) – The list of managed data disks to be attached.
data_disks_to_detach (list[DataDisksToDetach]) – The list of managed data disks to be detached.

Keyword Arguments:

data_disks_to_attach (list[DataDisksToAttach]) – The list of managed data disks to be attached.
data_disks_to_detach (list[DataDisksToDetach]) – The list of managed data disks to be detached.

class azure.mgmt.compute.v2024_07_01.models.AutomaticOSUpgradePolicy(*, enable_automatic_os_upgrade: bool | None = None, disable_automatic_rollback: bool | None = None, use_rolling_upgrade_policy: bool | None = None, os_rolling_upgrade_deferral: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

The configuration parameters used for performing automatic OS upgrade.

Variables:

enable_automatic_os_upgrade (bool) – 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 # pylint: disable=line-too-long is automatically set to false and cannot be set to true.
disable_automatic_rollback (bool) – Whether OS image rollback feature should be disabled. Default value is false.
use_rolling_upgrade_policy (bool) – 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.
os_rolling_upgrade_deferral (bool) – Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag ‘Platform.PendingOSUpgrade’. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call.

Keyword Arguments:

enable_automatic_os_upgrade (bool) –
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 # pylint: disable=line-too-long is automatically set to false and cannot be set to true.
disable_automatic_rollback (bool) – Whether OS image rollback feature should be disabled. Default value is false.
use_rolling_upgrade_policy (bool) – 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.
os_rolling_upgrade_deferral (bool) – Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag ‘Platform.PendingOSUpgrade’. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call.

class azure.mgmt.compute.v2024_07_01.models.AutomaticOSUpgradeProperties(*, automatic_os_upgrade_supported: bool, **kwargs: Any)[source]¶

Bases: Model

Describes automatic OS upgrade properties on the image.

All required parameters must be populated in order to send to server.

Variables:: automatic_os_upgrade_supported (bool) – Specifies whether automatic OS upgrade is supported on the image. Required.
Keyword Arguments:: automatic_os_upgrade_supported (bool) – Specifies whether automatic OS upgrade is supported on the image. Required.

class azure.mgmt.compute.v2024_07_01.models.AutomaticRepairsPolicy(*, enabled: bool | None = None, grace_period: str | None = None, repair_action: str | _models.RepairAction | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

enabled (bool) – Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
grace_period (str) – 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).
repair_action (str or 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. Known values are: “Replace”, “Restart”, and “Reimage”.

Keyword Arguments:

enabled (bool) – Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
grace_period (str) – 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).
repair_action (str or 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. Known values are: “Replace”, “Restart”, and “Reimage”.

class azure.mgmt.compute.v2024_07_01.models.AvailabilitySet(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, platform_update_domain_count: int | None = None, platform_fault_domain_count: int | None = None, virtual_machines: List[_models.SubResource] | None = None, proximity_placement_group: _models.SubResource | None = None, scheduled_events_policy: _models.ScheduledEventsPolicy | None = None, **kwargs: Any)[source]¶

Bases: Resource

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 an availability set at creation time. An existing VM cannot be added to an availability set.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use ‘Aligned’ for virtual machines with managed disks and ‘Classic’ for virtual machines with unmanaged disks. Default value is ‘Classic’.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
statuses (list[InstanceViewStatus]) – The resource status information.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use ‘Aligned’ for virtual machines with managed disks and ‘Classic’ for virtual machines with unmanaged disks. Default value is ‘Classic’.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.

class azure.mgmt.compute.v2024_07_01.models.AvailabilitySetListResult(*, value: List[_models.AvailabilitySet], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Availability Set operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[AvailabilitySet]) – The list of availability sets. Required.
next_link (str) – The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.

Keyword Arguments:

value (list[AvailabilitySet]) – The list of availability sets. Required.
next_link (str) – The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.

class azure.mgmt.compute.v2024_07_01.models.AvailabilitySetSkuTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the sku of an Availability Set. Use ‘Aligned’ for virtual machines with managed disks and ‘Classic’ for virtual machines with unmanaged disks. Default value is ‘Classic’.

ALIGNED = 'Aligned'¶

CLASSIC = 'Classic'¶

class azure.mgmt.compute.v2024_07_01.models.AvailabilitySetUpdate(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, platform_update_domain_count: int | None = None, platform_fault_domain_count: int | None = None, virtual_machines: List[_models.SubResource] | None = None, proximity_placement_group: _models.SubResource | None = None, scheduled_events_policy: _models.ScheduledEventsPolicy | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
sku (Sku) – Sku of the availability set.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
statuses (list[InstanceViewStatus]) – The resource status information.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (Sku) – Sku of the availability set.
platform_update_domain_count (int) – Update Domain count.
platform_fault_domain_count (int) – Fault Domain count.
virtual_machines (list[SubResource]) – A list of references to all virtual machines in the availability set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the availability set.

class azure.mgmt.compute.v2024_07_01.models.AvailablePatchSummary(**kwargs: Any)[source]¶

Bases: Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

status (str or PatchOperationStatus) – 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.”. Known values are: “Unknown”, “InProgress”, “Failed”, “Succeeded”, and “CompletedWithWarnings”.
assessment_activity_id (str) – The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
reboot_pending (bool) – 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.
critical_and_security_patch_count (int) – The number of critical or security patches that have been detected as available and not yet installed.
other_patch_count (int) – The number of all available patches excluding critical and security.
start_time (datetime) – The UTC timestamp when the operation began.
last_modified_time (datetime) – The UTC timestamp when the operation began.
error (ApiError) – The errors that were encountered during execution of the operation. The details array contains the list of them.

class azure.mgmt.compute.v2024_07_01.models.BillingProfile(*, max_price: float | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:: max_price (float) – 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.  :code:` `Minimum api-version: 2019-03-01.
Keyword Arguments:: max_price (float) – 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.  :code:` `Minimum api-version: 2019-03-01.

class azure.mgmt.compute.v2024_07_01.models.BootDiagnostics(*, enabled: bool | None = None, storage_uri: str | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

Variables:

enabled (bool) – Whether boot diagnostics should be enabled on the Virtual Machine.
storage_uri (str) – 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.

Keyword Arguments:

enabled (bool) – Whether boot diagnostics should be enabled on the Virtual Machine.
storage_uri (str) – 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.

class azure.mgmt.compute.v2024_07_01.models.BootDiagnosticsInstanceView(**kwargs: Any)[source]¶

Bases: Model

The instance view of a virtual machine boot diagnostics.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

console_screenshot_blob_uri (str) – The console screenshot blob URI. Note: This will not be set if boot diagnostics is currently enabled with managed storage.
serial_console_log_blob_uri (str) – The serial console log blob Uri. Note: This will not be set if boot diagnostics is currently enabled with managed storage.
status (InstanceViewStatus) – The boot diagnostics status information for the VM. Note: It will be set only if there are errors encountered in enabling boot diagnostics.

class azure.mgmt.compute.v2024_07_01.models.CachingTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

NONE = 'None'¶

READ_ONLY = 'ReadOnly'¶

READ_WRITE = 'ReadWrite'¶

class azure.mgmt.compute.v2024_07_01.models.CapacityReservation(*, location: str, sku: _models.Sku, tags: Dict[str, str] | None = None, zones: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the capacity reservation.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called ‘CapacityReservationSupported’ set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. Required.
zones (list[str]) – Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.
reservation_id (str) – A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
platform_fault_domain_count (int) – Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. Note: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01.
virtual_machines_associated (list[SubResourceReadOnly]) – A list of all virtual machine resource ids that are associated with the capacity reservation.
provisioning_time (datetime) – The date time when the capacity reservation was last updated.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (CapacityReservationInstanceView) – The Capacity reservation instance view.
time_created (datetime) – Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called ‘CapacityReservationSupported’ set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. Required.
zones (list[str]) – Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationGroup(*, location: str, tags: Dict[str, str] | None = None, zones: List[str] | None = None, sharing_profile: _models.ResourceSharingProfile | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
zones (list[str]) – Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
capacity_reservations (list[SubResourceReadOnly]) – A list of all capacity reservation resource ids that belong to capacity reservation group.
virtual_machines_associated (list[SubResourceReadOnly]) – A list of references to all virtual machines associated to the capacity reservation group.
instance_view (CapacityReservationGroupInstanceView) – The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
sharing_profile (ResourceSharingProfile) – Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
zones (list[str]) – Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.
sharing_profile (ResourceSharingProfile) – Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationGroupInstanceView(**kwargs: Any)[source]¶

Bases: Model

CapacityReservationGroupInstanceView.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

capacity_reservations (list[CapacityReservationInstanceViewWithName]) – List of instance view of the capacity reservations under the capacity reservation group.
shared_subscription_ids (list[SubResourceReadOnly]) – List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationGroupInstanceViewTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

CapacityReservationGroupInstanceViewTypes.

INSTANCE_VIEW = 'instanceView'¶

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationGroupListResult(*, value: List[_models.CapacityReservationGroup], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List capacity reservation group with resource group response.

All required parameters must be populated in order to send to server.

Variables:

value (list[CapacityReservationGroup]) – The list of capacity reservation groups. Required.
next_link (str) – The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups.

Keyword Arguments:

value (list[CapacityReservationGroup]) – The list of capacity reservation groups. Required.
next_link (str) – The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationGroupUpdate(*, tags: Dict[str, str] | None = None, sharing_profile: _models.ResourceSharingProfile | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the capacity reservation group. Only tags can be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
capacity_reservations (list[SubResourceReadOnly]) – A list of all capacity reservation resource ids that belong to capacity reservation group.
virtual_machines_associated (list[SubResourceReadOnly]) – A list of references to all virtual machines associated to the capacity reservation group.
instance_view (CapacityReservationGroupInstanceView) – The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.
sharing_profile (ResourceSharingProfile) – Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sharing_profile (ResourceSharingProfile) – Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationInstanceView(*, utilization_info: _models.CapacityReservationUtilization | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.

Variables:

utilization_info (CapacityReservationUtilization) – Unutilized capacity of the capacity reservation.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

utilization_info (CapacityReservationUtilization) – Unutilized capacity of the capacity reservation.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationInstanceViewTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

CapacityReservationInstanceViewTypes.

INSTANCE_VIEW = 'instanceView'¶

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationInstanceViewWithName(*, utilization_info: _models.CapacityReservationUtilization | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: CapacityReservationInstanceView

The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

utilization_info (CapacityReservationUtilization) – Unutilized capacity of the capacity reservation.
statuses (list[InstanceViewStatus]) – The resource status information.
name (str) – The name of the capacity reservation.

Keyword Arguments:

utilization_info (CapacityReservationUtilization) – Unutilized capacity of the capacity reservation.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationListResult(*, value: List[_models.CapacityReservation], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The list capacity reservation operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[CapacityReservation]) – The list of capacity reservations. Required.
next_link (str) – The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations.

Keyword Arguments:

value (list[CapacityReservation]) – The list of capacity reservations. Required.
next_link (str) – The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationProfile(*, capacity_reservation_group: _models.SubResource | None = None, **kwargs: Any)[source]¶

Bases: Model

The parameters of a capacity reservation Profile.

Variables:: capacity_reservation_group (SubResource) – 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.
Keyword Arguments:: capacity_reservation_group (SubResource) – 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.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationUpdate(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the capacity reservation. Only tags and sku.capacity can be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called ‘CapacityReservationSupported’ set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
reservation_id (str) – A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
platform_fault_domain_count (int) – Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. Note: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01.
virtual_machines_associated (list[SubResourceReadOnly]) – A list of all virtual machine resource ids that are associated with the capacity reservation.
provisioning_time (datetime) – The date time when the capacity reservation was last updated.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (CapacityReservationInstanceView) – The Capacity reservation instance view.
time_created (datetime) – Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called ‘CapacityReservationSupported’ set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.

class azure.mgmt.compute.v2024_07_01.models.CapacityReservationUtilization(**kwargs: Any)[source]¶

Bases: Model

Represents the capacity reservation utilization in terms of resources allocated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

current_capacity (int) – The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
virtual_machines_allocated (list[SubResourceReadOnly]) – A list of all virtual machines resource ids allocated against the capacity reservation.

class azure.mgmt.compute.v2024_07_01.models.ComputeOperationListResult(**kwargs: Any)[source]¶

Bases: Model

The List Compute Operation operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: value (list[ComputeOperationValue]) – The list of compute operations.

class azure.mgmt.compute.v2024_07_01.models.ComputeOperationValue(**kwargs: Any)[source]¶

Bases: Model

Describes the properties of a Compute Operation value.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

origin (str) – The origin of the compute operation.
name (str) – The name of the compute operation.
operation (str) – The display name of the compute operation.
resource (str) – The display name of the resource the operation applies to.
description (str) – The description of the operation.
provider (str) – The resource provider for the operation.

class azure.mgmt.compute.v2024_07_01.models.ConsistencyModeTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.

APPLICATION_CONSISTENT = 'ApplicationConsistent'¶

CRASH_CONSISTENT = 'CrashConsistent'¶

FILE_SYSTEM_CONSISTENT = 'FileSystemConsistent'¶

class azure.mgmt.compute.v2024_07_01.models.DataDisk(*, lun: int, create_option: str | _models.DiskCreateOptionTypes, name: str | None = None, vhd: _models.VirtualHardDisk | None = None, image: _models.VirtualHardDisk | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, disk_size_gb: int | None = None, managed_disk: _models.ManagedDiskParameters | None = None, source_resource: _models.ApiEntityReference | None = None, to_be_detached: bool | None = None, detach_option: str | _models.DiskDetachOptionTypes | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a data disk.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

lun (int) – 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. Required.
name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
disk_size_gb (int) – 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. The property ‘diskSizeGB’ is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk (ManagedDiskParameters) – The managed disk parameters.
source_resource (ApiEntityReference) – The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.
to_be_detached (bool) – Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.
disk_iops_read_write (int) – 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.
disk_m_bps_read_write (int) – 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.
detach_option (str or DiskDetachOptionTypes) – 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. To force-detach a data disk update toBeDetached to ‘true’ along with setting detachOption: ‘ForceDetach’. “ForceDetach”
delete_option (str or DiskDeleteOptionTypes) – Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: 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. Known values are: “Delete” and “Detach”.

Keyword Arguments:

lun (int) – 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. Required.
name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
disk_size_gb (int) – 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. The property ‘diskSizeGB’ is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk (ManagedDiskParameters) – The managed disk parameters.
source_resource (ApiEntityReference) – The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.
to_be_detached (bool) – Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.
detach_option (str or DiskDetachOptionTypes) – 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. To force-detach a data disk update toBeDetached to ‘true’ along with setting detachOption: ‘ForceDetach’. “ForceDetach”
delete_option (str or DiskDeleteOptionTypes) – Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: 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. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.DataDiskImage(**kwargs: Any)[source]¶

Bases: Model

Contains the data disk images information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: lun (int) – 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.

class azure.mgmt.compute.v2024_07_01.models.DataDisksToAttach(*, disk_id: str, lun: int | None = None, caching: str | _models.CachingTypes | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, write_accelerator_enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the data disk to be attached.

All required parameters must be populated in order to send to server.

Variables:

disk_id (str) – ID of the managed data disk. Required.
lun (int) – 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. If not specified, lun would be auto assigned.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
delete_option (str or DiskDeleteOptionTypes) – Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: 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. Known values are: “Delete” and “Detach”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed disk.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.

Keyword Arguments:

disk_id (str) – ID of the managed data disk. Required.
lun (int) – 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. If not specified, lun would be auto assigned.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
delete_option (str or DiskDeleteOptionTypes) – Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: 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. Known values are: “Delete” and “Detach”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed disk.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.

class azure.mgmt.compute.v2024_07_01.models.DataDisksToDetach(*, disk_id: str, detach_option: str | _models.DiskDetachOptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the data disk to be detached.

All required parameters must be populated in order to send to server.

Variables:

disk_id (str) – ID of the managed data disk. Required.
detach_option (str or DiskDetachOptionTypes) – Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details. “ForceDetach”

Keyword Arguments:

disk_id (str) – ID of the managed data disk. Required.
detach_option (str or DiskDetachOptionTypes) – Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details. “ForceDetach”

class azure.mgmt.compute.v2024_07_01.models.DedicatedHost(*, location: str, sku: _models.Sku, tags: Dict[str, str] | None = None, platform_fault_domain: int | None = None, auto_replace_on_failure: bool | None = None, license_type: str | _models.DedicatedHostLicenseTypes | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the Dedicated host.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. Required.
platform_fault_domain (int) – Fault domain of the dedicated host within a dedicated host group.
auto_replace_on_failure (bool) – Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to ‘true’ when not provided.
host_id (str) – A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
virtual_machines (list[SubResourceReadOnly]) – A list of references to all virtual machines in the Dedicated Host.
license_type (str or DedicatedHostLicenseTypes) – Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.. Known values are: “None”, “Windows_Server_Hybrid”, and “Windows_Server_Perpetual”.
provisioning_time (datetime) – The date when the host was first provisioned.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (DedicatedHostInstanceView) – The dedicated host instance view.
time_created (datetime) – Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. Required.
platform_fault_domain (int) – Fault domain of the dedicated host within a dedicated host group.
auto_replace_on_failure (bool) – Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to ‘true’ when not provided.
license_type (str or DedicatedHostLicenseTypes) – Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.. Known values are: “None”, “Windows_Server_Hybrid”, and “Windows_Server_Perpetual”.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostAllocatableVM(*, vm_size: str | None = None, count: float | None = None, **kwargs: Any)[source]¶

Bases: Model

Represents the dedicated host unutilized capacity in terms of a specific VM size.

Variables:

vm_size (str) – VM size in terms of which the unutilized capacity is represented.
count (float) – Maximum number of VMs of size vmSize that can fit in the dedicated host’s remaining capacity.

Keyword Arguments:

vm_size (str) – VM size in terms of which the unutilized capacity is represented.
count (float) – Maximum number of VMs of size vmSize that can fit in the dedicated host’s remaining capacity.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostAvailableCapacity(*, allocatable_v_ms: List[_models.DedicatedHostAllocatableVM] | None = None, **kwargs: Any)[source]¶

Bases: Model

Dedicated host unutilized capacity.

Variables:: allocatable_v_ms (list[DedicatedHostAllocatableVM]) – The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
Keyword Arguments:: allocatable_v_ms (list[DedicatedHostAllocatableVM]) – The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostGroup(*, location: str, tags: Dict[str, str] | None = None, zones: List[str] | None = None, platform_fault_domain_count: int | None = None, support_automatic_placement: bool | None = None, additional_capabilities: _models.DedicatedHostGroupPropertiesAdditionalCapabilities | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
zones (list[str]) – Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
platform_fault_domain_count (int) – Number of fault domains that the host group can span.
hosts (list[SubResourceReadOnly]) – A list of references to all dedicated hosts in the dedicated host group.
instance_view (DedicatedHostGroupInstanceView) – The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
support_automatic_placement (bool) – Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to ‘false’ when not provided. Minimum api-version: 2020-06-01.
additional_capabilities (DedicatedHostGroupPropertiesAdditionalCapabilities) – Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
zones (list[str]) – Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
platform_fault_domain_count (int) – Number of fault domains that the host group can span.
support_automatic_placement (bool) – Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to ‘false’ when not provided. Minimum api-version: 2020-06-01.
additional_capabilities (DedicatedHostGroupPropertiesAdditionalCapabilities) – Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostGroupInstanceView(*, hosts: List[_models.DedicatedHostInstanceViewWithName] | None = None, **kwargs: Any)[source]¶

Bases: Model

DedicatedHostGroupInstanceView.

Variables:: hosts (list[DedicatedHostInstanceViewWithName]) – List of instance view of the dedicated hosts under the dedicated host group.
Keyword Arguments:: hosts (list[DedicatedHostInstanceViewWithName]) – List of instance view of the dedicated hosts under the dedicated host group.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostGroupListResult(*, value: List[_models.DedicatedHostGroup], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Dedicated Host Group with resource group response.

All required parameters must be populated in order to send to server.

Variables:

value (list[DedicatedHostGroup]) – The list of dedicated host groups. Required.
next_link (str) – The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups.

Keyword Arguments:

value (list[DedicatedHostGroup]) – The list of dedicated host groups. Required.
next_link (str) – The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostGroupPropertiesAdditionalCapabilities(*, ultra_ssd_enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Variables:: ultra_ssd_enabled (bool) – The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to ‘false’ when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. Note: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01.
Keyword Arguments:: ultra_ssd_enabled (bool) – The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to ‘false’ when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. Note: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostGroupUpdate(*, tags: Dict[str, str] | None = None, zones: List[str] | None = None, platform_fault_domain_count: int | None = None, support_automatic_placement: bool | None = None, additional_capabilities: _models.DedicatedHostGroupPropertiesAdditionalCapabilities | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
zones (list[str]) – Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
platform_fault_domain_count (int) – Number of fault domains that the host group can span.
hosts (list[SubResourceReadOnly]) – A list of references to all dedicated hosts in the dedicated host group.
instance_view (DedicatedHostGroupInstanceView) – The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
support_automatic_placement (bool) – Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to ‘false’ when not provided. Minimum api-version: 2020-06-01.
additional_capabilities (DedicatedHostGroupPropertiesAdditionalCapabilities) – Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
zones (list[str]) – Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
platform_fault_domain_count (int) – Number of fault domains that the host group can span.
support_automatic_placement (bool) – Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to ‘false’ when not provided. Minimum api-version: 2020-06-01.
additional_capabilities (DedicatedHostGroupPropertiesAdditionalCapabilities) – Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostInstanceView(*, available_capacity: _models.DedicatedHostAvailableCapacity | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a dedicated host.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

asset_id (str) – Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
available_capacity (DedicatedHostAvailableCapacity) – Unutilized capacity of the dedicated host.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

available_capacity (DedicatedHostAvailableCapacity) – Unutilized capacity of the dedicated host.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostInstanceViewWithName(*, available_capacity: _models.DedicatedHostAvailableCapacity | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: DedicatedHostInstanceView

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

asset_id (str) – Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
available_capacity (DedicatedHostAvailableCapacity) – Unutilized capacity of the dedicated host.
statuses (list[InstanceViewStatus]) – The resource status information.
name (str) – The name of the dedicated host.

Keyword Arguments:

available_capacity (DedicatedHostAvailableCapacity) – Unutilized capacity of the dedicated host.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostLicenseTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None..

NONE = 'None'¶

WINDOWS_SERVER_HYBRID = 'Windows_Server_Hybrid'¶

WINDOWS_SERVER_PERPETUAL = 'Windows_Server_Perpetual'¶

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostListResult(*, value: List[_models.DedicatedHost], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The list dedicated host operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[DedicatedHost]) – The list of dedicated hosts. Required.
next_link (str) – The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts.

Keyword Arguments:

value (list[DedicatedHost]) – The list of dedicated hosts. Required.
next_link (str) – The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostSizeListResult(*, value: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Dedicated Host sizes operation response.

Variables:: value (list[str]) – The list of dedicated host sizes.
Keyword Arguments:: value (list[str]) – The list of dedicated host sizes.

class azure.mgmt.compute.v2024_07_01.models.DedicatedHostUpdate(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, platform_fault_domain: int | None = None, auto_replace_on_failure: bool | None = None, license_type: str | _models.DedicatedHostLicenseTypes | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
sku (Sku) – [List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set.
platform_fault_domain (int) – Fault domain of the dedicated host within a dedicated host group.
auto_replace_on_failure (bool) – Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to ‘true’ when not provided.
host_id (str) – A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
virtual_machines (list[SubResourceReadOnly]) – A list of references to all virtual machines in the Dedicated Host.
license_type (str or DedicatedHostLicenseTypes) – Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.. Known values are: “None”, “Windows_Server_Hybrid”, and “Windows_Server_Perpetual”.
provisioning_time (datetime) – The date when the host was first provisioned.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (DedicatedHostInstanceView) – The dedicated host instance view.
time_created (datetime) – Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (Sku) – [List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set.
platform_fault_domain (int) – Fault domain of the dedicated host within a dedicated host group.
auto_replace_on_failure (bool) – Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to ‘true’ when not provided.
license_type (str or DedicatedHostLicenseTypes) – Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.. Known values are: “None”, “Windows_Server_Hybrid”, and “Windows_Server_Perpetual”.

class azure.mgmt.compute.v2024_07_01.models.DeleteOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specify what happens to the network interface when the VM is deleted.

DELETE = 'Delete'¶

DETACH = 'Detach'¶

class azure.mgmt.compute.v2024_07_01.models.DiagnosticsProfile(*, boot_diagnostics: _models.BootDiagnostics | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:: boot_diagnostics (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.
Keyword Arguments:: boot_diagnostics (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.

class azure.mgmt.compute.v2024_07_01.models.DiffDiskOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the ephemeral disk option for operating system disk.

LOCAL = 'Local'¶

class azure.mgmt.compute.v2024_07_01.models.DiffDiskPlacement(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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, resource disk or nvme 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. Minimum api-version for NvmeDisk: 2024-03-01.

CACHE_DISK = 'CacheDisk'¶

NVME_DISK = 'NvmeDisk'¶

RESOURCE_DISK = 'ResourceDisk'¶

class azure.mgmt.compute.v2024_07_01.models.DiffDiskSettings(*, option: str | _models.DiffDiskOptions | None = None, placement: str | _models.DiffDiskPlacement | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

Variables:

option (str or DiffDiskOptions) – Specifies the ephemeral disk settings for operating system disk. “Local”
placement (str or DiffDiskPlacement) – Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the 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. Minimum api-version for NvmeDisk: 2024-03-01. Known values are: “CacheDisk”, “ResourceDisk”, and “NvmeDisk”.

Keyword Arguments:

option (str or DiffDiskOptions) – Specifies the ephemeral disk settings for operating system disk. “Local”
placement (str or DiffDiskPlacement) – Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the 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. Minimum api-version for NvmeDisk: 2024-03-01. Known values are: “CacheDisk”, “ResourceDisk”, and “NvmeDisk”.

class azure.mgmt.compute.v2024_07_01.models.DisallowedConfiguration(*, vm_disk_type: str | _models.VmDiskTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the disallowed configuration for a virtual machine image.

Variables:: vm_disk_type (str or VmDiskTypes) – VM disk types which are disallowed. Known values are: “None” and “Unmanaged”.
Keyword Arguments:: vm_disk_type (str or VmDiskTypes) – VM disk types which are disallowed. Known values are: “None” and “Unmanaged”.

class azure.mgmt.compute.v2024_07_01.models.DiskControllerTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.

NV_ME = 'NVMe'¶

SCSI = 'SCSI'¶

class azure.mgmt.compute.v2024_07_01.models.DiskCreateOptionTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point.

ATTACH = 'Attach'¶

COPY = 'Copy'¶

EMPTY = 'Empty'¶

FROM_IMAGE = 'FromImage'¶

RESTORE = 'Restore'¶

class azure.mgmt.compute.v2024_07_01.models.DiskDeleteOptionTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: 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.

DELETE = 'Delete'¶

DETACH = 'Detach'¶

class azure.mgmt.compute.v2024_07_01.models.DiskDetachOptionTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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 are: 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. To force-detach a data disk update toBeDetached to ‘true’ along with setting detachOption: ‘ForceDetach’.

FORCE_DETACH = 'ForceDetach'¶

class azure.mgmt.compute.v2024_07_01.models.DiskEncryptionSetParameters(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: SubResource

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

Variables:: id (str) – Resource Id.
Keyword Arguments:: id (str) – Resource Id.

class azure.mgmt.compute.v2024_07_01.models.DiskEncryptionSettings(*, disk_encryption_key: _models.KeyVaultSecretReference | None = None, key_encryption_key: _models.KeyVaultKeyReference | None = None, enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a Encryption Settings for a Disk.

Variables:

disk_encryption_key (KeyVaultSecretReference) – Specifies the location of the disk encryption key, which is a Key Vault Secret.
key_encryption_key (KeyVaultKeyReference) – Specifies the location of the key encryption key in Key Vault.
enabled (bool) – Specifies whether disk encryption should be enabled on the virtual machine.

Keyword Arguments:

disk_encryption_key (KeyVaultSecretReference) – Specifies the location of the disk encryption key, which is a Key Vault Secret.
key_encryption_key (KeyVaultKeyReference) – Specifies the location of the key encryption key in Key Vault.
enabled (bool) – Specifies whether disk encryption should be enabled on the virtual machine.

class azure.mgmt.compute.v2024_07_01.models.DiskInstanceView(*, name: str | None = None, encryption_settings: List[_models.DiskEncryptionSettings] | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of the disk.

Variables:

name (str) – The disk name.
encryption_settings (list[DiskEncryptionSettings]) – Specifies the encryption settings for the OS Disk.   Minimum api-version: 2015-06-15.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

name (str) – The disk name.
encryption_settings (list[DiskEncryptionSettings]) – Specifies the encryption settings for the OS Disk.   Minimum api-version: 2015-06-15.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.DiskRestorePointAttributes(*, encryption: _models.RestorePointEncryption | None = None, source_disk_restore_point: _models.ApiEntityReference | None = None, **kwargs: Any)[source]¶

Bases: SubResourceReadOnly

Disk Restore Point details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
encryption (RestorePointEncryption) – Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.
source_disk_restore_point (ApiEntityReference) – Resource Id of the source disk restore point.

Keyword Arguments:

encryption (RestorePointEncryption) – Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.
source_disk_restore_point (ApiEntityReference) – Resource Id of the source disk restore point.

class azure.mgmt.compute.v2024_07_01.models.DiskRestorePointInstanceView(*, id: str | None = None, replication_status: _models.DiskRestorePointReplicationStatus | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a disk restore point.

Variables:

id (str) – Disk restore point Id.
replication_status (DiskRestorePointReplicationStatus) – The disk restore point replication status information.

Keyword Arguments:

id (str) – Disk restore point Id.
replication_status (DiskRestorePointReplicationStatus) – The disk restore point replication status information.

class azure.mgmt.compute.v2024_07_01.models.DiskRestorePointReplicationStatus(*, status: _models.InstanceViewStatus | None = None, completion_percent: int | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a disk restore point.

Variables:

status (InstanceViewStatus) – The resource status information.
completion_percent (int) – Replication completion percentage.

Keyword Arguments:

status (InstanceViewStatus) – The resource status information.
completion_percent (int) – Replication completion percentage.

class azure.mgmt.compute.v2024_07_01.models.DomainNameLabelScopeTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created.

NO_REUSE = 'NoReuse'¶

RESOURCE_GROUP_REUSE = 'ResourceGroupReuse'¶

SUBSCRIPTION_REUSE = 'SubscriptionReuse'¶

TENANT_REUSE = 'TenantReuse'¶

class azure.mgmt.compute.v2024_07_01.models.EncryptionIdentity(*, user_assigned_identity_resource_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Variables:: user_assigned_identity_resource_id (str) – Specifies ARM Resource ID of one of the user identities associated with the VM.
Keyword Arguments:: user_assigned_identity_resource_id (str) – Specifies ARM Resource ID of one of the user identities associated with the VM.

class azure.mgmt.compute.v2024_07_01.models.EventGridAndResourceGraph(*, enable: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies eventGridAndResourceGraph related Scheduled Event related configurations.

Variables:: enable (bool) – Specifies if event grid and resource graph is enabled for Scheduled event related configurations.
Keyword Arguments:: enable (bool) – Specifies if event grid and resource graph is enabled for Scheduled event related configurations.

class azure.mgmt.compute.v2024_07_01.models.ExecutionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Script execution status.

CANCELED = 'Canceled'¶

FAILED = 'Failed'¶

PENDING = 'Pending'¶

RUNNING = 'Running'¶

SUCCEEDED = 'Succeeded'¶

TIMED_OUT = 'TimedOut'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.ExpandTypeForListVMs(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ExpandTypeForListVMs.

INSTANCE_VIEW = 'instanceView'¶

class azure.mgmt.compute.v2024_07_01.models.ExpandTypesForGetCapacityReservationGroups(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ExpandTypesForGetCapacityReservationGroups.

VIRTUAL_MACHINES_REF = 'virtualMachines/$ref'¶

VIRTUAL_MACHINE_SCALE_SET_VMS_REF = 'virtualMachineScaleSetVMs/$ref'¶

class azure.mgmt.compute.v2024_07_01.models.ExpandTypesForGetVMScaleSets(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ExpandTypesForGetVMScaleSets.

USER_DATA = 'userData'¶

class azure.mgmt.compute.v2024_07_01.models.ExpandTypesForListVMs(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ExpandTypesForListVMs.

INSTANCE_VIEW = 'instanceView'¶

class azure.mgmt.compute.v2024_07_01.models.ExtendedLocation(*, name: str | None = None, type: str | _models.ExtendedLocationTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

The complex type of the extended location.

Variables:

name (str) – The name of the extended location.
type (str or ExtendedLocationTypes) – The type of the extended location. “EdgeZone”

Keyword Arguments:

name (str) – The name of the extended location.
type (str or ExtendedLocationTypes) – The type of the extended location. “EdgeZone”

class azure.mgmt.compute.v2024_07_01.models.ExtendedLocationTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of extendedLocation.

EDGE_ZONE = 'EdgeZone'¶

class azure.mgmt.compute.v2024_07_01.models.HardwareProfile(*, vm_size: str | _models.VirtualMachineSizeTypes | None = None, vm_size_properties: _models.VMSizeProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the hardware settings for the virtual machine.

Variables:

vm_size (str or VirtualMachineSizeTypes) – Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The 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. Known values are: “Basic_A0”, “Basic_A1”, “Basic_A2”, “Basic_A3”, “Basic_A4”, “Standard_A0”, “Standard_A1”, “Standard_A2”, “Standard_A3”, “Standard_A4”, “Standard_A5”, “Standard_A6”, “Standard_A7”, “Standard_A8”, “Standard_A9”, “Standard_A10”, “Standard_A11”, “Standard_A1_v2”, “Standard_A2_v2”, “Standard_A4_v2”, “Standard_A8_v2”, “Standard_A2m_v2”, “Standard_A4m_v2”, “Standard_A8m_v2”, “Standard_B1s”, “Standard_B1ms”, “Standard_B2s”, “Standard_B2ms”, “Standard_B4ms”, “Standard_B8ms”, “Standard_D1”, “Standard_D2”, “Standard_D3”, “Standard_D4”, “Standard_D11”, “Standard_D12”, “Standard_D13”, “Standard_D14”, “Standard_D1_v2”, “Standard_D2_v2”, “Standard_D3_v2”, “Standard_D4_v2”, “Standard_D5_v2”, “Standard_D2_v3”, “Standard_D4_v3”, “Standard_D8_v3”, “Standard_D16_v3”, “Standard_D32_v3”, “Standard_D64_v3”, “Standard_D2s_v3”, “Standard_D4s_v3”, “Standard_D8s_v3”, “Standard_D16s_v3”, “Standard_D32s_v3”, “Standard_D64s_v3”, “Standard_D11_v2”, “Standard_D12_v2”, “Standard_D13_v2”, “Standard_D14_v2”, “Standard_D15_v2”, “Standard_DS1”, “Standard_DS2”, “Standard_DS3”, “Standard_DS4”, “Standard_DS11”, “Standard_DS12”, “Standard_DS13”, “Standard_DS14”, “Standard_DS1_v2”, “Standard_DS2_v2”, “Standard_DS3_v2”, “Standard_DS4_v2”, “Standard_DS5_v2”, “Standard_DS11_v2”, “Standard_DS12_v2”, “Standard_DS13_v2”, “Standard_DS14_v2”, “Standard_DS15_v2”, “Standard_DS13-4_v2”, “Standard_DS13-2_v2”, “Standard_DS14-8_v2”, “Standard_DS14-4_v2”, “Standard_E2_v3”, “Standard_E4_v3”, “Standard_E8_v3”, “Standard_E16_v3”, “Standard_E32_v3”, “Standard_E64_v3”, “Standard_E2s_v3”, “Standard_E4s_v3”, “Standard_E8s_v3”, “Standard_E16s_v3”, “Standard_E32s_v3”, “Standard_E64s_v3”, “Standard_E32-16_v3”, “Standard_E32-8s_v3”, “Standard_E64-32s_v3”, “Standard_E64-16s_v3”, “Standard_F1”, “Standard_F2”, “Standard_F4”, “Standard_F8”, “Standard_F16”, “Standard_F1s”, “Standard_F2s”, “Standard_F4s”, “Standard_F8s”, “Standard_F16s”, “Standard_F2s_v2”, “Standard_F4s_v2”, “Standard_F8s_v2”, “Standard_F16s_v2”, “Standard_F32s_v2”, “Standard_F64s_v2”, “Standard_F72s_v2”, “Standard_G1”, “Standard_G2”, “Standard_G3”, “Standard_G4”, “Standard_G5”, “Standard_GS1”, “Standard_GS2”, “Standard_GS3”, “Standard_GS4”, “Standard_GS5”, “Standard_GS4-8”, “Standard_GS4-4”, “Standard_GS5-16”, “Standard_GS5-8”, “Standard_H8”, “Standard_H16”, “Standard_H8m”, “Standard_H16m”, “Standard_H16r”, “Standard_H16mr”, “Standard_L4s”, “Standard_L8s”, “Standard_L16s”, “Standard_L32s”, “Standard_M64s”, “Standard_M64ms”, “Standard_M128s”, “Standard_M128ms”, “Standard_M64-32ms”, “Standard_M64-16ms”, “Standard_M128-64ms”, “Standard_M128-32ms”, “Standard_NC6”, “Standard_NC12”, “Standard_NC24”, “Standard_NC24r”, “Standard_NC6s_v2”, “Standard_NC12s_v2”, “Standard_NC24s_v2”, “Standard_NC24rs_v2”, “Standard_NC6s_v3”, “Standard_NC12s_v3”, “Standard_NC24s_v3”, “Standard_NC24rs_v3”, “Standard_ND6s”, “Standard_ND12s”, “Standard_ND24s”, “Standard_ND24rs”, “Standard_NV6”, “Standard_NV12”, and “Standard_NV24”.
vm_size_properties (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.

Keyword Arguments:

vm_size (str or VirtualMachineSizeTypes) –
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The 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. Known values are: “Basic_A0”, “Basic_A1”, “Basic_A2”, “Basic_A3”, “Basic_A4”, “Standard_A0”, “Standard_A1”, “Standard_A2”, “Standard_A3”, “Standard_A4”, “Standard_A5”, “Standard_A6”, “Standard_A7”, “Standard_A8”, “Standard_A9”, “Standard_A10”, “Standard_A11”, “Standard_A1_v2”, “Standard_A2_v2”, “Standard_A4_v2”, “Standard_A8_v2”, “Standard_A2m_v2”, “Standard_A4m_v2”, “Standard_A8m_v2”, “Standard_B1s”, “Standard_B1ms”, “Standard_B2s”, “Standard_B2ms”, “Standard_B4ms”, “Standard_B8ms”, “Standard_D1”, “Standard_D2”, “Standard_D3”, “Standard_D4”, “Standard_D11”, “Standard_D12”, “Standard_D13”, “Standard_D14”, “Standard_D1_v2”, “Standard_D2_v2”, “Standard_D3_v2”, “Standard_D4_v2”, “Standard_D5_v2”, “Standard_D2_v3”, “Standard_D4_v3”, “Standard_D8_v3”, “Standard_D16_v3”, “Standard_D32_v3”, “Standard_D64_v3”, “Standard_D2s_v3”, “Standard_D4s_v3”, “Standard_D8s_v3”, “Standard_D16s_v3”, “Standard_D32s_v3”, “Standard_D64s_v3”, “Standard_D11_v2”, “Standard_D12_v2”, “Standard_D13_v2”, “Standard_D14_v2”, “Standard_D15_v2”, “Standard_DS1”, “Standard_DS2”, “Standard_DS3”, “Standard_DS4”, “Standard_DS11”, “Standard_DS12”, “Standard_DS13”, “Standard_DS14”, “Standard_DS1_v2”, “Standard_DS2_v2”, “Standard_DS3_v2”, “Standard_DS4_v2”, “Standard_DS5_v2”, “Standard_DS11_v2”, “Standard_DS12_v2”, “Standard_DS13_v2”, “Standard_DS14_v2”, “Standard_DS15_v2”, “Standard_DS13-4_v2”, “Standard_DS13-2_v2”, “Standard_DS14-8_v2”, “Standard_DS14-4_v2”, “Standard_E2_v3”, “Standard_E4_v3”, “Standard_E8_v3”, “Standard_E16_v3”, “Standard_E32_v3”, “Standard_E64_v3”, “Standard_E2s_v3”, “Standard_E4s_v3”, “Standard_E8s_v3”, “Standard_E16s_v3”, “Standard_E32s_v3”, “Standard_E64s_v3”, “Standard_E32-16_v3”, “Standard_E32-8s_v3”, “Standard_E64-32s_v3”, “Standard_E64-16s_v3”, “Standard_F1”, “Standard_F2”, “Standard_F4”, “Standard_F8”, “Standard_F16”, “Standard_F1s”, “Standard_F2s”, “Standard_F4s”, “Standard_F8s”, “Standard_F16s”, “Standard_F2s_v2”, “Standard_F4s_v2”, “Standard_F8s_v2”, “Standard_F16s_v2”, “Standard_F32s_v2”, “Standard_F64s_v2”, “Standard_F72s_v2”, “Standard_G1”, “Standard_G2”, “Standard_G3”, “Standard_G4”, “Standard_G5”, “Standard_GS1”, “Standard_GS2”, “Standard_GS3”, “Standard_GS4”, “Standard_GS5”, “Standard_GS4-8”, “Standard_GS4-4”, “Standard_GS5-16”, “Standard_GS5-8”, “Standard_H8”, “Standard_H16”, “Standard_H8m”, “Standard_H16m”, “Standard_H16r”, “Standard_H16mr”, “Standard_L4s”, “Standard_L8s”, “Standard_L16s”, “Standard_L32s”, “Standard_M64s”, “Standard_M64ms”, “Standard_M128s”, “Standard_M128ms”, “Standard_M64-32ms”, “Standard_M64-16ms”, “Standard_M128-64ms”, “Standard_M128-32ms”, “Standard_NC6”, “Standard_NC12”, “Standard_NC24”, “Standard_NC24r”, “Standard_NC6s_v2”, “Standard_NC12s_v2”, “Standard_NC24s_v2”, “Standard_NC24rs_v2”, “Standard_NC6s_v3”, “Standard_NC12s_v3”, “Standard_NC24s_v3”, “Standard_NC24rs_v3”, “Standard_ND6s”, “Standard_ND12s”, “Standard_ND24s”, “Standard_ND24rs”, “Standard_NV6”, “Standard_NV12”, and “Standard_NV24”.
vm_size_properties (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.

class azure.mgmt.compute.v2024_07_01.models.HyperVGeneration(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The hypervisor generation of the Virtual Machine [V1, V2].

V1 = 'V1'¶

V2 = 'V2'¶

class azure.mgmt.compute.v2024_07_01.models.HyperVGenerationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the HyperVGeneration Type associated with a resource.

V1 = 'V1'¶

V2 = 'V2'¶

class azure.mgmt.compute.v2024_07_01.models.HyperVGenerationTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the HyperVGeneration Type.

V1 = 'V1'¶

V2 = 'V2'¶

class azure.mgmt.compute.v2024_07_01.models.IPVersion(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

I_PV4 = 'IPv4'¶

I_PV6 = 'IPv6'¶

class azure.mgmt.compute.v2024_07_01.models.IPVersions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

I_PV4 = 'IPv4'¶

I_PV6 = 'IPv6'¶

class azure.mgmt.compute.v2024_07_01.models.Image(*, location: str, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, source_virtual_machine: _models.SubResource | None = None, storage_profile: _models.ImageStorageProfile | None = None, hyper_v_generation: str | _models.HyperVGenerationTypes | None = None, **kwargs: Any)[source]¶

Bases: Resource

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.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
extended_location (ExtendedLocation) – The extended location of the Image.
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
provisioning_state (str) – The provisioning state.
hyper_v_generation (str or HyperVGenerationTypes) – 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. Known values are: “V1” and “V2”.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
extended_location (ExtendedLocation) – The extended location of the Image.
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
hyper_v_generation (str or HyperVGenerationTypes) – 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. Known values are: “V1” and “V2”.

class azure.mgmt.compute.v2024_07_01.models.ImageDataDisk(*, lun: int, snapshot: _models.SubResource | None = None, managed_disk: _models.SubResource | None = None, blob_uri: str | None = None, caching: str | _models.CachingTypes | None = None, disk_size_gb: int | None = None, storage_account_type: str | _models.StorageAccountTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, **kwargs: Any)[source]¶

Bases: ImageDisk

Describes a data disk.

All required parameters must be populated in order to send to server.

Variables:

snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – 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.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed image disk.
lun (int) – 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. Required.

Keyword Arguments:

snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – 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.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed image disk.
lun (int) – 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. Required.

class azure.mgmt.compute.v2024_07_01.models.ImageDeprecationStatus(*, image_state: str | _models.ImageState | None = None, scheduled_deprecation_time: datetime | None = None, alternative_option: _models.AlternativeOption | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes image deprecation status properties on the image.

Variables:

image_state (str or ImageState) – Describes the state of the image. Known values are: “Active”, “ScheduledForDeprecation”, and “Deprecated”.
scheduled_deprecation_time (datetime) – The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher.
alternative_option (AlternativeOption) – Describes the alternative option specified by the Publisher for this image when this image is deprecated.

Keyword Arguments:

image_state (str or ImageState) – Describes the state of the image. Known values are: “Active”, “ScheduledForDeprecation”, and “Deprecated”.
scheduled_deprecation_time (datetime) – The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher.
alternative_option (AlternativeOption) – Describes the alternative option specified by the Publisher for this image when this image is deprecated.

class azure.mgmt.compute.v2024_07_01.models.ImageDisk(*, snapshot: _models.SubResource | None = None, managed_disk: _models.SubResource | None = None, blob_uri: str | None = None, caching: str | _models.CachingTypes | None = None, disk_size_gb: int | None = None, storage_account_type: str | _models.StorageAccountTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a image disk.

Variables:

snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – 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.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed image disk.

Keyword Arguments:

snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – 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.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed image disk.

class azure.mgmt.compute.v2024_07_01.models.ImageListResult(*, value: List[_models.Image], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Image operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[Image]) – The list of Images. Required.
next_link (str) – The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images.

Keyword Arguments:

value (list[Image]) – The list of Images. Required.
next_link (str) – The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images.

class azure.mgmt.compute.v2024_07_01.models.ImageOSDisk(*, os_type: str | _models.OperatingSystemTypes, os_state: str | _models.OperatingSystemStateTypes, snapshot: _models.SubResource | None = None, managed_disk: _models.SubResource | None = None, blob_uri: str | None = None, caching: str | _models.CachingTypes | None = None, disk_size_gb: int | None = None, storage_account_type: str | _models.StorageAccountTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, **kwargs: Any)[source]¶

Bases: ImageDisk

Describes an Operating System disk.

All required parameters must be populated in order to send to server.

Variables:

snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – 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.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed image disk.
os_type (str or OperatingSystemTypes) – 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.. Required. Known values are: “Windows” and “Linux”.
os_state (str or OperatingSystemStateTypes) – The OS State. For managed images, use Generalized. Required. Known values are: “Generalized” and “Specialized”.

Keyword Arguments:

snapshot (SubResource) – The snapshot.
managed_disk (SubResource) – The managedDisk.
blob_uri (str) – The Virtual Hard Disk.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – 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.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed image disk.
os_type (str or OperatingSystemTypes) – 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.. Required. Known values are: “Windows” and “Linux”.
os_state (str or OperatingSystemStateTypes) – The OS State. For managed images, use Generalized. Required. Known values are: “Generalized” and “Specialized”.

Bases: SubResource

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.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
publisher (str) – The image publisher.
offer (str) – Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku (str) – The image SKU.
version (str) – 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}’ # pylint: disable=line-too-long in the ‘id’ field without version input.
exact_version (str) – 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’.
shared_gallery_image_id (str) – Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
community_gallery_image_id (str) – Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

Keyword Arguments:

id (str) – Resource Id.
publisher (str) – The image publisher.
offer (str) – Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku (str) – The image SKU.
version (str) – 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}’ # pylint: disable=line-too-long in the ‘id’ field without version input.
shared_gallery_image_id (str) – Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
community_gallery_image_id (str) – Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

class azure.mgmt.compute.v2024_07_01.models.ImageState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Describes the state of the image.

ACTIVE = 'Active'¶

DEPRECATED = 'Deprecated'¶

SCHEDULED_FOR_DEPRECATION = 'ScheduledForDeprecation'¶

class azure.mgmt.compute.v2024_07_01.models.ImageStorageProfile(*, os_disk: _models.ImageOSDisk | None = None, data_disks: List[_models.ImageDataDisk] | None = None, zone_resilient: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a storage profile.

Variables:

os_disk (ImageOSDisk) – 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.
data_disks (list[ImageDataDisk]) –
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.
zone_resilient (bool) – 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).

Keyword Arguments:

os_disk (ImageOSDisk) –
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.
data_disks (list[ImageDataDisk]) –
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.
zone_resilient (bool) – 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).

class azure.mgmt.compute.v2024_07_01.models.ImageUpdate(*, tags: Dict[str, str] | None = None, source_virtual_machine: _models.SubResource | None = None, storage_profile: _models.ImageStorageProfile | None = None, hyper_v_generation: str | _models.HyperVGenerationTypes | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

The source user image virtual hard disk. Only tags may be updated.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
provisioning_state (str) – The provisioning state.
hyper_v_generation (str or HyperVGenerationTypes) – 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. Known values are: “V1” and “V2”.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
source_virtual_machine (SubResource) – The source virtual machine from which Image is created.
storage_profile (ImageStorageProfile) – Specifies the storage settings for the virtual machine disks.
hyper_v_generation (str or HyperVGenerationTypes) – 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. Known values are: “V1” and “V2”.

class azure.mgmt.compute.v2024_07_01.models.InnerError(*, exceptiontype: str | None = None, errordetail: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Inner error details.

Variables:

exceptiontype (str) – The exception type.
errordetail (str) – The internal error message or exception dump.

Keyword Arguments:

exceptiontype (str) – The exception type.
errordetail (str) – The internal error message or exception dump.

Bases: Model

Instance view status.

Variables:

code (str) – The status code.
level (str or StatusLevelTypes) – The level code. Known values are: “Info”, “Warning”, and “Error”.
display_status (str) – The short localizable label for the status.
message (str) – The detailed status message, including for alerts and error messages.
time (datetime) – The time of the status.

Keyword Arguments:

code (str) – The status code.
level (str or StatusLevelTypes) – The level code. Known values are: “Info”, “Warning”, and “Error”.
display_status (str) – The short localizable label for the status.
message (str) – The detailed status message, including for alerts and error messages.
time (datetime) – The time of the status.

class azure.mgmt.compute.v2024_07_01.models.InstanceViewTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

InstanceViewTypes.

INSTANCE_VIEW = 'instanceView'¶

USER_DATA = 'userData'¶

class azure.mgmt.compute.v2024_07_01.models.IntervalInMins(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Interval value in minutes used to create LogAnalytics call rate logs.

FIVE_MINS = 'FiveMins'¶

SIXTY_MINS = 'SixtyMins'¶

THIRTY_MINS = 'ThirtyMins'¶

THREE_MINS = 'ThreeMins'¶

class azure.mgmt.compute.v2024_07_01.models.KeyVaultKeyReference(*, key_url: str, source_vault: _models.SubResource, **kwargs: Any)[source]¶

Bases: Model

Describes a reference to Key Vault Key.

All required parameters must be populated in order to send to server.

Variables:

key_url (str) – The URL referencing a key encryption key in Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the key. Required.

Keyword Arguments:

key_url (str) – The URL referencing a key encryption key in Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the key. Required.

class azure.mgmt.compute.v2024_07_01.models.KeyVaultSecretReference(*, secret_url: str, source_vault: _models.SubResource, **kwargs: Any)[source]¶

Bases: Model

Describes a reference to Key Vault Secret.

All required parameters must be populated in order to send to server.

Variables:

secret_url (str) – The URL referencing a secret in a Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the secret. Required.

Keyword Arguments:

secret_url (str) – The URL referencing a secret in a Key Vault. Required.
source_vault (SubResource) – The relative URL of the Key Vault containing the secret. Required.

class azure.mgmt.compute.v2024_07_01.models.LastPatchInstallationSummary(**kwargs: Any)[source]¶

Bases: Model

Describes the properties of the last installed patch summary.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

status (str or PatchOperationStatus) – 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.”. Known values are: “Unknown”, “InProgress”, “Failed”, “Succeeded”, and “CompletedWithWarnings”.
installation_activity_id (str) – The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
maintenance_window_exceeded (bool) – Describes whether the operation ran out of time before it completed all its intended actions.
not_selected_patch_count (int) – The number of all available patches but not going to be installed because it didn’t match a classification or inclusion list entry.
excluded_patch_count (int) – The number of all available patches but excluded explicitly by a customer-specified exclusion list match.
pending_patch_count (int) – The number of all available patches expected to be installed over the course of the patch installation operation.
installed_patch_count (int) – The count of patches that successfully installed.
failed_patch_count (int) – The count of patches that failed installation.
start_time (datetime) – The UTC timestamp when the operation began.
last_modified_time (datetime) – The UTC timestamp when the operation began.
error (ApiError) – The errors that were encountered during execution of the operation. The details array contains the list of them.

class azure.mgmt.compute.v2024_07_01.models.LinuxConfiguration(*, disable_password_authentication: bool | None = None, ssh: _models.SshConfiguration | None = None, provision_vm_agent: bool | None = None, patch_settings: _models.LinuxPatchSettings | None = None, enable_vm_agent_platform_updates: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

disable_password_authentication (bool) – Specifies whether password authentication should be disabled.
ssh (SshConfiguration) – Specifies the ssh key configuration for a Linux OS.
provision_vm_agent (bool) – 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.
patch_settings (LinuxPatchSettings) – [Preview Feature] Specifies settings related to VM Guest Patching on Linux.
enable_vm_agent_platform_updates (bool) – Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.

Keyword Arguments:

disable_password_authentication (bool) – Specifies whether password authentication should be disabled.
ssh (SshConfiguration) – Specifies the ssh key configuration for a Linux OS.
provision_vm_agent (bool) – 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.
patch_settings (LinuxPatchSettings) – [Preview Feature] Specifies settings related to VM Guest Patching on Linux.
enable_vm_agent_platform_updates (bool) – Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.

class azure.mgmt.compute.v2024_07_01.models.LinuxParameters(*, classifications_to_include: List[str | _models.VMGuestPatchClassificationLinux] | None = None, package_name_masks_to_include: List[str] | None = None, package_name_masks_to_exclude: List[str] | None = None, maintenance_run_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Input for InstallPatches on a Linux VM, as directly received by the API.

Variables:

classifications_to_include (list[str or VMGuestPatchClassificationLinux]) – The update classifications to select when installing patches for Linux.
package_name_masks_to_include (list[str]) – packages to include in the patch operation. Format: packageName_packageVersion.
package_name_masks_to_exclude (list[str]) – packages to exclude in the patch operation. Format: packageName_packageVersion.
maintenance_run_id (str) – This is used as a maintenance run identifier for Auto VM Guest Patching in Linux.

Keyword Arguments:

classifications_to_include (list[str or VMGuestPatchClassificationLinux]) – The update classifications to select when installing patches for Linux.
package_name_masks_to_include (list[str]) – packages to include in the patch operation. Format: packageName_packageVersion.
package_name_masks_to_exclude (list[str]) – packages to exclude in the patch operation. Format: packageName_packageVersion.
maintenance_run_id (str) – This is used as a maintenance run identifier for Auto VM Guest Patching in Linux.

class azure.mgmt.compute.v2024_07_01.models.LinuxPatchAssessmentMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'¶

IMAGE_DEFAULT = 'ImageDefault'¶

class azure.mgmt.compute.v2024_07_01.models.LinuxPatchSettings(*, patch_mode: str | _models.LinuxVMGuestPatchMode | None = None, assessment_mode: str | _models.LinuxPatchAssessmentMode | None = None, automatic_by_platform_settings: _models.LinuxVMGuestPatchAutomaticByPlatformSettings | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies settings related to VM Guest Patching on Linux.

Variables:

patch_mode (str or LinuxVMGuestPatchMode) – 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. Known values are: “ImageDefault” and “AutomaticByPlatform”.
assessment_mode (str or LinuxPatchAssessmentMode) – 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. Known values are: “ImageDefault” and “AutomaticByPlatform”.
automatic_by_platform_settings (LinuxVMGuestPatchAutomaticByPlatformSettings) – Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

Keyword Arguments:

patch_mode (str or LinuxVMGuestPatchMode) – 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. Known values are: “ImageDefault” and “AutomaticByPlatform”.
assessment_mode (str or LinuxPatchAssessmentMode) – 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. Known values are: “ImageDefault” and “AutomaticByPlatform”.
automatic_by_platform_settings (LinuxVMGuestPatchAutomaticByPlatformSettings) – Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

class azure.mgmt.compute.v2024_07_01.models.LinuxVMGuestPatchAutomaticByPlatformRebootSetting(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

ALWAYS = 'Always'¶

IF_REQUIRED = 'IfRequired'¶

NEVER = 'Never'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.LinuxVMGuestPatchAutomaticByPlatformSettings(*, reboot_setting: str | _models.LinuxVMGuestPatchAutomaticByPlatformRebootSetting | None = None, bypass_platform_safety_checks_on_user_schedule: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

reboot_setting (str or LinuxVMGuestPatchAutomaticByPlatformRebootSetting) – Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values are: “Unknown”, “IfRequired”, “Never”, and “Always”.
bypass_platform_safety_checks_on_user_schedule (bool) – Enables customer to schedule patching without accidental upgrades.

Keyword Arguments:

reboot_setting (str or LinuxVMGuestPatchAutomaticByPlatformRebootSetting) – Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values are: “Unknown”, “IfRequired”, “Never”, and “Always”.
bypass_platform_safety_checks_on_user_schedule (bool) – Enables customer to schedule patching without accidental upgrades.

class azure.mgmt.compute.v2024_07_01.models.LinuxVMGuestPatchMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'¶

IMAGE_DEFAULT = 'ImageDefault'¶

class azure.mgmt.compute.v2024_07_01.models.ListUsagesResult(*, value: List[_models.Usage], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Usages operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[Usage]) – The list of compute resource usages. Required.
next_link (str) – The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.

Keyword Arguments:

value (list[Usage]) – The list of compute resource usages. Required.
next_link (str) – The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.

class azure.mgmt.compute.v2024_07_01.models.LogAnalyticsInputBase(*, blob_container_sas_uri: str, from_time: datetime, to_time: datetime, group_by_throttle_policy: bool | None = None, group_by_operation_name: bool | None = None, group_by_resource_name: bool | None = None, group_by_client_application_id: bool | None = None, group_by_user_agent: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Api input base class for LogAnalytics Api.

All required parameters must be populated in order to send to server.

Variables:

blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
group_by_client_application_id (bool) – Group query result by Client Application ID.
group_by_user_agent (bool) – Group query result by User Agent.

Keyword Arguments:

blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
group_by_client_application_id (bool) – Group query result by Client Application ID.
group_by_user_agent (bool) – Group query result by User Agent.

class azure.mgmt.compute.v2024_07_01.models.LogAnalyticsOperationResult(**kwargs: Any)[source]¶

Bases: Model

LogAnalytics operation status response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: properties (LogAnalyticsOutput) – LogAnalyticsOutput.

class azure.mgmt.compute.v2024_07_01.models.LogAnalyticsOutput(**kwargs: Any)[source]¶

Bases: Model

LogAnalytics output properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: output (str) – Output file Uri path to blob container.

class azure.mgmt.compute.v2024_07_01.models.MaintenanceOperationResultCodeTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The Last Maintenance Operation Result Code.

MAINTENANCE_ABORTED = 'MaintenanceAborted'¶

MAINTENANCE_COMPLETED = 'MaintenanceCompleted'¶

NONE = 'None'¶

RETRY_LATER = 'RetryLater'¶

class azure.mgmt.compute.v2024_07_01.models.MaintenanceRedeployStatus(*, is_customer_initiated_maintenance_allowed: bool | None = None, pre_maintenance_window_start_time: datetime | None = None, pre_maintenance_window_end_time: datetime | None = None, maintenance_window_start_time: datetime | None = None, maintenance_window_end_time: datetime | None = None, last_operation_result_code: str | _models.MaintenanceOperationResultCodeTypes | None = None, last_operation_message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Maintenance Operation Status.

Variables:

is_customer_initiated_maintenance_allowed (bool) – True, if customer is allowed to perform Maintenance.
pre_maintenance_window_start_time (datetime) – Start Time for the Pre Maintenance Window.
pre_maintenance_window_end_time (datetime) – End Time for the Pre Maintenance Window.
maintenance_window_start_time (datetime) – Start Time for the Maintenance Window.
maintenance_window_end_time (datetime) – End Time for the Maintenance Window.
last_operation_result_code (str or MaintenanceOperationResultCodeTypes) – The Last Maintenance Operation Result Code. Known values are: “None”, “RetryLater”, “MaintenanceAborted”, and “MaintenanceCompleted”.
last_operation_message (str) – Message returned for the last Maintenance Operation.

Keyword Arguments:

is_customer_initiated_maintenance_allowed (bool) – True, if customer is allowed to perform Maintenance.
pre_maintenance_window_start_time (datetime) – Start Time for the Pre Maintenance Window.
pre_maintenance_window_end_time (datetime) – End Time for the Pre Maintenance Window.
maintenance_window_start_time (datetime) – Start Time for the Maintenance Window.
maintenance_window_end_time (datetime) – End Time for the Maintenance Window.
last_operation_result_code (str or MaintenanceOperationResultCodeTypes) – The Last Maintenance Operation Result Code. Known values are: “None”, “RetryLater”, “MaintenanceAborted”, and “MaintenanceCompleted”.
last_operation_message (str) – Message returned for the last Maintenance Operation.

class azure.mgmt.compute.v2024_07_01.models.ManagedDiskParameters(*, id: str | None = None, storage_account_type: str | _models.StorageAccountTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, security_profile: _models.VMDiskSecurityProfile | None = None, **kwargs: Any)[source]¶

Bases: SubResource

The parameters of a managed disk.

Variables:

id (str) – Resource Id.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed disk.
security_profile (VMDiskSecurityProfile) – Specifies the security profile for the managed disk.

Keyword Arguments:

id (str) – Resource Id.
storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed disk.
security_profile (VMDiskSecurityProfile) – Specifies the security profile for the managed disk.

class azure.mgmt.compute.v2024_07_01.models.Mode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.

AUDIT = 'Audit'¶

ENFORCE = 'Enforce'¶

class azure.mgmt.compute.v2024_07_01.models.NetworkApiVersion(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

TWO_THOUSAND_TWENTY11_01 = '2020-11-01'¶

class azure.mgmt.compute.v2024_07_01.models.NetworkInterfaceAuxiliaryMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.

ACCELERATED_CONNECTIONS = 'AcceleratedConnections'¶

FLOATING = 'Floating'¶

NONE = 'None'¶

class azure.mgmt.compute.v2024_07_01.models.NetworkInterfaceAuxiliarySku(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.

A1 = 'A1'¶

A2 = 'A2'¶

A4 = 'A4'¶

A8 = 'A8'¶

NONE = 'None'¶

class azure.mgmt.compute.v2024_07_01.models.NetworkInterfaceReference(*, id: str | None = None, primary: bool | None = None, delete_option: str | _models.DeleteOptions | None = None, **kwargs: Any)[source]¶

Bases: SubResource

Describes a network interface reference.

Variables:

id (str) – Resource Id.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.

Keyword Arguments:

id (str) – Resource Id.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.NetworkProfile(*, network_interfaces: List[_models.NetworkInterfaceReference] | None = None, network_api_version: str | _models.NetworkApiVersion | None = None, network_interface_configurations: List[_models.VirtualMachineNetworkInterfaceConfiguration] | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

network_interfaces (list[NetworkInterfaceReference]) – Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
network_api_version (str or NetworkApiVersion) – specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations. “2020-11-01”
network_interface_configurations (list[VirtualMachineNetworkInterfaceConfiguration]) – Specifies the networking configurations that will be used to create the virtual machine networking resources.

Keyword Arguments:

network_interfaces (list[NetworkInterfaceReference]) – Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
network_api_version (str or NetworkApiVersion) – specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations. “2020-11-01”
network_interface_configurations (list[VirtualMachineNetworkInterfaceConfiguration]) – Specifies the networking configurations that will be used to create the virtual machine networking resources.

class azure.mgmt.compute.v2024_07_01.models.OSDisk(*, create_option: str | _models.DiskCreateOptionTypes, os_type: str | _models.OperatingSystemTypes | None = None, encryption_settings: _models.DiskEncryptionSettings | None = None, name: str | None = None, vhd: _models.VirtualHardDisk | None = None, image: _models.VirtualHardDisk | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, diff_disk_settings: _models.DiffDiskSettings | None = None, disk_size_gb: int | None = None, managed_disk: _models.ManagedDiskParameters | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

All required parameters must be populated in order to send to server.

Variables:

os_type (str or OperatingSystemTypes) – 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.. Known values are: “Windows” and “Linux”.
encryption_settings (DiskEncryptionSettings) – Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
disk_size_gb (int) – 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. The property ‘diskSizeGB’ is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk (ManagedDiskParameters) – The managed disk parameters.
delete_option (str or DiskDeleteOptionTypes) – Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: 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. The user cannot change the delete option for an ephemeral OS Disk. Known values are: “Delete” and “Detach”.

Keyword Arguments:

os_type (str or OperatingSystemTypes) – 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.. Known values are: “Windows” and “Linux”.
encryption_settings (DiskEncryptionSettings) – Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
name (str) – The disk name.
vhd (VirtualHardDisk) – The virtual hard disk.
image (VirtualHardDisk) – The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
disk_size_gb (int) – 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. The property ‘diskSizeGB’ is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk (ManagedDiskParameters) – The managed disk parameters.
delete_option (str or DiskDeleteOptionTypes) – Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: 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. The user cannot change the delete option for an ephemeral OS Disk. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.OSDiskImage(*, operating_system: str | _models.OperatingSystemTypes, **kwargs: Any)[source]¶

Bases: Model

Contains the os disk image information.

All required parameters must be populated in order to send to server.

Variables:: operating_system (str or OperatingSystemTypes) – The operating system of the osDiskImage. Required. Known values are: “Windows” and “Linux”.
Keyword Arguments:: operating_system (str or OperatingSystemTypes) – The operating system of the osDiskImage. Required. Known values are: “Windows” and “Linux”.

class azure.mgmt.compute.v2024_07_01.models.OSImageNotificationProfile(*, not_before_timeout: str | None = None, enable: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

OSImageNotificationProfile.

Variables:

not_before_timeout (str) – Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M).
enable (bool) – Specifies whether the OS Image Scheduled event is enabled or disabled.

Keyword Arguments:

not_before_timeout (str) – Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M).
enable (bool) – Specifies whether the OS Image Scheduled event is enabled or disabled.

class azure.mgmt.compute.v2024_07_01.models.OSProfile(*, computer_name: str | None = None, admin_username: str | None = None, admin_password: str | None = None, custom_data: str | None = None, windows_configuration: _models.WindowsConfiguration | None = None, linux_configuration: _models.LinuxConfiguration | None = None, secrets: List[_models.VaultSecretGroup] | None = None, allow_extension_operations: bool | None = None, require_guest_provision_signal: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

computer_name (str) – 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.
admin_username (str) – 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.
admin_password (str) – 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 :code:` 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.
custom_data (str) – 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. The property ‘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.
windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (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 (list[VaultSecretGroup]) – 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.
allow_extension_operations (bool) – 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.
require_guest_provision_signal (bool) – Optional property which must either be set to True or omitted.

Keyword Arguments:

computer_name (str) –
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.
admin_username (str) – 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.
admin_password (str) –
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 :code:` 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.
custom_data (str) –
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. The property ‘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.
windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (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 (list[VaultSecretGroup]) –
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.
allow_extension_operations (bool) – 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.
require_guest_provision_signal (bool) – Optional property which must either be set to True or omitted.

class azure.mgmt.compute.v2024_07_01.models.OSProfileProvisioningData(*, admin_password: str | None = None, custom_data: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Additional parameters for Reimaging Non-Ephemeral Virtual Machine.

Variables:

admin_password (str) –
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 :code:` 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.
custom_data (str) –
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. The property customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. If using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.

Keyword Arguments:

admin_password (str) –
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 :code:` 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.
custom_data (str) –
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. The property customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. If using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation.

class azure.mgmt.compute.v2024_07_01.models.OperatingSystemStateTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The OS State. For managed images, use Generalized.

GENERALIZED = 'Generalized'¶: Generalized image. Needs to be provisioned during deployment time.

SPECIALIZED = 'Specialized'¶: Specialized image. Contains already provisioned OS Disk.

class azure.mgmt.compute.v2024_07_01.models.OperatingSystemType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Gets the Operating System type.

LINUX = 'Linux'¶

WINDOWS = 'Windows'¶

class azure.mgmt.compute.v2024_07_01.models.OperatingSystemTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

LINUX = 'Linux'¶

WINDOWS = 'Windows'¶

class azure.mgmt.compute.v2024_07_01.models.OrchestrationMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the orchestration mode for the virtual machine scale set.

FLEXIBLE = 'Flexible'¶

UNIFORM = 'Uniform'¶

class azure.mgmt.compute.v2024_07_01.models.OrchestrationServiceNames(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The name of the service.

AUTOMATIC_REPAIRS = 'AutomaticRepairs'¶

DUMMY_ORCHESTRATION_SERVICE_NAME = 'DummyOrchestrationServiceName'¶

class azure.mgmt.compute.v2024_07_01.models.OrchestrationServiceState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The current state of the service.

NOT_RUNNING = 'NotRunning'¶

RUNNING = 'Running'¶

SUSPENDED = 'Suspended'¶

class azure.mgmt.compute.v2024_07_01.models.OrchestrationServiceStateAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The action to be performed.

RESUME = 'Resume'¶

SUSPEND = 'Suspend'¶

class azure.mgmt.compute.v2024_07_01.models.OrchestrationServiceStateInput(*, service_name: str | _models.OrchestrationServiceNames, action: str | _models.OrchestrationServiceStateAction, **kwargs: Any)[source]¶

Bases: Model

The input for OrchestrationServiceState.

All required parameters must be populated in order to send to server.

Variables:

service_name (str or OrchestrationServiceNames) – The name of the service. Required. Known values are: “AutomaticRepairs” and “DummyOrchestrationServiceName”.
action (str or OrchestrationServiceStateAction) – The action to be performed. Required. Known values are: “Resume” and “Suspend”.

Keyword Arguments:

service_name (str or OrchestrationServiceNames) – The name of the service. Required. Known values are: “AutomaticRepairs” and “DummyOrchestrationServiceName”.
action (str or OrchestrationServiceStateAction) – The action to be performed. Required. Known values are: “Resume” and “Suspend”.

class azure.mgmt.compute.v2024_07_01.models.OrchestrationServiceSummary(**kwargs: Any)[source]¶

Bases: Model

Summary for an orchestration service of a virtual machine scale set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

service_name (str or OrchestrationServiceNames) – The name of the service. Known values are: “AutomaticRepairs” and “DummyOrchestrationServiceName”.
service_state (str or OrchestrationServiceState) – The current state of the service. Known values are: “NotRunning”, “Running”, and “Suspended”.

class azure.mgmt.compute.v2024_07_01.models.PatchAssessmentState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Describes the availability of a given patch.

AVAILABLE = 'Available'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.PatchInstallationDetail(**kwargs: Any)[source]¶

Bases: Model

Information about a specific patch that was encountered during an installation action.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

patch_id (str) – A unique identifier for the patch.
name (str) – The friendly name of the patch.
version (str) – The version string of the package. It may conform to Semantic Versioning. Only applies to Linux.
kb_id (str) – The KBID of the patch. Only applies to Windows patches.
classifications (list[str]) – The classification(s) of the patch as provided by the patch publisher.
installation_state (str or PatchInstallationState) – The state of the patch after the installation operation completed. Known values are: “Unknown”, “Installed”, “Failed”, “Excluded”, “NotSelected”, and “Pending”.

class azure.mgmt.compute.v2024_07_01.models.PatchInstallationState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The state of the patch after the installation operation completed.

EXCLUDED = 'Excluded'¶

FAILED = 'Failed'¶

INSTALLED = 'Installed'¶

NOT_SELECTED = 'NotSelected'¶

PENDING = 'Pending'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.PatchOperationStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

COMPLETED_WITH_WARNINGS = 'CompletedWithWarnings'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

SUCCEEDED = 'Succeeded'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.PatchSettings(*, patch_mode: str | _models.WindowsVMGuestPatchMode | None = None, enable_hotpatching: bool | None = None, assessment_mode: str | _models.WindowsPatchAssessmentMode | None = None, automatic_by_platform_settings: _models.WindowsVMGuestPatchAutomaticByPlatformSettings | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies settings related to VM Guest Patching on Windows.

Variables:

patch_mode (str or WindowsVMGuestPatchMode) – 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. Known values are: “Manual”, “AutomaticByOS”, and “AutomaticByPlatform”.
enable_hotpatching (bool) – 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’.
assessment_mode (str or WindowsPatchAssessmentMode) – 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. Known values are: “ImageDefault” and “AutomaticByPlatform”.
automatic_by_platform_settings (WindowsVMGuestPatchAutomaticByPlatformSettings) – Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

Keyword Arguments:

patch_mode (str or WindowsVMGuestPatchMode) – 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. Known values are: “Manual”, “AutomaticByOS”, and “AutomaticByPlatform”.
enable_hotpatching (bool) – 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’.
assessment_mode (str or WindowsPatchAssessmentMode) – 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. Known values are: “ImageDefault” and “AutomaticByPlatform”.
automatic_by_platform_settings (WindowsVMGuestPatchAutomaticByPlatformSettings) – Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

class azure.mgmt.compute.v2024_07_01.models.Plan(*, name: str | None = None, publisher: str | None = None, product: str | None = None, promotion_code: str | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

Variables:

name (str) – The plan ID.
publisher (str) – The publisher ID.
product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotion_code (str) – The promotion code.

Keyword Arguments:

name (str) – The plan ID.
publisher (str) – The publisher ID.
product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotion_code (str) – The promotion code.

class azure.mgmt.compute.v2024_07_01.models.PriorityMixPolicy(*, base_regular_priority_count: int | None = None, regular_priority_percentage_above_base: int | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached.

Variables:

base_regular_priority_count (int) – The base number of regular priority VMs that will be created in this scale set as it scales out.
regular_priority_percentage_above_base (int) – The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority.

Keyword Arguments:

base_regular_priority_count (int) – The base number of regular priority VMs that will be created in this scale set as it scales out.
regular_priority_percentage_above_base (int) – The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority.

class azure.mgmt.compute.v2024_07_01.models.ProtocolTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

HTTP = 'Http'¶

HTTPS = 'Https'¶

class azure.mgmt.compute.v2024_07_01.models.ProximityPlacementGroup(*, location: str, tags: Dict[str, str] | None = None, zones: List[str] | None = None, proximity_placement_group_type: str | _models.ProximityPlacementGroupType | None = None, colocation_status: _models.InstanceViewStatus | None = None, intent: _models.ProximityPlacementGroupPropertiesIntent | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the proximity placement group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
zones (list[str]) – Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
proximity_placement_group_type (str or ProximityPlacementGroupType) – Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use. Known values are: “Standard” and “Ultra”.
virtual_machines (list[SubResourceWithColocationStatus]) – A list of references to all virtual machines in the proximity placement group.
virtual_machine_scale_sets (list[SubResourceWithColocationStatus]) – A list of references to all virtual machine scale sets in the proximity placement group.
availability_sets (list[SubResourceWithColocationStatus]) – A list of references to all availability sets in the proximity placement group.
colocation_status (InstanceViewStatus) – Describes colocation status of the Proximity Placement Group.
intent (ProximityPlacementGroupPropertiesIntent) – Specifies the user intent of the proximity placement group.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
zones (list[str]) – Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created.
proximity_placement_group_type (str or ProximityPlacementGroupType) – Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use. Known values are: “Standard” and “Ultra”.
colocation_status (InstanceViewStatus) – Describes colocation status of the Proximity Placement Group.
intent (ProximityPlacementGroupPropertiesIntent) – Specifies the user intent of the proximity placement group.

class azure.mgmt.compute.v2024_07_01.models.ProximityPlacementGroupListResult(*, value: List[_models.ProximityPlacementGroup], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Proximity Placement Group operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[ProximityPlacementGroup]) – The list of proximity placement groups. Required.
next_link (str) – The URI to fetch the next page of proximity placement groups.

Keyword Arguments:

value (list[ProximityPlacementGroup]) – The list of proximity placement groups. Required.
next_link (str) – The URI to fetch the next page of proximity placement groups.

class azure.mgmt.compute.v2024_07_01.models.ProximityPlacementGroupPropertiesIntent(*, vm_sizes: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the user intent of the proximity placement group.

Variables:: vm_sizes (list[str]) – Specifies possible sizes of virtual machines that can be created in the proximity placement group.
Keyword Arguments:: vm_sizes (list[str]) – Specifies possible sizes of virtual machines that can be created in the proximity placement group.

class azure.mgmt.compute.v2024_07_01.models.ProximityPlacementGroupType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

STANDARD = 'Standard'¶

ULTRA = 'Ultra'¶

class azure.mgmt.compute.v2024_07_01.models.ProximityPlacementGroupUpdate(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the proximity placement group.

Variables:: tags (dict[str, str]) – Resource tags.
Keyword Arguments:: tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2024_07_01.models.ProxyAgentSettings(*, enabled: bool | None = None, mode: str | _models.Mode | None = None, key_incarnation_id: int | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Variables:

enabled (bool) – Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
mode (str or Mode) – Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. Known values are: “Audit” and “Enforce”.
key_incarnation_id (int) – Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.

Keyword Arguments:

enabled (bool) – Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
mode (str or Mode) – Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. Known values are: “Audit” and “Enforce”.
key_incarnation_id (int) – Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.

class azure.mgmt.compute.v2024_07_01.models.ProxyResource(**kwargs: Any)[source]¶

Bases: Model

The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.compute.v2024_07_01.models.PublicIPAddressSku(*, name: str | _models.PublicIPAddressSkuName | None = None, tier: str | _models.PublicIPAddressSkuTier | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

name (str or PublicIPAddressSkuName) – Specify public IP sku name. Known values are: “Basic” and “Standard”.
tier (str or PublicIPAddressSkuTier) – Specify public IP sku tier. Known values are: “Regional”, “Global”, and “Global”.

Keyword Arguments:

name (str or PublicIPAddressSkuName) – Specify public IP sku name. Known values are: “Basic” and “Standard”.
tier (str or PublicIPAddressSkuTier) – Specify public IP sku tier. Known values are: “Regional”, “Global”, and “Global”.

class azure.mgmt.compute.v2024_07_01.models.PublicIPAddressSkuName(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specify public IP sku name.

BASIC = 'Basic'¶

STANDARD = 'Standard'¶

class azure.mgmt.compute.v2024_07_01.models.PublicIPAddressSkuTier(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specify public IP sku tier.

GLOBAL = 'Global'¶

GLOBAL_ENUM = 'Global'¶

REGIONAL = 'Regional'¶

class azure.mgmt.compute.v2024_07_01.models.PublicIPAllocationMethod(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specify the public IP allocation type.

DYNAMIC = 'Dynamic'¶

STATIC = 'Static'¶

class azure.mgmt.compute.v2024_07_01.models.PurchasePlan(*, publisher: str, name: str, product: str, **kwargs: Any)[source]¶

Bases: Model

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

All required parameters must be populated in order to send to server.

Variables:

publisher (str) – The publisher ID. Required.
name (str) – The plan ID. Required.
product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. Required.

Keyword Arguments:

publisher (str) – The publisher ID. Required.
name (str) – The plan ID. Required.
product (str) – Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. Required.

class azure.mgmt.compute.v2024_07_01.models.RecoveryWalkResponse(**kwargs: Any)[source]¶

Bases: Model

Response after calling a manual recovery walk.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

walk_performed (bool) – Whether the recovery walk was performed.
next_platform_update_domain (int) – The next update domain that needs to be walked. Null means walk spanning all update domains has been completed.

class azure.mgmt.compute.v2024_07_01.models.RepairAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

REIMAGE = 'Reimage'¶

REPLACE = 'Replace'¶

RESTART = 'Restart'¶

class azure.mgmt.compute.v2024_07_01.models.RequestRateByIntervalInput(*, blob_container_sas_uri: str, from_time: datetime, to_time: datetime, interval_length: str | _models.IntervalInMins, group_by_throttle_policy: bool | None = None, group_by_operation_name: bool | None = None, group_by_resource_name: bool | None = None, group_by_client_application_id: bool | None = None, group_by_user_agent: bool | None = None, **kwargs: Any)[source]¶

Bases: LogAnalyticsInputBase

Api request input for LogAnalytics getRequestRateByInterval Api.

All required parameters must be populated in order to send to server.

Variables:

blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
group_by_client_application_id (bool) – Group query result by Client Application ID.
group_by_user_agent (bool) – Group query result by User Agent.
interval_length (str or IntervalInMins) – Interval value in minutes used to create LogAnalytics call rate logs. Required. Known values are: “ThreeMins”, “FiveMins”, “ThirtyMins”, and “SixtyMins”.

Keyword Arguments:

blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
group_by_client_application_id (bool) – Group query result by Client Application ID.
group_by_user_agent (bool) – Group query result by User Agent.
interval_length (str or IntervalInMins) – Interval value in minutes used to create LogAnalytics call rate logs. Required. Known values are: “ThreeMins”, “FiveMins”, “ThirtyMins”, and “SixtyMins”.

class azure.mgmt.compute.v2024_07_01.models.ResiliencyPolicy(*, resilient_vm_creation_policy: _models.ResilientVMCreationPolicy | None = None, resilient_vm_deletion_policy: _models.ResilientVMDeletionPolicy | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy.

Variables:

resilient_vm_creation_policy (ResilientVMCreationPolicy) – The configuration parameters used while performing resilient VM creation.
resilient_vm_deletion_policy (ResilientVMDeletionPolicy) – The configuration parameters used while performing resilient VM deletion.

Keyword Arguments:

resilient_vm_creation_policy (ResilientVMCreationPolicy) – The configuration parameters used while performing resilient VM creation.
resilient_vm_deletion_policy (ResilientVMDeletionPolicy) – The configuration parameters used while performing resilient VM deletion.

class azure.mgmt.compute.v2024_07_01.models.ResilientVMCreationPolicy(*, enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

The configuration parameters used while performing resilient VM creation.

Variables:: enabled (bool) – Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false.
Keyword Arguments:: enabled (bool) – Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false.

class azure.mgmt.compute.v2024_07_01.models.ResilientVMDeletionPolicy(*, enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

The configuration parameters used while performing resilient VM deletion.

Variables:: enabled (bool) – Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false.
Keyword Arguments:: enabled (bool) – Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false.

class azure.mgmt.compute.v2024_07_01.models.Resource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2024_07_01.models.ResourceIdOptionsForGetCapacityReservationGroups(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

ResourceIdOptionsForGetCapacityReservationGroups.

ALL = 'All'¶

CREATED_IN_SUBSCRIPTION = 'CreatedInSubscription'¶

SHARED_WITH_SUBSCRIPTION = 'SharedWithSubscription'¶

class azure.mgmt.compute.v2024_07_01.models.ResourceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.compute.v2024_07_01.models.ResourceSharingProfile(*, subscription_ids: List[_models.SubResource] | None = None, **kwargs: Any)[source]¶

Bases: Model

ResourceSharingProfile.

Variables:: subscription_ids (list[SubResource]) – Specifies an array of subscription resource IDs that capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.
Keyword Arguments:: subscription_ids (list[SubResource]) – Specifies an array of subscription resource IDs that capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

class azure.mgmt.compute.v2024_07_01.models.ResourceWithOptionalLocation(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The Resource model definition with location property as optional.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

location (str) – Resource location.
id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2024_07_01.models.RestorePoint(*, exclude_disks: List[_models.ApiEntityReference] | None = None, source_metadata: _models.RestorePointSourceMetadata | None = None, consistency_mode: str | _models.ConsistencyModeTypes | None = None, time_created: datetime | None = None, source_restore_point: _models.ApiEntityReference | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

Restore Point details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
exclude_disks (list[ApiEntityReference]) – List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
source_metadata (RestorePointSourceMetadata) – Gets the details of the VM captured at the time of the restore point creation.
provisioning_state (str) – Gets the provisioning state of the restore point.
consistency_mode (str or ConsistencyModeTypes) – ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. Known values are: “CrashConsistent”, “FileSystemConsistent”, and “ApplicationConsistent”.
time_created (datetime) – Gets the creation time of the restore point.
source_restore_point (ApiEntityReference) – Resource Id of the source restore point from which a copy needs to be created.
instance_view (RestorePointInstanceView) – The restore point instance view.

Keyword Arguments:

exclude_disks (list[ApiEntityReference]) – List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
source_metadata (RestorePointSourceMetadata) – Gets the details of the VM captured at the time of the restore point creation.
consistency_mode (str or ConsistencyModeTypes) – ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. Known values are: “CrashConsistent”, “FileSystemConsistent”, and “ApplicationConsistent”.
time_created (datetime) – Gets the creation time of the restore point.
source_restore_point (ApiEntityReference) – Resource Id of the source restore point from which a copy needs to be created.

class azure.mgmt.compute.v2024_07_01.models.RestorePointCollection(*, location: str, tags: Dict[str, str] | None = None, source: _models.RestorePointCollectionSourceProperties | None = None, **kwargs: Any)[source]¶

Bases: Resource

Create or update Restore Point collection parameters.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
source (RestorePointCollectionSourceProperties) – The properties of the source resource that this restore point collection is created from.
provisioning_state (str) – The provisioning state of the restore point collection.
restore_point_collection_id (str) – The unique id of the restore point collection.
restore_points (list[RestorePoint]) – A list containing all restore points created under this restore point collection.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
source (RestorePointCollectionSourceProperties) – The properties of the source resource that this restore point collection is created from.

class azure.mgmt.compute.v2024_07_01.models.RestorePointCollectionExpandOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

RestorePointCollectionExpandOptions.

RESTORE_POINTS = 'restorePoints'¶

class azure.mgmt.compute.v2024_07_01.models.RestorePointCollectionListResult(*, value: List[_models.RestorePointCollection] | None = None, next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List restore point collection operation response.

Variables:

value (list[RestorePointCollection]) – Gets the list of restore point collections.
next_link (str) – The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections.

Keyword Arguments:

value (list[RestorePointCollection]) – Gets the list of restore point collections.
next_link (str) – The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections.

class azure.mgmt.compute.v2024_07_01.models.RestorePointCollectionSourceProperties(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The properties of the source resource that this restore point collection is created from.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

location (str) – Location of the source resource used to create this restore point collection.
id (str) – Resource Id of the source resource used to create this restore point collection.

Keyword Arguments:

id (str) – Resource Id of the source resource used to create this restore point collection.

class azure.mgmt.compute.v2024_07_01.models.RestorePointCollectionUpdate(*, tags: Dict[str, str] | None = None, source: _models.RestorePointCollectionSourceProperties | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Update Restore Point collection parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
source (RestorePointCollectionSourceProperties) – The properties of the source resource that this restore point collection is created from.
provisioning_state (str) – The provisioning state of the restore point collection.
restore_point_collection_id (str) – The unique id of the restore point collection.
restore_points (list[RestorePoint]) – A list containing all restore points created under this restore point collection.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
source (RestorePointCollectionSourceProperties) – The properties of the source resource that this restore point collection is created from.

class azure.mgmt.compute.v2024_07_01.models.RestorePointEncryption(*, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, type: str | _models.RestorePointEncryptionType | None = None, **kwargs: Any)[source]¶

Bases: Model

Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.

Variables:

disk_encryption_set (DiskEncryptionSetParameters) – Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.
type (str or RestorePointEncryptionType) – The type of key used to encrypt the data of the disk restore point. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.

Keyword Arguments:

disk_encryption_set (DiskEncryptionSetParameters) – Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.
type (str or RestorePointEncryptionType) – The type of key used to encrypt the data of the disk restore point. Known values are: “EncryptionAtRestWithPlatformKey”, “EncryptionAtRestWithCustomerKey”, and “EncryptionAtRestWithPlatformAndCustomerKeys”.

class azure.mgmt.compute.v2024_07_01.models.RestorePointEncryptionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of key used to encrypt the data of the disk restore point.

ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY = 'EncryptionAtRestWithCustomerKey'¶: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer.

ENCRYPTION_AT_REST_WITH_PLATFORM_AND_CUSTOMER_KEYS = 'EncryptionAtRestWithPlatformAndCustomerKeys'¶: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.

ENCRYPTION_AT_REST_WITH_PLATFORM_KEY = 'EncryptionAtRestWithPlatformKey'¶: Disk Restore Point is encrypted at rest with Platform managed key.

class azure.mgmt.compute.v2024_07_01.models.RestorePointExpandOptions(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

RestorePointExpandOptions.

INSTANCE_VIEW = 'instanceView'¶

class azure.mgmt.compute.v2024_07_01.models.RestorePointInstanceView(*, disk_restore_points: List[_models.DiskRestorePointInstanceView] | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a restore point.

Variables:

disk_restore_points (list[DiskRestorePointInstanceView]) – The disk restore points information.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

disk_restore_points (list[DiskRestorePointInstanceView]) – The disk restore points information.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.RestorePointSourceMetadata(*, storage_profile: _models.RestorePointSourceVMStorageProfile | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

hardware_profile (HardwareProfile) – Gets the hardware profile.
storage_profile (RestorePointSourceVMStorageProfile) – Gets the storage profile.
os_profile (OSProfile) – Gets the OS profile.
diagnostics_profile (DiagnosticsProfile) – Gets the diagnostics profile.
license_type (str) – Gets the license type, which is for bring your own license scenario.
vm_id (str) – Gets the virtual machine unique id.
security_profile (SecurityProfile) – Gets the security profile.
location (str) – Location of the VM from which the restore point was created.
user_data (str) – UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value.
hyper_v_generation (str or HyperVGenerationTypes) – HyperVGeneration of the source VM for which restore point is captured. Known values are: “V1” and “V2”.

Keyword Arguments:

storage_profile (RestorePointSourceVMStorageProfile) – Gets the storage profile.

class azure.mgmt.compute.v2024_07_01.models.RestorePointSourceVMDataDisk(*, managed_disk: _models.ManagedDiskParameters | None = None, disk_restore_point: _models.DiskRestorePointAttributes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a data disk.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

lun (int) – Gets the logical unit number.
name (str) – Gets the disk name.
caching (str or CachingTypes) – Gets the caching type. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks.
managed_disk (ManagedDiskParameters) – Contains the managed disk details.
disk_restore_point (DiskRestorePointAttributes) – Contains Disk Restore Point properties.
write_accelerator_enabled (bool) – Shows true if the disk is write-accelerator enabled.

Keyword Arguments:

managed_disk (ManagedDiskParameters) – Contains the managed disk details.
disk_restore_point (DiskRestorePointAttributes) – Contains Disk Restore Point properties.

class azure.mgmt.compute.v2024_07_01.models.RestorePointSourceVMOSDisk(*, managed_disk: _models.ManagedDiskParameters | None = None, disk_restore_point: _models.DiskRestorePointAttributes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes an Operating System disk.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

os_type (str or OperatingSystemType) – Gets the Operating System type. Known values are: “Windows” and “Linux”.
encryption_settings (DiskEncryptionSettings) – Gets the disk encryption settings.
name (str) – Gets the disk name.
caching (str or CachingTypes) – Gets the caching type. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
disk_size_gb (int) – Gets the disk size in GB.
managed_disk (ManagedDiskParameters) – Gets the managed disk details.
disk_restore_point (DiskRestorePointAttributes) – Contains Disk Restore Point properties.
write_accelerator_enabled (bool) – Shows true if the disk is write-accelerator enabled.

Keyword Arguments:

managed_disk (ManagedDiskParameters) – Gets the managed disk details.
disk_restore_point (DiskRestorePointAttributes) – Contains Disk Restore Point properties.

class azure.mgmt.compute.v2024_07_01.models.RestorePointSourceVMStorageProfile(*, os_disk: _models.RestorePointSourceVMOSDisk | None = None, data_disks: List[_models.RestorePointSourceVMDataDisk] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the storage profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

os_disk (RestorePointSourceVMOSDisk) – Gets the OS disk of the VM captured at the time of the restore point creation.
data_disks (list[RestorePointSourceVMDataDisk]) – Gets the data disks of the VM captured at the time of the restore point creation.
disk_controller_type (str or DiskControllerTypes) – Gets the disk controller type of the VM captured at the time of the restore point creation. Known values are: “SCSI” and “NVMe”.

Keyword Arguments:

os_disk (RestorePointSourceVMOSDisk) – Gets the OS disk of the VM captured at the time of the restore point creation.
data_disks (list[RestorePointSourceVMDataDisk]) – Gets the data disks of the VM captured at the time of the restore point creation.

class azure.mgmt.compute.v2024_07_01.models.RetrieveBootDiagnosticsDataResult(**kwargs: Any)[source]¶

Bases: Model

The SAS URIs of the console screenshot and serial log blobs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

console_screenshot_blob_uri (str) – The console screenshot blob URI.
serial_console_log_blob_uri (str) – The serial console log blob URI.

class azure.mgmt.compute.v2024_07_01.models.RollbackStatusInfo(**kwargs: Any)[source]¶

Bases: Model

Information about rollback on failed VM instances after a OS Upgrade operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

successfully_rolledback_instance_count (int) – The number of instances which have been successfully rolled back.
failed_rolledback_instance_count (int) – The number of instances which failed to rollback.
rollback_error (ApiError) – Error details if OS rollback failed.

class azure.mgmt.compute.v2024_07_01.models.RollingUpgradeActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The last action performed on the rolling upgrade.

CANCEL = 'Cancel'¶

START = 'Start'¶

class azure.mgmt.compute.v2024_07_01.models.RollingUpgradePolicy(*, max_batch_instance_percent: int | None = None, max_unhealthy_instance_percent: int | None = None, max_unhealthy_upgraded_instance_percent: int | None = None, pause_time_between_batches: str | None = None, enable_cross_zone_upgrade: bool | None = None, prioritize_unhealthy_instances: bool | None = None, rollback_failed_instances_on_policy_breach: bool | None = None, max_surge: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

The configuration parameters used while performing a rolling upgrade.

Variables:

max_batch_instance_percent (int) – 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%.
max_unhealthy_instance_percent (int) – 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%.
max_unhealthy_upgraded_instance_percent (int) – 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%.
pause_time_between_batches (str) – 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).
enable_cross_zone_upgrade (bool) – Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
prioritize_unhealthy_instances (bool) – Upgrade all unhealthy instances in a scale set before any healthy instances.
rollback_failed_instances_on_policy_breach (bool) – Rollback failed instances to previous model if the Rolling Upgrade policy is violated.
max_surge (bool) – Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch.

Keyword Arguments:

max_batch_instance_percent (int) – 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%.
max_unhealthy_instance_percent (int) – 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%.
max_unhealthy_upgraded_instance_percent (int) – 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%.
pause_time_between_batches (str) – 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).
enable_cross_zone_upgrade (bool) – Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
prioritize_unhealthy_instances (bool) – Upgrade all unhealthy instances in a scale set before any healthy instances.
rollback_failed_instances_on_policy_breach (bool) – Rollback failed instances to previous model if the Rolling Upgrade policy is violated.
max_surge (bool) – Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch.

class azure.mgmt.compute.v2024_07_01.models.RollingUpgradeProgressInfo(**kwargs: Any)[source]¶

Bases: Model

Information about the number of virtual machine instances in each upgrade state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

successful_instance_count (int) – The number of instances that have been successfully upgraded.
failed_instance_count (int) – The number of instances that have failed to be upgraded successfully.
in_progress_instance_count (int) – The number of instances that are currently being upgraded.
pending_instance_count (int) – The number of instances that have not yet begun to be upgraded.

class azure.mgmt.compute.v2024_07_01.models.RollingUpgradeRunningStatus(**kwargs: Any)[source]¶

Bases: Model

Information about the current running state of the overall upgrade.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str or RollingUpgradeStatusCode) – Code indicating the current status of the upgrade. Known values are: “RollingForward”, “Cancelled”, “Completed”, and “Faulted”.
start_time (datetime) – Start time of the upgrade.
last_action (str or RollingUpgradeActionType) – The last action performed on the rolling upgrade. Known values are: “Start” and “Cancel”.
last_action_time (datetime) – Last action time of the upgrade.

class azure.mgmt.compute.v2024_07_01.models.RollingUpgradeStatusCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Code indicating the current status of the upgrade.

CANCELLED = 'Cancelled'¶

COMPLETED = 'Completed'¶

FAULTED = 'Faulted'¶

ROLLING_FORWARD = 'RollingForward'¶

class azure.mgmt.compute.v2024_07_01.models.RollingUpgradeStatusInfo(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Resource

The status of the latest virtual machine scale set rolling upgrade.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
policy (RollingUpgradePolicy) – The rolling upgrade policies applied for this upgrade.
running_status (RollingUpgradeRunningStatus) – Information about the current running state of the overall upgrade.
progress (RollingUpgradeProgressInfo) – Information about the number of virtual machine instances in each upgrade state.
error (ApiError) – Error details for this upgrade, if there are any.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2024_07_01.models.RunCommandDocument(*, schema: str, id: str, os_type: str | _models.OperatingSystemTypes, label: str, description: str, script: List[str], parameters: List[_models.RunCommandParameterDefinition] | None = None, **kwargs: Any)[source]¶

Bases: RunCommandDocumentBase

Describes the properties of a Run Command.

All required parameters must be populated in order to send to server.

Variables:

schema (str) – The VM run command schema. Required.
id (str) – The VM run command id. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.
script (list[str]) – The script to be executed. Required.
parameters (list[RunCommandParameterDefinition]) – The parameters used by the script.

Keyword Arguments:

schema (str) – The VM run command schema. Required.
id (str) – The VM run command id. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.
script (list[str]) – The script to be executed. Required.
parameters (list[RunCommandParameterDefinition]) – The parameters used by the script.

class azure.mgmt.compute.v2024_07_01.models.RunCommandDocumentBase(*, schema: str, id: str, os_type: str | _models.OperatingSystemTypes, label: str, description: str, **kwargs: Any)[source]¶

Bases: Model

Describes the properties of a Run Command metadata.

All required parameters must be populated in order to send to server.

Variables:

schema (str) – The VM run command schema. Required.
id (str) – The VM run command id. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.

Keyword Arguments:

schema (str) – The VM run command schema. Required.
id (str) – The VM run command id. Required.
os_type (str or OperatingSystemTypes) – The Operating System type. Required. Known values are: “Windows” and “Linux”.
label (str) – The VM run command label. Required.
description (str) – The VM run command description. Required.

class azure.mgmt.compute.v2024_07_01.models.RunCommandInput(*, command_id: str, script: List[str] | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, **kwargs: Any)[source]¶

Bases: Model

Capture Virtual Machine parameters.

All required parameters must be populated in order to send to server.

Variables:

command_id (str) – The run command id. Required.
script (list[str]) – Optional. The script to be executed. When this value is given, the given script will override the default script of the command.
parameters (list[RunCommandInputParameter]) – The run command parameters.

Keyword Arguments:

command_id (str) – The run command id. Required.
script (list[str]) – Optional. The script to be executed. When this value is given, the given script will override the default script of the command.
parameters (list[RunCommandInputParameter]) – The run command parameters.

class azure.mgmt.compute.v2024_07_01.models.RunCommandInputParameter(*, name: str, value: str, **kwargs: Any)[source]¶

Bases: Model

Describes the properties of a run command parameter.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The run command parameter name. Required.
value (str) – The run command parameter value. Required.

Keyword Arguments:

name (str) – The run command parameter name. Required.
value (str) – The run command parameter value. Required.

class azure.mgmt.compute.v2024_07_01.models.RunCommandListResult(*, value: List[_models.RunCommandDocumentBase], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Virtual Machine operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[RunCommandDocumentBase]) – The list of virtual machine run commands. Required.
next_link (str) – The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands.

Keyword Arguments:

value (list[RunCommandDocumentBase]) – The list of virtual machine run commands. Required.
next_link (str) – The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands.

class azure.mgmt.compute.v2024_07_01.models.RunCommandManagedIdentity(*, client_id: str | None = None, object_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob’s container with ‘Storage Blob Data Reader’ role assignment with scriptUri blob and ‘Storage Blob Data Contributor’ for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Variables:

client_id (str) – Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided.
object_id (str) – Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided.

Keyword Arguments:

client_id (str) – Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided.
object_id (str) – Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided.

class azure.mgmt.compute.v2024_07_01.models.RunCommandParameterDefinition(*, name: str, type: str, default_value: str | None = None, required: bool = False, **kwargs: Any)[source]¶

Bases: Model

Describes the properties of a run command parameter.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The run command parameter name. Required.
type (str) – The run command parameter type. Required.
default_value (str) – The run command parameter default value.
required (bool) – The run command parameter required.

Keyword Arguments:

name (str) – The run command parameter name. Required.
type (str) – The run command parameter type. Required.
default_value (str) – The run command parameter default value.
required (bool) – The run command parameter required.

class azure.mgmt.compute.v2024_07_01.models.RunCommandResult(*, value: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

RunCommandResult.

Variables:: value (list[InstanceViewStatus]) – Run command operation response.
Keyword Arguments:: value (list[InstanceViewStatus]) – Run command operation response.

class azure.mgmt.compute.v2024_07_01.models.ScaleInPolicy(*, rules: List[str | _models.VirtualMachineScaleSetScaleInRules] | None = None, force_deletion: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

rules (list[str or VirtualMachineScaleSetScaleInRules]) – 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.  .
force_deletion (bool) – 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).

Keyword Arguments:

rules (list[str or VirtualMachineScaleSetScaleInRules]) – 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.  .
force_deletion (bool) – 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).

class azure.mgmt.compute.v2024_07_01.models.ScheduledEventsAdditionalPublishingTargets(*, event_grid_and_resource_graph: _models.EventGridAndResourceGraph | None = None, **kwargs: Any)[source]¶

Bases: Model

ScheduledEventsAdditionalPublishingTargets.

Variables:: event_grid_and_resource_graph (EventGridAndResourceGraph) – The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
Keyword Arguments:: event_grid_and_resource_graph (EventGridAndResourceGraph) – The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.

class azure.mgmt.compute.v2024_07_01.models.ScheduledEventsPolicy(*, user_initiated_redeploy: _models.UserInitiatedRedeploy | None = None, user_initiated_reboot: _models.UserInitiatedReboot | None = None, scheduled_events_additional_publishing_targets: _models.ScheduledEventsAdditionalPublishingTargets | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.

Variables:

user_initiated_redeploy (UserInitiatedRedeploy) – The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
user_initiated_reboot (UserInitiatedReboot) – The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
scheduled_events_additional_publishing_targets (ScheduledEventsAdditionalPublishingTargets) – The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.

Keyword Arguments:

user_initiated_redeploy (UserInitiatedRedeploy) – The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
user_initiated_reboot (UserInitiatedReboot) – The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
scheduled_events_additional_publishing_targets (ScheduledEventsAdditionalPublishingTargets) – The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.

class azure.mgmt.compute.v2024_07_01.models.ScheduledEventsProfile(*, terminate_notification_profile: _models.TerminateNotificationProfile | None = None, os_image_notification_profile: _models.OSImageNotificationProfile | None = None, **kwargs: Any)[source]¶

Bases: Model

ScheduledEventsProfile.

Variables:

terminate_notification_profile (TerminateNotificationProfile) – Specifies Terminate Scheduled Event related configurations.
os_image_notification_profile (OSImageNotificationProfile) – Specifies OS Image Scheduled Event related configurations.

Keyword Arguments:

terminate_notification_profile (TerminateNotificationProfile) – Specifies Terminate Scheduled Event related configurations.
os_image_notification_profile (OSImageNotificationProfile) – Specifies OS Image Scheduled Event related configurations.

class azure.mgmt.compute.v2024_07_01.models.SecurityEncryptionTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.

DISK_WITH_VM_GUEST_STATE = 'DiskWithVMGuestState'¶

NON_PERSISTED_TPM = 'NonPersistedTPM'¶

VM_GUEST_STATE_ONLY = 'VMGuestStateOnly'¶

class azure.mgmt.compute.v2024_07_01.models.SecurityPostureReference(*, id: str, exclude_extensions: List[str] | None = None, is_overridable: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01.

All required parameters must be populated in order to send to server.

Variables:

id (str) – The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest. # pylint: disable=line-too-long Required.
exclude_extensions (list[str]) – The list of virtual machine extension names to exclude when applying the security posture.
is_overridable (bool) – Whether the security posture can be overridden by the user.

Keyword Arguments:

id (str) – The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest. # pylint: disable=line-too-long Required.
exclude_extensions (list[str]) – The list of virtual machine extension names to exclude when applying the security posture.
is_overridable (bool) – Whether the security posture can be overridden by the user.

class azure.mgmt.compute.v2024_07_01.models.SecurityPostureReferenceUpdate(*, id: str | None = None, exclude_extensions: List[str] | None = None, is_overridable: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01.

Variables:

id (str) – The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest. # pylint: disable=line-too-long
exclude_extensions (list[str]) – The list of virtual machine extension names to exclude when applying the security posture.
is_overridable (bool) – Whether the security posture can be overridden by the user.

Keyword Arguments:

id (str) – The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest. # pylint: disable=line-too-long
exclude_extensions (list[str]) – The list of virtual machine extension names to exclude when applying the security posture.
is_overridable (bool) – Whether the security posture can be overridden by the user.

class azure.mgmt.compute.v2024_07_01.models.SecurityProfile(*, uefi_settings: _models.UefiSettings | None = None, encryption_at_host: bool | None = None, security_type: str | _models.SecurityTypes | None = None, encryption_identity: _models.EncryptionIdentity | None = None, proxy_agent_settings: _models.ProxyAgentSettings | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

uefi_settings (UefiSettings) – Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
encryption_at_host (bool) – 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. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
security_type (str or SecurityTypes) – Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. Known values are: “TrustedLaunch” and “ConfidentialVM”.
encryption_identity (EncryptionIdentity) – Specifies the Managed Identity used by ADE to get access token for keyvault operations.
proxy_agent_settings (ProxyAgentSettings) – Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Keyword Arguments:

uefi_settings (UefiSettings) – Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
encryption_at_host (bool) – 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. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
security_type (str or SecurityTypes) – Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. Known values are: “TrustedLaunch” and “ConfidentialVM”.
encryption_identity (EncryptionIdentity) – Specifies the Managed Identity used by ADE to get access token for keyvault operations.
proxy_agent_settings (ProxyAgentSettings) – Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

class azure.mgmt.compute.v2024_07_01.models.SecurityTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

CONFIDENTIAL_VM = 'ConfidentialVM'¶

TRUSTED_LAUNCH = 'TrustedLaunch'¶

class azure.mgmt.compute.v2024_07_01.models.ServiceArtifactReference(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using ‘latest’ image version. Minimum api-version: 2022-11-01.

Variables:: id (str) – The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}. # pylint: disable=line-too-long
Keyword Arguments:: id (str) – The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}. # pylint: disable=line-too-long

class azure.mgmt.compute.v2024_07_01.models.SettingNames(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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

AUTO_LOGON = 'AutoLogon'¶

FIRST_LOGON_COMMANDS = 'FirstLogonCommands'¶

class azure.mgmt.compute.v2024_07_01.models.Sku(*, name: str | None = None, tier: str | None = None, capacity: int | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

Variables:

name (str) – The sku name.
tier (str) – Specifies the tier of virtual machines in a scale set.  Possible Values:  Standard  Basic.
capacity (int) – Specifies the number of virtual machines in the scale set.

Keyword Arguments:

name (str) – The sku name.
tier (str) – Specifies the tier of virtual machines in a scale set.  Possible Values:  Standard  Basic.
capacity (int) – Specifies the number of virtual machines in the scale set.

class azure.mgmt.compute.v2024_07_01.models.SkuProfile(*, vm_sizes: List[_models.SkuProfileVMSize] | None = None, allocation_strategy: str | _models.AllocationStrategy | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy.

Variables:

vm_sizes (list[SkuProfileVMSize]) – Specifies the VM sizes for the virtual machine scale set.
allocation_strategy (str or AllocationStrategy) – Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Known values are: “LowestPrice” and “CapacityOptimized”.

Keyword Arguments:

vm_sizes (list[SkuProfileVMSize]) – Specifies the VM sizes for the virtual machine scale set.
allocation_strategy (str or AllocationStrategy) – Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. Known values are: “LowestPrice” and “CapacityOptimized”.

class azure.mgmt.compute.v2024_07_01.models.SkuProfileVMSize(*, name: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the VM Size.

Variables:: name (str) – Specifies the name of the VM Size.
Keyword Arguments:: name (str) – Specifies the name of the VM Size.

class azure.mgmt.compute.v2024_07_01.models.SpotRestorePolicy(*, enabled: bool | None = None, restore_timeout: str | None = None, **kwargs: Any)[source]¶

Bases: Model

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.

Variables:

enabled (bool) – 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.
restore_timeout (str) – Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances.

Keyword Arguments:

enabled (bool) – 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.
restore_timeout (str) – Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances.

class azure.mgmt.compute.v2024_07_01.models.SshConfiguration(*, public_keys: List[_models.SshPublicKey] | None = None, **kwargs: Any)[source]¶

Bases: Model

SSH configuration for Linux based VMs running on Azure.

Variables:: public_keys (list[SshPublicKey]) – The list of SSH public keys used to authenticate with linux based VMs.
Keyword Arguments:: public_keys (list[SshPublicKey]) – The list of SSH public keys used to authenticate with linux based VMs.

class azure.mgmt.compute.v2024_07_01.models.SshEncryptionTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA.

ED25519 = 'Ed25519'¶

RSA = 'RSA'¶

class azure.mgmt.compute.v2024_07_01.models.SshGenerateKeyPairInputParameters(*, encryption_type: str | _models.SshEncryptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Parameters for GenerateSshKeyPair.

Variables:: encryption_type (str or SshEncryptionTypes) – The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA. Known values are: “RSA” and “Ed25519”.
Keyword Arguments:: encryption_type (str or SshEncryptionTypes) – The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA. Known values are: “RSA” and “Ed25519”.

class azure.mgmt.compute.v2024_07_01.models.SshPublicKey(*, path: str | None = None, key_data: str | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

path (str) – 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.
key_data (str) – 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).

Keyword Arguments:

path (str) – 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.
key_data (str) – 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).

class azure.mgmt.compute.v2024_07_01.models.SshPublicKeyGenerateKeyPairResult(*, private_key: str, public_key: str, id: str, **kwargs: Any)[source]¶

Bases: Model

Response from generation of an SSH key pair.

All required parameters must be populated in order to send to server.

Variables:

private_key (str) – Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret. Required.
public_key (str) – Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format. Required.
id (str) – The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}. # pylint: disable=line-too-long Required.

Keyword Arguments:

private_key (str) – Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret. Required.
public_key (str) – Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format. Required.
id (str) – The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}. # pylint: disable=line-too-long Required.

class azure.mgmt.compute.v2024_07_01.models.SshPublicKeyResource(*, location: str, tags: Dict[str, str] | None = None, public_key: str | None = None, **kwargs: Any)[source]¶

Bases: Resource

Specifies information about the SSH public key.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
public_key (str) – SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
public_key (str) – SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.

class azure.mgmt.compute.v2024_07_01.models.SshPublicKeyUpdateResource(*, tags: Dict[str, str] | None = None, public_key: str | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Specifies information about the SSH public key.

Variables:

tags (dict[str, str]) – Resource tags.
public_key (str) – SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
public_key (str) – SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.

class azure.mgmt.compute.v2024_07_01.models.SshPublicKeysGroupListResult(*, value: List[_models.SshPublicKeyResource], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The list SSH public keys operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[SshPublicKeyResource]) – The list of SSH public keys. Required.
next_link (str) – The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys.

Keyword Arguments:

value (list[SshPublicKeyResource]) – The list of SSH public keys. Required.
next_link (str) – The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys.

class azure.mgmt.compute.v2024_07_01.models.StatusLevelTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The level code.

ERROR = 'Error'¶

INFO = 'Info'¶

WARNING = 'Warning'¶

class azure.mgmt.compute.v2024_07_01.models.StorageAccountTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

PREMIUM_LRS = 'Premium_LRS'¶

PREMIUM_V2_LRS = 'PremiumV2_LRS'¶

PREMIUM_ZRS = 'Premium_ZRS'¶

STANDARD_LRS = 'Standard_LRS'¶

STANDARD_SSD_LRS = 'StandardSSD_LRS'¶

STANDARD_SSD_ZRS = 'StandardSSD_ZRS'¶

ULTRA_SSD_LRS = 'UltraSSD_LRS'¶

class azure.mgmt.compute.v2024_07_01.models.StorageProfile(*, image_reference: _models.ImageReference | None = None, os_disk: _models.OSDisk | None = None, data_disks: List[_models.DataDisk] | None = None, disk_controller_type: str | _models.DiskControllerTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the storage settings for the virtual machine disks.

Variables:

image_reference (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.
os_disk (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.
data_disks (list[DataDisk]) –
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.
disk_controller_type (str or DiskControllerTypes) – Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with ‘hyperVGeneration’ set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. Known values are: “SCSI” and “NVMe”.

Keyword Arguments:

image_reference (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.
os_disk (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.
data_disks (list[DataDisk]) –
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.
disk_controller_type (str or DiskControllerTypes) – Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with ‘hyperVGeneration’ set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. Known values are: “SCSI” and “NVMe”.

class azure.mgmt.compute.v2024_07_01.models.SubResource(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

SubResource.

Variables:: id (str) – Resource Id.
Keyword Arguments:: id (str) – Resource Id.

class azure.mgmt.compute.v2024_07_01.models.SubResourceReadOnly(**kwargs: Any)[source]¶

Bases: Model

SubResourceReadOnly.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: id (str) – Resource Id.

class azure.mgmt.compute.v2024_07_01.models.SubResourceWithColocationStatus(*, id: str | None = None, colocation_status: _models.InstanceViewStatus | None = None, **kwargs: Any)[source]¶

Bases: SubResource

SubResourceWithColocationStatus.

Variables:

id (str) – Resource Id.
colocation_status (InstanceViewStatus) – Describes colocation status of a resource in the Proximity Placement Group.

Keyword Arguments:

id (str) – Resource Id.
colocation_status (InstanceViewStatus) – Describes colocation status of a resource in the Proximity Placement Group.

class azure.mgmt.compute.v2024_07_01.models.SystemData(**kwargs: Any)[source]¶

Bases: Model

The system meta data relating to this resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

created_at (datetime) – Specifies the time in UTC at which the Cloud Service (extended support) resource was created. :code:` `Minimum api-version: 2022-04-04.
last_modified_at (datetime) – Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. :code:` `Minimum api-version: 2022-04-04.

class azure.mgmt.compute.v2024_07_01.models.TerminateNotificationProfile(*, not_before_timeout: str | None = None, enable: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

TerminateNotificationProfile.

Variables:

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

Keyword Arguments:

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

class azure.mgmt.compute.v2024_07_01.models.ThrottledRequestsInput(*, blob_container_sas_uri: str, from_time: datetime, to_time: datetime, group_by_throttle_policy: bool | None = None, group_by_operation_name: bool | None = None, group_by_resource_name: bool | None = None, group_by_client_application_id: bool | None = None, group_by_user_agent: bool | None = None, **kwargs: Any)[source]¶

Bases: LogAnalyticsInputBase

Api request input for LogAnalytics getThrottledRequests Api.

All required parameters must be populated in order to send to server.

Variables:

blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
group_by_client_application_id (bool) – Group query result by Client Application ID.
group_by_user_agent (bool) – Group query result by User Agent.

Keyword Arguments:

blob_container_sas_uri (str) – SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. Required.
from_time (datetime) – From time of the query. Required.
to_time (datetime) – To time of the query. Required.
group_by_throttle_policy (bool) – Group query result by Throttle Policy applied.
group_by_operation_name (bool) – Group query result by Operation Name.
group_by_resource_name (bool) – Group query result by Resource Name.
group_by_client_application_id (bool) – Group query result by Client Application ID.
group_by_user_agent (bool) – Group query result by User Agent.

class azure.mgmt.compute.v2024_07_01.models.UefiSettings(*, secure_boot_enabled: bool | None = None, v_tpm_enabled: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

secure_boot_enabled (bool) – Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
v_tpm_enabled (bool) – Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.

Keyword Arguments:

secure_boot_enabled (bool) – Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
v_tpm_enabled (bool) – Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.

class azure.mgmt.compute.v2024_07_01.models.UpdateResource(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]¶

Bases: Model

The Update Resource model definition.

Variables:: tags (dict[str, str]) – Resource tags.
Keyword Arguments:: tags (dict[str, str]) – Resource tags.

class azure.mgmt.compute.v2024_07_01.models.UpgradeMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

AUTOMATIC = 'Automatic'¶

MANUAL = 'Manual'¶

ROLLING = 'Rolling'¶

class azure.mgmt.compute.v2024_07_01.models.UpgradeOperationHistoricalStatusInfo(**kwargs: Any)[source]¶

Bases: Model

Virtual Machine Scale Set OS Upgrade History operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

properties (UpgradeOperationHistoricalStatusInfoProperties) – Information about the properties of the upgrade operation.
type (str) – Resource type.
location (str) – Resource location.

class azure.mgmt.compute.v2024_07_01.models.UpgradeOperationHistoricalStatusInfoProperties(**kwargs: Any)[source]¶

Bases: Model

Describes each OS upgrade on the Virtual Machine Scale Set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

running_status (UpgradeOperationHistoryStatus) – Information about the overall status of the upgrade operation.
progress (RollingUpgradeProgressInfo) – Counts of the VMs in each state.
error (ApiError) – Error Details for this upgrade if there are any.
started_by (str or UpgradeOperationInvoker) – Invoker of the Upgrade Operation. Known values are: “Unknown”, “User”, and “Platform”.
target_image_reference (ImageReference) – Image Reference details.
rollback_info (RollbackStatusInfo) – Information about OS rollback if performed.

class azure.mgmt.compute.v2024_07_01.models.UpgradeOperationHistoryStatus(**kwargs: Any)[source]¶

Bases: Model

Information about the current running state of the overall upgrade.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str or UpgradeState) – Code indicating the current status of the upgrade. Known values are: “RollingForward”, “Cancelled”, “Completed”, and “Faulted”.
start_time (datetime) – Start time of the upgrade.
end_time (datetime) – End time of the upgrade.

class azure.mgmt.compute.v2024_07_01.models.UpgradeOperationInvoker(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Invoker of the Upgrade Operation.

PLATFORM = 'Platform'¶

UNKNOWN = 'Unknown'¶

USER = 'User'¶

class azure.mgmt.compute.v2024_07_01.models.UpgradePolicy(*, mode: str | _models.UpgradeMode | None = None, rolling_upgrade_policy: _models.RollingUpgradePolicy | None = None, automatic_os_upgrade_policy: _models.AutomaticOSUpgradePolicy | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

mode (str or UpgradeMode) – 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. Known values are: “Automatic”, “Manual”, and “Rolling”.
rolling_upgrade_policy (RollingUpgradePolicy) – The configuration parameters used while performing a rolling upgrade.
automatic_os_upgrade_policy (AutomaticOSUpgradePolicy) – Configuration parameters used for performing automatic OS Upgrade.

Keyword Arguments:

mode (str or UpgradeMode) – 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. Known values are: “Automatic”, “Manual”, and “Rolling”.
rolling_upgrade_policy (RollingUpgradePolicy) – The configuration parameters used while performing a rolling upgrade.
automatic_os_upgrade_policy (AutomaticOSUpgradePolicy) – Configuration parameters used for performing automatic OS Upgrade.

class azure.mgmt.compute.v2024_07_01.models.UpgradeState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Code indicating the current status of the upgrade.

CANCELLED = 'Cancelled'¶

COMPLETED = 'Completed'¶

FAULTED = 'Faulted'¶

ROLLING_FORWARD = 'RollingForward'¶

class azure.mgmt.compute.v2024_07_01.models.Usage(*, current_value: int, limit: int, name: _models.UsageName, **kwargs: Any)[source]¶

Bases: Model

Describes Compute Resource Usage.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

unit (str) – An enum describing the unit of usage measurement. Required. Default value is “Count”.
current_value (int) – The current usage of the resource. Required.
limit (int) – The maximum permitted usage of the resource. Required.
name (UsageName) – The name of the type of usage. Required.

Keyword Arguments:

current_value (int) – The current usage of the resource. Required.
limit (int) – The maximum permitted usage of the resource. Required.
name (UsageName) – The name of the type of usage. Required.

unit = 'Count'¶

class azure.mgmt.compute.v2024_07_01.models.UsageName(*, value: str | None = None, localized_value: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The Usage Names.

Variables:

value (str) – The name of the resource.
localized_value (str) – The localized name of the resource.

Keyword Arguments:

value (str) – The name of the resource.
localized_value (str) – The localized name of the resource.

class azure.mgmt.compute.v2024_07_01.models.UserAssignedIdentitiesValue(**kwargs: Any)[source]¶

Bases: Model

UserAssignedIdentitiesValue.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

class azure.mgmt.compute.v2024_07_01.models.UserInitiatedReboot(*, automatically_approve: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies Reboot related Scheduled Event related configurations.

Variables:: automatically_approve (bool) – Specifies Reboot Scheduled Event related configurations.
Keyword Arguments:: automatically_approve (bool) – Specifies Reboot Scheduled Event related configurations.

class azure.mgmt.compute.v2024_07_01.models.UserInitiatedRedeploy(*, automatically_approve: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies Redeploy related Scheduled Event related configurations.

Variables:: automatically_approve (bool) – Specifies Redeploy Scheduled Event related configurations.
Keyword Arguments:: automatically_approve (bool) – Specifies Redeploy Scheduled Event related configurations.

class azure.mgmt.compute.v2024_07_01.models.VMDiskSecurityProfile(*, security_encryption_type: str | _models.SecurityEncryptionTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

security_encryption_type (str or SecurityEncryptionTypes) – Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. Known values are: “VMGuestStateOnly”, “DiskWithVMGuestState”, and “NonPersistedTPM”.
disk_encryption_set (DiskEncryptionSetParameters) – 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.

Keyword Arguments:

security_encryption_type (str or SecurityEncryptionTypes) – Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. Known values are: “VMGuestStateOnly”, “DiskWithVMGuestState”, and “NonPersistedTPM”.
disk_encryption_set (DiskEncryptionSetParameters) – 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.

class azure.mgmt.compute.v2024_07_01.models.VMGalleryApplication(*, package_reference_id: str, tags: str | None = None, order: int | None = None, configuration_reference: str | None = None, treat_failure_as_deployment_failure: bool | None = None, enable_automatic_upgrade: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the required information to reference a compute gallery application version.

All required parameters must be populated in order to send to server.

Variables:

tags (str) – Optional, Specifies a passthrough value for more generic context.
order (int) – Optional, Specifies the order in which the packages have to be installed.
package_reference_id (str) – Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. # pylint: disable=line-too-long Required.
configuration_reference (str) – Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided.
treat_failure_as_deployment_failure (bool) – Optional, If true, any failure for any operation in the VmApplication will fail the deployment.
enable_automatic_upgrade (bool) – If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS.

Keyword Arguments:

tags (str) – Optional, Specifies a passthrough value for more generic context.
order (int) – Optional, Specifies the order in which the packages have to be installed.
package_reference_id (str) – Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. # pylint: disable=line-too-long Required.
configuration_reference (str) – Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided.
treat_failure_as_deployment_failure (bool) – Optional, If true, any failure for any operation in the VmApplication will fail the deployment.
enable_automatic_upgrade (bool) – If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS.

class azure.mgmt.compute.v2024_07_01.models.VMGuestPatchClassificationLinux(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

VMGuestPatchClassificationLinux.

CRITICAL = 'Critical'¶

OTHER = 'Other'¶

SECURITY = 'Security'¶

class azure.mgmt.compute.v2024_07_01.models.VMGuestPatchClassificationWindows(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

VMGuestPatchClassificationWindows.

CRITICAL = 'Critical'¶

DEFINITION = 'Definition'¶

FEATURE_PACK = 'FeaturePack'¶

SECURITY = 'Security'¶

SERVICE_PACK = 'ServicePack'¶

TOOLS = 'Tools'¶

UPDATES = 'Updates'¶

UPDATE_ROLL_UP = 'UpdateRollUp'¶

class azure.mgmt.compute.v2024_07_01.models.VMGuestPatchRebootBehavior(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Describes the reboot requirements of the patch.

ALWAYS_REQUIRES_REBOOT = 'AlwaysRequiresReboot'¶

CAN_REQUEST_REBOOT = 'CanRequestReboot'¶

NEVER_REBOOTS = 'NeverReboots'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.VMGuestPatchRebootSetting(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Defines when it is acceptable to reboot a VM during a software update operation.

ALWAYS = 'Always'¶

IF_REQUIRED = 'IfRequired'¶

NEVER = 'Never'¶

class azure.mgmt.compute.v2024_07_01.models.VMGuestPatchRebootStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The reboot state of the VM following completion of the operation.

COMPLETED = 'Completed'¶

FAILED = 'Failed'¶

NOT_NEEDED = 'NotNeeded'¶

REQUIRED = 'Required'¶

STARTED = 'Started'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.VMScaleSetConvertToSinglePlacementGroupInput(*, active_placement_group_id: str | None = None, **kwargs: Any)[source]¶

Bases: Model

VMScaleSetConvertToSinglePlacementGroupInput.

Variables:: active_placement_group_id (str) – Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances.
Keyword Arguments:: active_placement_group_id (str) – Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances.

class azure.mgmt.compute.v2024_07_01.models.VMSizeProperties(*, v_cpus_available: int | None = None, v_cpus_per_core: int | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies VM Size Property settings on the virtual machine.

Variables:

v_cpus_available (int) –
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.
v_cpus_per_core (int) –
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..

Keyword Arguments:

v_cpus_available (int) –
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.
v_cpus_per_core (int) –
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..

class azure.mgmt.compute.v2024_07_01.models.VaultCertificate(*, certificate_url: str | None = None, certificate_store: str | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

certificate_url (str) –
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”:”<Base64-encoded-certificate>”,  “dataType”:”pfx”,  “password”:”<pfx-file-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.
certificate_store (str) – 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.

Keyword Arguments:

certificate_url (str) –
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”:”<Base64-encoded-certificate>”,  “dataType”:”pfx”,  “password”:”<pfx-file-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.
certificate_store (str) – 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.

class azure.mgmt.compute.v2024_07_01.models.VaultSecretGroup(*, source_vault: _models.SubResource | None = None, vault_certificates: List[_models.VaultCertificate] | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

source_vault (SubResource) – The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificates (list[VaultCertificate]) – The list of key vault references in SourceVault which contain certificates.

Keyword Arguments:

source_vault (SubResource) – The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificates (list[VaultCertificate]) – The list of key vault references in SourceVault which contain certificates.

class azure.mgmt.compute.v2024_07_01.models.VirtualHardDisk(*, uri: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the uri of a disk.

Variables:: uri (str) – Specifies the virtual hard disk’s uri.
Keyword Arguments:: uri (str) – Specifies the virtual hard disk’s uri.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachine(*, location: str, tags: Dict[str, str] | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineIdentity | None = None, zones: List[str] | None = None, extended_location: _models.ExtendedLocation | None = None, hardware_profile: _models.HardwareProfile | None = None, scheduled_events_policy: _models.ScheduledEventsPolicy | None = None, storage_profile: _models.StorageProfile | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, os_profile: _models.OSProfile | None = None, network_profile: _models.NetworkProfile | None = None, security_profile: _models.SecurityProfile | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, availability_set: _models.SubResource | None = None, virtual_machine_scale_set: _models.SubResource | None = None, proximity_placement_group: _models.SubResource | None = None, priority: str | _models.VirtualMachinePriorityTypes | None = None, eviction_policy: str | _models.VirtualMachineEvictionPolicyTypes | None = None, billing_profile: _models.BillingProfile | None = None, host: _models.SubResource | None = None, host_group: _models.SubResource | None = None, license_type: str | None = None, extensions_time_budget: str | None = None, platform_fault_domain: int | None = None, scheduled_events_profile: _models.ScheduledEventsProfile | None = None, user_data: str | None = None, capacity_reservation: _models.CapacityReservationProfile | None = None, application_profile: _models.ApplicationProfile | None = None, **kwargs: Any)[source]¶

Bases: Resource

Describes a Virtual Machine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
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.
resources (list[VirtualMachineExtension]) – The virtual machine child extension resources.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
zones (list[str]) – The virtual machine zones.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine.
managed_by (str) – ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization.
etag (str) – Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set (SubResource) –
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.
virtual_machine_scale_set (SubResource) – 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.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Known values are: “Regular”, “Low”, and “Spot”.
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – 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. Known values are: “Deallocate” and “Delete”.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
host (SubResource) – Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
host_group (SubResource) – Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineInstanceView) – The virtual machine instance view.
license_type (str) – 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.
vm_id (str) – 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.
extensions_time_budget (str) – 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.
platform_fault_domain (int) – 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’ greater than 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.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
capacity_reservation (CapacityReservationProfile) – Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
application_profile (ApplicationProfile) – Specifies the gallery applications that should be made available to the VM/VMSS.
time_created (datetime) – Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
zones (list[str]) – The virtual machine zones.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set (SubResource) –
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.
virtual_machine_scale_set (SubResource) – 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.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Known values are: “Regular”, “Low”, and “Spot”.
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – 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. Known values are: “Deallocate” and “Delete”.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
host (SubResource) – Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
host_group (SubResource) – Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.
license_type (str) –
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.
extensions_time_budget (str) – 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.
platform_fault_domain (int) – 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’ greater than 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.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
capacity_reservation (CapacityReservationProfile) – Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
application_profile (ApplicationProfile) – Specifies the gallery applications that should be made available to the VM/VMSS.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineAgentInstanceView(*, vm_agent_version: str | None = None, extension_handlers: List[_models.VirtualMachineExtensionHandlerInstanceView] | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

vm_agent_version (str) – The VM Agent full version.
extension_handlers (list[VirtualMachineExtensionHandlerInstanceView]) – The virtual machine extension handler instance view.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

vm_agent_version (str) – The VM Agent full version.
extension_handlers (list[VirtualMachineExtensionHandlerInstanceView]) – The virtual machine extension handler instance view.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineAssessPatchesResult(**kwargs: Any)[source]¶

Bases: Model

Describes the properties of an AssessPatches result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

status (str or PatchOperationStatus) – 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.”. Known values are: “Unknown”, “InProgress”, “Failed”, “Succeeded”, and “CompletedWithWarnings”.
assessment_activity_id (str) – The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
reboot_pending (bool) – 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.
critical_and_security_patch_count (int) – The number of critical or security patches that have been detected as available and not yet installed.
other_patch_count (int) – The number of all available patches excluding critical and security.
start_date_time (datetime) – The UTC timestamp when the operation began.
available_patches (list[VirtualMachineSoftwarePatchProperties]) – The list of patches that have been detected as available for installation.
error (ApiError) – The errors that were encountered during execution of the operation. The details array contains the list of them.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineCaptureParameters(*, vhd_prefix: str, destination_container_name: str, overwrite_vhds: bool, **kwargs: Any)[source]¶

Bases: Model

Capture Virtual Machine parameters.

All required parameters must be populated in order to send to server.

Variables:

vhd_prefix (str) – The captured virtual hard disk’s name prefix. Required.
destination_container_name (str) – The destination container name. Required.
overwrite_vhds (bool) – Specifies whether to overwrite the destination virtual hard disk, in case of conflict. Required.

Keyword Arguments:

vhd_prefix (str) – The captured virtual hard disk’s name prefix. Required.
destination_container_name (str) – The destination container name. Required.
overwrite_vhds (bool) – Specifies whether to overwrite the destination virtual hard disk, in case of conflict. Required.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineCaptureResult(*, id: str | None = None, **kwargs: Any)[source]¶

Bases: SubResource

Output of virtual machine capture operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
schema (str) – the schema of the captured virtual machine.
content_version (str) – the version of the content.
parameters (JSON) – parameters of the captured virtual machine.
resources (list[JSON]) – a list of resource items of the captured virtual machine.

Keyword Arguments:

id (str) – Resource Id.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineEvictionPolicyTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the eviction policy for the Azure Spot VM/VMSS.

DEALLOCATE = 'Deallocate'¶

DELETE = 'Delete'¶

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineExtension(*, location: str | None = None, tags: Dict[str, str] | None = None, force_update_tag: str | None = None, publisher: str | None = None, type_properties_type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, instance_view: _models.VirtualMachineExtensionInstanceView | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, provision_after_extensions: List[str] | None = None, **kwargs: Any)[source]¶

Bases: ResourceWithOptionalLocation

Describes a Virtual Machine Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

location (str) – Resource location.
id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
tags (dict[str, str]) – Resource tags.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.

Keyword Arguments:

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineExtensionHandlerInstanceView(*, type: str | None = None, type_handler_version: str | None = None, status: _models.InstanceViewStatus | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a virtual machine extension handler.

Variables:

type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
status (InstanceViewStatus) – The extension handler status.

Keyword Arguments:

type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
status (InstanceViewStatus) – The extension handler status.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineExtensionImage(*, location: str, tags: Dict[str, str] | None = None, operating_system: str | None = None, compute_role: str | None = None, handler_schema: str | None = None, vm_scale_set_enabled: bool | None = None, supports_multiple_extensions: bool | None = None, **kwargs: Any)[source]¶

Bases: Resource

Describes a Virtual Machine Extension Image.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
operating_system (str) – The operating system this extension supports.
compute_role (str) – The type of role (IaaS or PaaS) this extension supports.
handler_schema (str) – The schema defined by publisher, where extension consumers should provide settings in a matching schema.
vm_scale_set_enabled (bool) – Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
supports_multiple_extensions (bool) – Whether the handler can support multiple extensions.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
operating_system (str) – The operating system this extension supports.
compute_role (str) – The type of role (IaaS or PaaS) this extension supports.
handler_schema (str) – The schema defined by publisher, where extension consumers should provide settings in a matching schema.
vm_scale_set_enabled (bool) – Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.
supports_multiple_extensions (bool) – Whether the handler can support multiple extensions.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineExtensionInstanceView(*, name: str | None = None, type: str | None = None, type_handler_version: str | None = None, substatuses: List[_models.InstanceViewStatus] | None = None, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a virtual machine extension.

Variables:

name (str) – The virtual machine extension name.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
substatuses (list[InstanceViewStatus]) – The resource status information.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

name (str) – The virtual machine extension name.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
substatuses (list[InstanceViewStatus]) – The resource status information.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineExtensionUpdate(*, tags: Dict[str, str] | None = None, force_update_tag: str | None = None, publisher: str | None = None, type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Describes a Virtual Machine Extension.

Variables:

tags (dict[str, str]) – Resource tags.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineExtensionsListResult(*, value: List[_models.VirtualMachineExtension] | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Extension operation response.

Variables:: value (list[VirtualMachineExtension]) – The list of extensions.
Keyword Arguments:: value (list[VirtualMachineExtension]) – The list of extensions.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineHealthStatus(**kwargs: Any)[source]¶

Bases: Model

The health status of the VM.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: status (InstanceViewStatus) – The health status information for the VM.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineIdentity(*, type: str | _models.ResourceIdentityType | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentitiesValue] | None = None, **kwargs: Any)[source]¶

Bases: Model

Identity for the virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

principal_id (str) – The principal id of virtual machine identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.
type (str or ResourceIdentityType) – 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. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – 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}’. # pylint: disable=line-too-long

Keyword Arguments:

type (str or ResourceIdentityType) – 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. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – 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}’. # pylint: disable=line-too-long

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineImage(*, name: str, location: str, id: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, plan: _models.PurchasePlan | None = None, os_disk_image: _models.OSDiskImage | None = None, data_disk_images: List[_models.DataDiskImage] | None = None, automatic_os_upgrade_properties: _models.AutomaticOSUpgradeProperties | None = None, hyper_v_generation: str | _models.HyperVGenerationTypes | None = None, disallowed: _models.DisallowedConfiguration | None = None, features: List[_models.VirtualMachineImageFeature] | None = None, architecture: str | _models.ArchitectureTypes | None = None, image_deprecation_status: _models.ImageDeprecationStatus | None = None, **kwargs: Any)[source]¶

Bases: VirtualMachineImageResource

Describes a Virtual Machine Image.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
tags (dict[str, str]) – Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine.
plan (PurchasePlan) – Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
os_disk_image (OSDiskImage) – Contains the os disk image information.
data_disk_images (list[DataDiskImage])
automatic_os_upgrade_properties (AutomaticOSUpgradeProperties) – Describes automatic OS upgrade properties on the image.
hyper_v_generation (str or HyperVGenerationTypes) – Specifies the HyperVGeneration Type. Known values are: “V1” and “V2”.
disallowed (DisallowedConfiguration) – Specifies disallowed configuration for the VirtualMachine created from the image.
features (list[VirtualMachineImageFeature])
architecture (str or ArchitectureTypes) – Specifies the Architecture Type. Known values are: “x64” and “Arm64”.
image_deprecation_status (ImageDeprecationStatus) – Describes image deprecation status properties on the image.

Keyword Arguments:

id (str) – Resource Id.
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
tags (dict[str, str]) –
Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine.
plan (PurchasePlan) – Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
os_disk_image (OSDiskImage) – Contains the os disk image information.
data_disk_images (list[DataDiskImage])
automatic_os_upgrade_properties (AutomaticOSUpgradeProperties) – Describes automatic OS upgrade properties on the image.
hyper_v_generation (str or HyperVGenerationTypes) – Specifies the HyperVGeneration Type. Known values are: “V1” and “V2”.
disallowed (DisallowedConfiguration) – Specifies disallowed configuration for the VirtualMachine created from the image.
features (list[VirtualMachineImageFeature])
architecture (str or ArchitectureTypes) – Specifies the Architecture Type. Known values are: “x64” and “Arm64”.
image_deprecation_status (ImageDeprecationStatus) – Describes image deprecation status properties on the image.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineImageFeature(*, name: str | None = None, value: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies additional capabilities supported by the image.

Variables:

name (str) – The name of the feature.
value (str) – The corresponding value for the feature.

Keyword Arguments:

name (str) – The name of the feature.
value (str) – The corresponding value for the feature.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineImageResource(*, name: str, location: str, id: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, **kwargs: Any)[source]¶

Bases: SubResource

Virtual machine image resource information.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
tags (dict[str, str]) –
Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine.

Keyword Arguments:

id (str) – Resource Id.
name (str) – The name of the resource. Required.
location (str) – The supported Azure location of the resource. Required.
tags (dict[str, str]) –
Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineInstallPatchesParameters(*, reboot_setting: str | _models.VMGuestPatchRebootSetting, maximum_duration: str | None = None, windows_parameters: _models.WindowsParameters | None = None, linux_parameters: _models.LinuxParameters | None = None, **kwargs: Any)[source]¶

Bases: Model

Input for InstallPatches as directly received by the API.

All required parameters must be populated in order to send to server.

Variables:

maximum_duration (str) – Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours).
reboot_setting (str or VMGuestPatchRebootSetting) – Defines when it is acceptable to reboot a VM during a software update operation. Required. Known values are: “IfRequired”, “Never”, and “Always”.
windows_parameters (WindowsParameters) – Input for InstallPatches on a Windows VM, as directly received by the API.
linux_parameters (LinuxParameters) – Input for InstallPatches on a Linux VM, as directly received by the API.

Keyword Arguments:

maximum_duration (str) – Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours).
reboot_setting (str or VMGuestPatchRebootSetting) – Defines when it is acceptable to reboot a VM during a software update operation. Required. Known values are: “IfRequired”, “Never”, and “Always”.
windows_parameters (WindowsParameters) – Input for InstallPatches on a Windows VM, as directly received by the API.
linux_parameters (LinuxParameters) – Input for InstallPatches on a Linux VM, as directly received by the API.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineInstallPatchesResult(**kwargs: Any)[source]¶

Bases: Model

The result summary of an installation operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

status (str or PatchOperationStatus) – The overall success or failure status of the operation. It remains “InProgress” until the operation completes. At that point it will become “Failed”, “Succeeded”, “Unknown” or “CompletedWithWarnings.”. Known values are: “Unknown”, “InProgress”, “Failed”, “Succeeded”, and “CompletedWithWarnings”.
installation_activity_id (str) – The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
reboot_status (str or VMGuestPatchRebootStatus) – The reboot state of the VM following completion of the operation. Known values are: “Unknown”, “NotNeeded”, “Required”, “Started”, “Failed”, and “Completed”.
maintenance_window_exceeded (bool) – Whether the operation ran out of time before it completed all its intended actions.
excluded_patch_count (int) – The number of patches that were not installed due to the user blocking their installation.
not_selected_patch_count (int) – The number of patches that were detected as available for install, but did not meet the operation’s criteria.
pending_patch_count (int) – The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true.
installed_patch_count (int) – The number of patches successfully installed.
failed_patch_count (int) – The number of patches that could not be installed due to some issue. See errors for details.
patches (list[PatchInstallationDetail]) – The patches that were installed during the operation.
start_date_time (datetime) – The UTC timestamp when the operation began.
error (ApiError) – The errors that were encountered during execution of the operation. The details array contains the list of them.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineInstanceView(*, platform_update_domain: int | None = None, platform_fault_domain: int | None = None, computer_name: str | None = None, os_name: str | None = None, os_version: str | None = None, hyper_v_generation: str | _models.HyperVGenerationType | None = None, rdp_thumb_print: str | None = None, vm_agent: _models.VirtualMachineAgentInstanceView | None = None, maintenance_redeploy_status: _models.MaintenanceRedeployStatus | None = None, disks: List[_models.DiskInstanceView] | None = None, extensions: List[_models.VirtualMachineExtensionInstanceView] | None = None, boot_diagnostics: _models.BootDiagnosticsInstanceView | None = None, statuses: List[_models.InstanceViewStatus] | None = None, patch_status: _models.VirtualMachinePatchStatus | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

platform_update_domain (int) – Specifies the update domain of the virtual machine.
platform_fault_domain (int) – Specifies the fault domain of the virtual machine.
computer_name (str) – The computer name assigned to the virtual machine.
os_name (str) – The Operating System running on the virtual machine.
os_version (str) – The version of Operating System running on the virtual machine.
hyper_v_generation (str or HyperVGenerationType) – Specifies the HyperVGeneration Type associated with a resource. Known values are: “V1” and “V2”.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The virtual machine disk information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
vm_health (VirtualMachineHealthStatus) – The health status for the VM.
boot_diagnostics (BootDiagnosticsInstanceView) – 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.
assigned_host (str) – 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.
statuses (list[InstanceViewStatus]) – The resource status information.
patch_status (VirtualMachinePatchStatus) – [Preview Feature] The status of virtual machine patch operations.
is_vm_in_standby_pool (bool) – [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool.

Keyword Arguments:

platform_update_domain (int) – Specifies the update domain of the virtual machine.
platform_fault_domain (int) – Specifies the fault domain of the virtual machine.
computer_name (str) – The computer name assigned to the virtual machine.
os_name (str) – The Operating System running on the virtual machine.
os_version (str) – The version of Operating System running on the virtual machine.
hyper_v_generation (str or HyperVGenerationType) – Specifies the HyperVGeneration Type associated with a resource. Known values are: “V1” and “V2”.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The virtual machine disk information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
boot_diagnostics (BootDiagnosticsInstanceView) – 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.
statuses (list[InstanceViewStatus]) – The resource status information.
patch_status (VirtualMachinePatchStatus) – [Preview Feature] The status of virtual machine patch operations.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineIpTag(*, ip_tag_type: str | None = None, tag: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Contains the IP tag associated with the public IP address.

Variables:

ip_tag_type (str) – IP tag type. Example: FirstPartyUsage.
tag (str) – IP tag associated with the public IP. Example: SQL, Storage etc.

Keyword Arguments:

ip_tag_type (str) – IP tag type. Example: FirstPartyUsage.
tag (str) – IP tag associated with the public IP. Example: SQL, Storage etc.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineListResult(*, value: List[_models.VirtualMachine], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Virtual Machine operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachine]) – The list of virtual machines. Required.
next_link (str) – The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.

Keyword Arguments:

value (list[VirtualMachine]) – The list of virtual machines. Required.
next_link (str) – The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineNetworkInterfaceConfiguration(*, name: str, primary: bool | None = None, delete_option: str | _models.DeleteOptions | None = None, enable_accelerated_networking: bool | None = None, disable_tcp_state_tracking: bool | None = None, enable_fpga: bool | None = None, enable_ip_forwarding: bool | None = None, network_security_group: _models.SubResource | None = None, dns_settings: _models.VirtualMachineNetworkInterfaceDnsSettingsConfiguration | None = None, ip_configurations: List[_models.VirtualMachineNetworkInterfaceIPConfiguration] | None = None, dscp_configuration: _models.SubResource | None = None, auxiliary_mode: str | _models.NetworkInterfaceAuxiliaryMode | None = None, auxiliary_sku: str | _models.NetworkInterfaceAuxiliarySku | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine network interface configurations.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The network interface configuration name. Required.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
disable_tcp_state_tracking (bool) – Specifies whether the network interface is disabled for tcp state tracking.
enable_fpga (bool) – Specifies whether the network interface is FPGA networking-enabled.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineNetworkInterfaceDnsSettingsConfiguration) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineNetworkInterfaceIPConfiguration]) – Specifies the IP configurations of the network interface.
dscp_configuration (SubResource)
auxiliary_mode (str or NetworkInterfaceAuxiliaryMode) – Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.
auxiliary_sku (str or NetworkInterfaceAuxiliarySku) – Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

Keyword Arguments:

name (str) – The network interface configuration name. Required.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
disable_tcp_state_tracking (bool) – Specifies whether the network interface is disabled for tcp state tracking.
enable_fpga (bool) – Specifies whether the network interface is FPGA networking-enabled.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineNetworkInterfaceDnsSettingsConfiguration) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineNetworkInterfaceIPConfiguration]) – Specifies the IP configurations of the network interface.
dscp_configuration (SubResource)
auxiliary_mode (str or NetworkInterfaceAuxiliaryMode) – Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.
auxiliary_sku (str or NetworkInterfaceAuxiliarySku) – Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineNetworkInterfaceDnsSettingsConfiguration(*, dns_servers: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machines network configuration’s DNS settings.

Variables:: dns_servers (list[str]) – List of DNS servers IP addresses.
Keyword Arguments:: dns_servers (list[str]) – List of DNS servers IP addresses.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineNetworkInterfaceIPConfiguration(*, name: str, subnet: _models.SubResource | None = None, primary: bool | None = None, public_ip_address_configuration: _models.VirtualMachinePublicIPAddressConfiguration | None = None, private_ip_address_version: str | _models.IPVersions | None = None, application_security_groups: List[_models.SubResource] | None = None, application_gateway_backend_address_pools: List[_models.SubResource] | None = None, load_balancer_backend_address_pools: List[_models.SubResource] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine network profile’s IP configuration.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The IP configuration name. Required.
subnet (SubResource) – Specifies the identifier of the subnet.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
public_ip_address_configuration (VirtualMachinePublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersions) – 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’. Known values are: “IPv4” and “IPv6”.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
application_gateway_backend_address_pools (list[SubResource]) – 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.
load_balancer_backend_address_pools (list[SubResource]) – 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].

Keyword Arguments:

name (str) – The IP configuration name. Required.
subnet (SubResource) – Specifies the identifier of the subnet.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
public_ip_address_configuration (VirtualMachinePublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersions) – 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’. Known values are: “IPv4” and “IPv6”.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
application_gateway_backend_address_pools (list[SubResource]) – 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.
load_balancer_backend_address_pools (list[SubResource]) – 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].

class azure.mgmt.compute.v2024_07_01.models.VirtualMachinePatchStatus(*, available_patch_summary: _models.AvailablePatchSummary | None = None, last_patch_installation_summary: _models.LastPatchInstallationSummary | None = None, **kwargs: Any)[source]¶

Bases: Model

The status of virtual machine patch operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

available_patch_summary (AvailablePatchSummary) – The available patch summary of the latest assessment operation for the virtual machine.
last_patch_installation_summary (LastPatchInstallationSummary) – The installation summary of the latest installation operation for the virtual machine.
configuration_statuses (list[InstanceViewStatus]) – The enablement status of the specified patchMode.

Keyword Arguments:

available_patch_summary (AvailablePatchSummary) – The available patch summary of the latest assessment operation for the virtual machine.
last_patch_installation_summary (LastPatchInstallationSummary) – The installation summary of the latest installation operation for the virtual machine.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachinePriorityTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

LOW = 'Low'¶

REGULAR = 'Regular'¶

SPOT = 'Spot'¶

class azure.mgmt.compute.v2024_07_01.models.VirtualMachinePublicIPAddressConfiguration(*, name: str, sku: _models.PublicIPAddressSku | None = None, idle_timeout_in_minutes: int | None = None, delete_option: str | _models.DeleteOptions | None = None, dns_settings: _models.VirtualMachinePublicIPAddressDnsSettingsConfiguration | None = None, ip_tags: List[_models.VirtualMachineIpTag] | None = None, public_ip_prefix: _models.SubResource | None = None, public_ip_address_version: str | _models.IPVersions | None = None, public_ip_allocation_method: str | _models.PublicIPAllocationMethod | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machines IP Configuration’s PublicIPAddress configuration.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The publicIP address configuration name. Required.
sku (PublicIPAddressSku) – Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
delete_option (str or DeleteOptions) – Specify what happens to the public IP address when the VM is deleted. Known values are: “Delete” and “Detach”.
dns_settings (VirtualMachinePublicIPAddressDnsSettingsConfiguration) – The dns settings to be applied on the publicIP addresses .
ip_tags (list[VirtualMachineIpTag]) – The list of IP tags associated with the public IP address.
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
public_ip_address_version (str or IPVersions) – 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’. Known values are: “IPv4” and “IPv6”.
public_ip_allocation_method (str or PublicIPAllocationMethod) – Specify the public IP allocation type. Known values are: “Dynamic” and “Static”.

Keyword Arguments:

name (str) – The publicIP address configuration name. Required.
sku (PublicIPAddressSku) – Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
delete_option (str or DeleteOptions) – Specify what happens to the public IP address when the VM is deleted. Known values are: “Delete” and “Detach”.
dns_settings (VirtualMachinePublicIPAddressDnsSettingsConfiguration) – The dns settings to be applied on the publicIP addresses .
ip_tags (list[VirtualMachineIpTag]) – The list of IP tags associated with the public IP address.
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
public_ip_address_version (str or IPVersions) – 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’. Known values are: “IPv4” and “IPv6”.
public_ip_allocation_method (str or PublicIPAllocationMethod) – Specify the public IP allocation type. Known values are: “Dynamic” and “Static”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachinePublicIPAddressDnsSettingsConfiguration(*, domain_name_label: str, domain_name_label_scope: str | _models.DomainNameLabelScopeTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machines network configuration’s DNS settings.

All required parameters must be populated in order to send to server.

Variables:

domain_name_label (str) – 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. Required.
domain_name_label_scope (str or DomainNameLabelScopeTypes) – The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

Keyword Arguments:

domain_name_label (str) – 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. Required.
domain_name_label_scope (str or DomainNameLabelScopeTypes) – The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineReimageParameters(*, temp_disk: bool | None = None, exact_version: str | None = None, os_profile: _models.OSProfileProvisioningData | None = None, **kwargs: Any)[source]¶

Bases: Model

Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged.

Variables:

temp_disk (bool) – Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
exact_version (str) – Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
os_profile (OSProfileProvisioningData) – Specifies information required for reimaging the non-ephemeral OS disk.

Keyword Arguments:

temp_disk (bool) – Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
exact_version (str) – Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
os_profile (OSProfileProvisioningData) – Specifies information required for reimaging the non-ephemeral OS disk.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)[source]¶

Bases: Resource

Describes a Virtual Machine run command.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
source (VirtualMachineRunCommandScriptSource) – The source of the run command script.
parameters (list[RunCommandInputParameter]) – The parameters used by the script.
protected_parameters (list[RunCommandInputParameter]) – The parameters used by the script.
async_execution (bool) – Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
run_as_user (str) – Specifies the user account on the VM when executing the run command.
run_as_password (str) – Specifies the user account password on the VM when executing the run command.
timeout_in_seconds (int) – The timeout in seconds to execute the run command.
output_blob_uri (str) – Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
error_blob_uri (str) – Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
output_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
error_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
provisioning_state (str) – The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.
instance_view (VirtualMachineRunCommandInstanceView) – The virtual machine run command instance view.
treat_failure_as_deployment_failure (bool) – Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
source (VirtualMachineRunCommandScriptSource) – The source of the run command script.
parameters (list[RunCommandInputParameter]) – The parameters used by the script.
protected_parameters (list[RunCommandInputParameter]) – The parameters used by the script.
async_execution (bool) – Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
run_as_user (str) – Specifies the user account on the VM when executing the run command.
run_as_password (str) – Specifies the user account password on the VM when executing the run command.
timeout_in_seconds (int) – The timeout in seconds to execute the run command.
output_blob_uri (str) – Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
error_blob_uri (str) – Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
output_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
error_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
treat_failure_as_deployment_failure (bool) – Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

Bases: Model

The instance view of a virtual machine run command.

Variables:

execution_state (str or ExecutionState) – Script execution status. Known values are: “Unknown”, “Pending”, “Running”, “Failed”, “Succeeded”, “TimedOut”, and “Canceled”.
execution_message (str) – Communicate script configuration errors or execution messages.
exit_code (int) – Exit code returned from script execution.
output (str) – Script output stream.
error (str) – Script error stream.
start_time (datetime) – Script start time.
end_time (datetime) – Script end time.
statuses (list[InstanceViewStatus]) – The resource status information.

Keyword Arguments:

execution_state (str or ExecutionState) – Script execution status. Known values are: “Unknown”, “Pending”, “Running”, “Failed”, “Succeeded”, “TimedOut”, and “Canceled”.
execution_message (str) – Communicate script configuration errors or execution messages.
exit_code (int) – Exit code returned from script execution.
output (str) – Script output stream.
error (str) – Script error stream.
start_time (datetime) – Script start time.
end_time (datetime) – Script end time.
statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineRunCommandScriptSource(*, script: str | None = None, script_uri: str | None = None, command_id: str | None = None, script_uri_managed_identity: _models.RunCommandManagedIdentity | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the script sources for run command. Use only one of script, scriptUri, commandId.

Variables:

script (str) – Specifies the script content to be executed on the VM.
script_uri (str) – Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
command_id (str) – Specifies a commandId of predefined built-in script.
script_uri_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob’s container with ‘Storage Blob Data Reader’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Keyword Arguments:

script (str) – Specifies the script content to be executed on the VM.
script_uri (str) – Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI.
command_id (str) – Specifies a commandId of predefined built-in script.
script_uri_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob’s container with ‘Storage Blob Data Reader’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineRunCommandUpdate(*, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)[source]¶

Bases: UpdateResource

Describes a Virtual Machine run command.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
source (VirtualMachineRunCommandScriptSource) – The source of the run command script.
parameters (list[RunCommandInputParameter]) – The parameters used by the script.
protected_parameters (list[RunCommandInputParameter]) – The parameters used by the script.
async_execution (bool) – Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
run_as_user (str) – Specifies the user account on the VM when executing the run command.
run_as_password (str) – Specifies the user account password on the VM when executing the run command.
timeout_in_seconds (int) – The timeout in seconds to execute the run command.
output_blob_uri (str) – Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
error_blob_uri (str) – Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
output_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
error_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
provisioning_state (str) – The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.
instance_view (VirtualMachineRunCommandInstanceView) – The virtual machine run command instance view.
treat_failure_as_deployment_failure (bool) – Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
source (VirtualMachineRunCommandScriptSource) – The source of the run command script.
parameters (list[RunCommandInputParameter]) – The parameters used by the script.
protected_parameters (list[RunCommandInputParameter]) – The parameters used by the script.
async_execution (bool) – Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.
run_as_user (str) – Specifies the user account on the VM when executing the run command.
run_as_password (str) – Specifies the user account password on the VM when executing the run command.
timeout_in_seconds (int) – The timeout in seconds to execute the run command.
output_blob_uri (str) – Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.
error_blob_uri (str) – Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.
output_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
error_blob_managed_identity (RunCommandManagedIdentity) – User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob’s container with ‘Storage Blob Data Contributor’ role assignment. In case of user-assigned identity, make sure you add it under VM’s identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.
treat_failure_as_deployment_failure (bool) – Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineRunCommandsListResult(*, value: List[_models.VirtualMachineRunCommand], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List run command operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachineRunCommand]) – The list of run commands. Required.
next_link (str) – The uri to fetch the next page of run commands.

Keyword Arguments:

value (list[VirtualMachineRunCommand]) – The list of run commands. Required.
next_link (str) – The uri to fetch the next page of run commands.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSet(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineScaleSetIdentity | None = None, zones: List[str] | None = None, extended_location: _models.ExtendedLocation | None = None, upgrade_policy: _models.UpgradePolicy | None = None, scheduled_events_policy: _models.ScheduledEventsPolicy | None = None, automatic_repairs_policy: _models.AutomaticRepairsPolicy | None = None, virtual_machine_profile: _models.VirtualMachineScaleSetVMProfile | None = None, overprovision: bool | None = None, do_not_run_extensions_on_overprovisioned_v_ms: bool | None = None, single_placement_group: bool | None = None, zone_balance: bool | None = None, platform_fault_domain_count: int | None = None, proximity_placement_group: _models.SubResource | None = None, host_group: _models.SubResource | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, scale_in_policy: _models.ScaleInPolicy | None = None, orchestration_mode: str | _models.OrchestrationMode | None = None, spot_restore_policy: _models.SpotRestorePolicy | None = None, priority_mix_policy: _models.PriorityMixPolicy | None = None, constrained_maximum_capacity: bool | None = None, resiliency_policy: _models.ResiliencyPolicy | None = None, zonal_platform_fault_domain_align_mode: str | _models.ZonalPlatformFaultDomainAlignMode | None = None, sku_profile: _models.SkuProfile | None = None, **kwargs: Any)[source]¶

Bases: Resource

Describes a Virtual Machine Scale Set.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – The virtual machine scale set sku.
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.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
zones (list[str]) – The virtual machine scale set zones.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine Scale Set.
etag (str) – Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates.
upgrade_policy (UpgradePolicy) – The upgrade policy.
scheduled_events_policy (ScheduledEventsPolicy) – The ScheduledEventsPolicy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetVMProfile) – The virtual machine profile.
provisioning_state (str) – The provisioning state, which only appears in the response.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
unique_id (str) – Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
single_placement_group (bool) – 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.
zone_balance (bool) – 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.
platform_fault_domain_count (int) – Fault Domain count for each placement group.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
host_group (SubResource) – Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
additional_capabilities (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.
scale_in_policy (ScaleInPolicy) – Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
orchestration_mode (str or OrchestrationMode) – Specifies the orchestration mode for the virtual machine scale set. Known values are: “Uniform” and “Flexible”.
spot_restore_policy (SpotRestorePolicy) – Specifies the Spot Restore properties for the virtual machine scale set.
priority_mix_policy (PriorityMixPolicy) – Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
time_created (datetime) – Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01.
constrained_maximum_capacity (bool) – Optional property which must either be set to True or omitted.
resiliency_policy (ResiliencyPolicy) – Policy for Resiliency.
zonal_platform_fault_domain_align_mode (str or ZonalPlatformFaultDomainAlignMode) – Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: “Aligned” and “Unaligned”.
sku_profile (SkuProfile) – Specifies the sku profile for the virtual machine scale set.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
sku (Sku) – The virtual machine scale set sku.
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.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
zones (list[str]) – The virtual machine scale set zones.
extended_location (ExtendedLocation) – The extended location of the Virtual Machine Scale Set.
upgrade_policy (UpgradePolicy) – The upgrade policy.
scheduled_events_policy (ScheduledEventsPolicy) – The ScheduledEventsPolicy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetVMProfile) – The virtual machine profile.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
single_placement_group (bool) – 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.
zone_balance (bool) – 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.
platform_fault_domain_count (int) – Fault Domain count for each placement group.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
host_group (SubResource) – Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
additional_capabilities (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.
scale_in_policy (ScaleInPolicy) – Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
orchestration_mode (str or OrchestrationMode) – Specifies the orchestration mode for the virtual machine scale set. Known values are: “Uniform” and “Flexible”.
spot_restore_policy (SpotRestorePolicy) – Specifies the Spot Restore properties for the virtual machine scale set.
priority_mix_policy (PriorityMixPolicy) – Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
constrained_maximum_capacity (bool) – Optional property which must either be set to True or omitted.
resiliency_policy (ResiliencyPolicy) – Policy for Resiliency.
zonal_platform_fault_domain_align_mode (str or ZonalPlatformFaultDomainAlignMode) – Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: “Aligned” and “Unaligned”.
sku_profile (SkuProfile) – Specifies the sku profile for the virtual machine scale set.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetDataDisk(*, lun: int, create_option: str | _models.DiskCreateOptionTypes, name: str | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, disk_size_gb: int | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None = None, disk_iops_read_write: int | None = None, disk_m_bps_read_write: int | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set data disk.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The disk name.
lun (int) – 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. Required.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – The create option. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
disk_size_gb (int) – 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. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
disk_iops_read_write (int) – 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.
disk_m_bps_read_write (int) – 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.
delete_option (str or DiskDeleteOptionTypes) – 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. Known values are: “Delete” and “Detach”.

Keyword Arguments:

name (str) – The disk name.
lun (int) – 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. Required.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – The create option. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
disk_size_gb (int) – 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. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
disk_iops_read_write (int) – 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.
disk_m_bps_read_write (int) – 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.
delete_option (str or DiskDeleteOptionTypes) – 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. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetExtension(*, name: str | None = None, force_update_tag: str | None = None, publisher: str | None = None, type_properties_type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, provision_after_extensions: List[str] | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, **kwargs: Any)[source]¶

Bases: SubResourceReadOnly

Describes a Virtual Machine Scale Set Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
name (str) – The name of the extension.
type (str) – Resource type.
force_update_tag (str) – If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state (str) – The provisioning state, which only appears in the response.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

Keyword Arguments:

name (str) – The name of the extension.
force_update_tag (str) – If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetExtensionListResult(*, value: List[_models.VirtualMachineScaleSetExtension], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List VM scale set extension operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachineScaleSetExtension]) – The list of VM scale set extensions. Required.
next_link (str) – The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions.

Keyword Arguments:

value (list[VirtualMachineScaleSetExtension]) – The list of VM scale set extensions. Required.
next_link (str) – The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetExtensionProfile(*, extensions: List[_models.VirtualMachineScaleSetExtension] | None = None, extensions_time_budget: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set extension profile.

Variables:

extensions (list[VirtualMachineScaleSetExtension]) – The virtual machine scale set child extension resources.
extensions_time_budget (str) – 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.

Keyword Arguments:

extensions (list[VirtualMachineScaleSetExtension]) – The virtual machine scale set child extension resources.
extensions_time_budget (str) – 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.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetExtensionUpdate(*, force_update_tag: str | None = None, publisher: str | None = None, type_properties_type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, provision_after_extensions: List[str] | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, **kwargs: Any)[source]¶

Bases: SubResourceReadOnly

Describes a Virtual Machine Scale Set Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
name (str) – The name of the extension.
type (str) – Resource type.
force_update_tag (str) – If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state (str) – The provisioning state, which only appears in the response.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

Keyword Arguments:

force_update_tag (str) – If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetHardwareProfile(*, vm_size_properties: _models.VMSizeProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies the hardware settings for the virtual machine scale set.

Variables:

vm_size_properties (VMSizeProperties) –

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

Keyword Arguments:

vm_size_properties (VMSizeProperties) –

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

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetIPConfiguration(*, name: str, subnet: _models.ApiEntityReference | None = None, primary: bool | None = None, public_ip_address_configuration: _models.VirtualMachineScaleSetPublicIPAddressConfiguration | None = None, private_ip_address_version: str | _models.IPVersion | None = None, application_gateway_backend_address_pools: List[_models.SubResource] | None = None, application_security_groups: List[_models.SubResource] | None = None, load_balancer_backend_address_pools: List[_models.SubResource] | None = None, load_balancer_inbound_nat_pools: List[_models.SubResource] | None = None, **kwargs: Any)[source]¶

Bases: Model

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

All required parameters must be populated in order to send to server.

Variables:

name (str) – The IP configuration name. Required.
subnet (ApiEntityReference) – Specifies the identifier of the subnet.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
public_ip_address_configuration (VirtualMachineScaleSetPublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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’. Known values are: “IPv4” and “IPv6”.
application_gateway_backend_address_pools (list[SubResource]) – 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.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – 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.
load_balancer_inbound_nat_pools (list[SubResource]) – 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.

Keyword Arguments:

name (str) – The IP configuration name. Required.
subnet (ApiEntityReference) – Specifies the identifier of the subnet.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
public_ip_address_configuration (VirtualMachineScaleSetPublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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’. Known values are: “IPv4” and “IPv6”.
application_gateway_backend_address_pools (list[SubResource]) – 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.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – 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.
load_balancer_inbound_nat_pools (list[SubResource]) – 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.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetIdentity(*, type: str | _models.ResourceIdentityType | None = None, user_assigned_identities: Dict[str, _models.UserAssignedIdentitiesValue] | None = None, **kwargs: Any)[source]¶

Bases: Model

Identity for the virtual machine scale set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

principal_id (str) – The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.
type (str or ResourceIdentityType) – 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. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – 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}’. # pylint: disable=line-too-long

Keyword Arguments:

type (str or ResourceIdentityType) – 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. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserAssignedIdentitiesValue]) – 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}’. # pylint: disable=line-too-long

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetInstanceView(*, statuses: List[_models.InstanceViewStatus] | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a virtual machine scale set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

virtual_machine (VirtualMachineScaleSetInstanceViewStatusesSummary) – The instance view status summary for the virtual machine scale set.
extensions (list[VirtualMachineScaleSetVMExtensionsSummary]) – The extensions information.
statuses (list[InstanceViewStatus]) – The resource status information.
orchestration_services (list[OrchestrationServiceSummary]) – The orchestration services information.

Keyword Arguments:

statuses (list[InstanceViewStatus]) – The resource status information.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetInstanceViewStatusesSummary(**kwargs: Any)[source]¶

Bases: Model

Instance view statuses summary for virtual machines of a virtual machine scale set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: statuses_summary (list[VirtualMachineStatusCodeCount]) – The extensions information.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetIpTag(*, ip_tag_type: str | None = None, tag: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Contains the IP tag associated with the public IP address.

Variables:

ip_tag_type (str) – IP tag type. Example: FirstPartyUsage.
tag (str) – IP tag associated with the public IP. Example: SQL, Storage etc.

Keyword Arguments:

ip_tag_type (str) – IP tag type. Example: FirstPartyUsage.
tag (str) – IP tag associated with the public IP. Example: SQL, Storage etc.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetListOSUpgradeHistory(*, value: List[_models.UpgradeOperationHistoricalStatusInfo], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

List of Virtual Machine Scale Set OS Upgrade History operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[UpgradeOperationHistoricalStatusInfo]) – The list of OS upgrades performed on the virtual machine scale set. Required.
next_link (str) – The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.

Keyword Arguments:

value (list[UpgradeOperationHistoricalStatusInfo]) – The list of OS upgrades performed on the virtual machine scale set. Required.
next_link (str) – The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetListResult(*, value: List[_models.VirtualMachineScaleSet], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Virtual Machine operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.

Keyword Arguments:

value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetListSkusResult(*, value: List[_models.VirtualMachineScaleSetSku], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The Virtual Machine Scale Set List Skus operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachineScaleSetSku]) – The list of skus available for the virtual machine scale set. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus.

Keyword Arguments:

value (list[VirtualMachineScaleSetSku]) – The list of skus available for the virtual machine scale set. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetListWithLinkResult(*, value: List[_models.VirtualMachineScaleSet], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Virtual Machine operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.

Keyword Arguments:

value (list[VirtualMachineScaleSet]) – The list of virtual machine scale sets. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetManagedDiskParameters(*, storage_account_type: str | _models.StorageAccountTypes | None = None, disk_encryption_set: _models.DiskEncryptionSetParameters | None = None, security_profile: _models.VMDiskSecurityProfile | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the parameters of a ScaleSet managed disk.

Variables:

storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed disk.
security_profile (VMDiskSecurityProfile) – Specifies the security profile for the managed disk.

Keyword Arguments:

storage_account_type (str or StorageAccountTypes) – 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. Known values are: “Standard_LRS”, “Premium_LRS”, “StandardSSD_LRS”, “UltraSSD_LRS”, “Premium_ZRS”, “StandardSSD_ZRS”, and “PremiumV2_LRS”.
disk_encryption_set (DiskEncryptionSetParameters) – Specifies the customer managed disk encryption set resource id for the managed disk.
security_profile (VMDiskSecurityProfile) – Specifies the security profile for the managed disk.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetNetworkConfiguration(*, name: str, primary: bool | None = None, enable_accelerated_networking: bool | None = None, disable_tcp_state_tracking: bool | None = None, enable_fpga: bool | None = None, network_security_group: _models.SubResource | None = None, dns_settings: _models.VirtualMachineScaleSetNetworkConfigurationDnsSettings | None = None, ip_configurations: List[_models.VirtualMachineScaleSetIPConfiguration] | None = None, enable_ip_forwarding: bool | None = None, delete_option: str | _models.DeleteOptions | None = None, auxiliary_mode: str | _models.NetworkInterfaceAuxiliaryMode | None = None, auxiliary_sku: str | _models.NetworkInterfaceAuxiliarySku | None = None, **kwargs: Any)[source]¶

Bases: Model

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

All required parameters must be populated in order to send to server.

Variables:

name (str) – The network configuration name. Required.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
disable_tcp_state_tracking (bool) – Specifies whether the network interface is disabled for tcp state tracking.
enable_fpga (bool) – Specifies whether the network interface is FPGA networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetIPConfiguration]) – Specifies the IP configurations of the network interface.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.
auxiliary_mode (str or NetworkInterfaceAuxiliaryMode) – Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.
auxiliary_sku (str or NetworkInterfaceAuxiliarySku) – Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

Keyword Arguments:

name (str) – The network configuration name. Required.
primary (bool) – Specifies the primary network interface in case the virtual machine has more than 1 network interface.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
disable_tcp_state_tracking (bool) – Specifies whether the network interface is disabled for tcp state tracking.
enable_fpga (bool) – Specifies whether the network interface is FPGA networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetIPConfiguration]) – Specifies the IP configurations of the network interface.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.
auxiliary_mode (str or NetworkInterfaceAuxiliaryMode) – Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.
auxiliary_sku (str or NetworkInterfaceAuxiliarySku) – Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetNetworkConfigurationDnsSettings(*, dns_servers: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:: dns_servers (list[str]) – List of DNS servers IP addresses.
Keyword Arguments:: dns_servers (list[str]) – List of DNS servers IP addresses.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetNetworkProfile(*, health_probe: _models.ApiEntityReference | None = None, network_interface_configurations: List[_models.VirtualMachineScaleSetNetworkConfiguration] | None = None, network_api_version: str | _models.NetworkApiVersion | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set network profile.

Variables:

health_probe (ApiEntityReference) – 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}’. # pylint: disable=line-too-long
network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.
network_api_version (str or 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’. “2020-11-01”

Keyword Arguments:

health_probe (ApiEntityReference) – 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}’. # pylint: disable=line-too-long
network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.
network_api_version (str or 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’. “2020-11-01”

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetOSDisk(*, create_option: str | _models.DiskCreateOptionTypes, name: str | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, diff_disk_settings: _models.DiffDiskSettings | None = None, disk_size_gb: int | None = None, os_type: str | _models.OperatingSystemTypes | None = None, image: _models.VirtualHardDisk | None = None, vhd_containers: List[str] | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set operating system disk.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The disk name.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb (int) – 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. The property ‘diskSizeGB’ is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
os_type (str or OperatingSystemTypes) – 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.. Known values are: “Windows” and “Linux”.
image (VirtualHardDisk) – Specifies information about the unmanaged user image to base the scale set on.
vhd_containers (list[str]) – Specifies the container urls that are used to store operating system disks for the scale set.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
delete_option (str or DiskDeleteOptionTypes) – 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. Known values are: “Delete” and “Detach”.

Keyword Arguments:

name (str) – The disk name.
caching (str or CachingTypes) – Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
create_option (str or DiskCreateOptionTypes) – Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. 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. Required. Known values are: “FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb (int) – 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. The property ‘diskSizeGB’ is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
os_type (str or OperatingSystemTypes) – 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.. Known values are: “Windows” and “Linux”.
image (VirtualHardDisk) – Specifies information about the unmanaged user image to base the scale set on.
vhd_containers (list[str]) – Specifies the container urls that are used to store operating system disks for the scale set.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
delete_option (str or DiskDeleteOptionTypes) – 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. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetOSProfile(*, computer_name_prefix: str | None = None, admin_username: str | None = None, admin_password: str | None = None, custom_data: str | None = None, windows_configuration: _models.WindowsConfiguration | None = None, linux_configuration: _models.LinuxConfiguration | None = None, secrets: List[_models.VaultSecretGroup] | None = None, allow_extension_operations: bool | None = None, require_guest_provision_signal: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set OS profile.

Variables:

computer_name_prefix (str) – 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.
admin_username (str) – 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.
admin_password (str) –
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 :code:` 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.
custom_data (str) –
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.
windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (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 (list[VaultSecretGroup]) –
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.
allow_extension_operations (bool) – 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.
require_guest_provision_signal (bool) – Optional property which must either be set to True or omitted.

Keyword Arguments:

computer_name_prefix (str) – 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.
admin_username (str) – 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.
admin_password (str) –
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 :code:` 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.
custom_data (str) –
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.
windows_configuration (WindowsConfiguration) – Specifies Windows operating system settings on the virtual machine.
linux_configuration (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 (list[VaultSecretGroup]) –
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.
allow_extension_operations (bool) – 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.
require_guest_provision_signal (bool) – Optional property which must either be set to True or omitted.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetPublicIPAddressConfiguration(*, name: str, sku: _models.PublicIPAddressSku | None = None, idle_timeout_in_minutes: int | None = None, dns_settings: _models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings | None = None, ip_tags: List[_models.VirtualMachineScaleSetIpTag] | None = None, public_ip_prefix: _models.SubResource | None = None, public_ip_address_version: str | _models.IPVersion | None = None, delete_option: str | _models.DeleteOptions | None = None, **kwargs: Any)[source]¶

Bases: Model

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

All required parameters must be populated in order to send to server.

Variables:

name (str) – The publicIP address configuration name. Required.
sku (PublicIPAddressSku) – Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
ip_tags (list[VirtualMachineScaleSetIpTag]) – The list of IP tags associated with the public IP address.
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
public_ip_address_version (str or IPVersion) – 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’. Known values are: “IPv4” and “IPv6”.
delete_option (str or DeleteOptions) – Specify what happens to the public IP when the VM is deleted. Known values are: “Delete” and “Detach”.

Keyword Arguments:

name (str) – The publicIP address configuration name. Required.
sku (PublicIPAddressSku) – Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
ip_tags (list[VirtualMachineScaleSetIpTag]) – The list of IP tags associated with the public IP address.
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
public_ip_address_version (str or IPVersion) – 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’. Known values are: “IPv4” and “IPv6”.
delete_option (str or DeleteOptions) – Specify what happens to the public IP when the VM is deleted. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings(*, domain_name_label: str, domain_name_label_scope: str | _models.DomainNameLabelScopeTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

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

All required parameters must be populated in order to send to server.

Variables:

domain_name_label (str) – The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created. Required.
domain_name_label_scope (str or DomainNameLabelScopeTypes) – The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

Keyword Arguments:

domain_name_label (str) – The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created. Required.
domain_name_label_scope (str or DomainNameLabelScopeTypes) – The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created. Known values are: “TenantReuse”, “SubscriptionReuse”, “ResourceGroupReuse”, and “NoReuse”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetReimageParameters(*, temp_disk: bool | None = None, exact_version: str | None = None, os_profile: _models.OSProfileProvisioningData | None = None, force_update_os_disk_for_ephemeral: bool | None = None, instance_ids: List[str] | None = None, **kwargs: Any)[source]¶

Bases: VirtualMachineScaleSetVMReimageParameters

Describes a Virtual Machine Scale Set VM Reimage Parameters.

Variables:

temp_disk (bool) – Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
exact_version (str) – Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
os_profile (OSProfileProvisioningData) – Specifies information required for reimaging the non-ephemeral OS disk.
force_update_os_disk_for_ephemeral (bool) – Parameter to force update ephemeral OS disk for a virtual machine scale set VM.
instance_ids (list[str]) – The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

Keyword Arguments:

temp_disk (bool) – Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
exact_version (str) – Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
os_profile (OSProfileProvisioningData) – Specifies information required for reimaging the non-ephemeral OS disk.
force_update_os_disk_for_ephemeral (bool) – Parameter to force update ephemeral OS disk for a virtual machine scale set VM.
instance_ids (list[str]) – The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetScaleInRules(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

VirtualMachineScaleSetScaleInRules.

DEFAULT = 'Default'¶

NEWEST_VM = 'NewestVM'¶

OLDEST_VM = 'OldestVM'¶

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetSku(**kwargs: Any)[source]¶

Bases: Model

Describes an available virtual machine scale set sku.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

resource_type (str) – The type of resource the sku applies to.
sku (Sku) – The Sku.
capacity (VirtualMachineScaleSetSkuCapacity) – Specifies the number of virtual machines in the scale set.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetSkuCapacity(**kwargs: Any)[source]¶

Bases: Model

Describes scaling information of a sku.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

minimum (int) – The minimum capacity.
maximum (int) – The maximum capacity that can be set.
default_capacity (int) – The default capacity.
scale_type (str or VirtualMachineScaleSetSkuScaleType) – The scale type applicable to the sku. Known values are: “Automatic” and “None”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetSkuScaleType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The scale type applicable to the sku.

AUTOMATIC = 'Automatic'¶

NONE = 'None'¶

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetStorageProfile(*, image_reference: _models.ImageReference | None = None, os_disk: _models.VirtualMachineScaleSetOSDisk | None = None, data_disks: List[_models.VirtualMachineScaleSetDataDisk] | None = None, disk_controller_type: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set storage profile.

Variables:

image_reference (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.
os_disk (VirtualMachineScaleSetOSDisk) –
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.
data_disks (list[VirtualMachineScaleSetDataDisk]) –
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.
disk_controller_type (str)

Keyword Arguments:

image_reference (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.
os_disk (VirtualMachineScaleSetOSDisk) –
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.
data_disks (list[VirtualMachineScaleSetDataDisk]) –
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.
disk_controller_type (str)

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdate(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineScaleSetIdentity | None = None, zones: List[str] | None = None, upgrade_policy: _models.UpgradePolicy | None = None, automatic_repairs_policy: _models.AutomaticRepairsPolicy | None = None, virtual_machine_profile: _models.VirtualMachineScaleSetUpdateVMProfile | None = None, overprovision: bool | None = None, do_not_run_extensions_on_overprovisioned_v_ms: bool | None = None, single_placement_group: bool | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, scale_in_policy: _models.ScaleInPolicy | None = None, proximity_placement_group: _models.SubResource | None = None, priority_mix_policy: _models.PriorityMixPolicy | None = None, spot_restore_policy: _models.SpotRestorePolicy | None = None, resiliency_policy: _models.ResiliencyPolicy | None = None, zonal_platform_fault_domain_align_mode: str | _models.ZonalPlatformFaultDomainAlignMode | None = None, sku_profile: _models.SkuProfile | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Describes a Virtual Machine Scale Set.

Variables:

tags (dict[str, str]) – Resource tags.
sku (Sku) – The virtual machine scale set sku.
plan (Plan) – The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
zones (list[str]) – The virtual machine scale set zones.
upgrade_policy (UpgradePolicy) – The upgrade policy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetUpdateVMProfile) – The virtual machine profile.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
single_placement_group (bool) – 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.
additional_capabilities (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.
scale_in_policy (ScaleInPolicy) – Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.  :code:` `Minimum api-version: 2018-04-01.
priority_mix_policy (PriorityMixPolicy) – Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
spot_restore_policy (SpotRestorePolicy) – Specifies the Spot Restore properties for the virtual machine scale set.
resiliency_policy (ResiliencyPolicy) – Policy for Resiliency.
zonal_platform_fault_domain_align_mode (str or ZonalPlatformFaultDomainAlignMode) – Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: “Aligned” and “Unaligned”.
sku_profile (SkuProfile) – Specifies the sku profile for the virtual machine scale set.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
sku (Sku) – The virtual machine scale set sku.
plan (Plan) – The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
identity (VirtualMachineScaleSetIdentity) – The identity of the virtual machine scale set, if configured.
zones (list[str]) – The virtual machine scale set zones.
upgrade_policy (UpgradePolicy) – The upgrade policy.
automatic_repairs_policy (AutomaticRepairsPolicy) – Policy for automatic repairs.
virtual_machine_profile (VirtualMachineScaleSetUpdateVMProfile) – The virtual machine profile.
overprovision (bool) – Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms (bool) – 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.
single_placement_group (bool) – 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.
additional_capabilities (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.
scale_in_policy (ScaleInPolicy) – Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.  :code:` `Minimum api-version: 2018-04-01.
priority_mix_policy (PriorityMixPolicy) – Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
spot_restore_policy (SpotRestorePolicy) – Specifies the Spot Restore properties for the virtual machine scale set.
resiliency_policy (ResiliencyPolicy) – Policy for Resiliency.
zonal_platform_fault_domain_align_mode (str or ZonalPlatformFaultDomainAlignMode) – Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: “Aligned” and “Unaligned”.
sku_profile (SkuProfile) – Specifies the sku profile for the virtual machine scale set.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateIPConfiguration(*, name: str | None = None, subnet: _models.ApiEntityReference | None = None, primary: bool | None = None, public_ip_address_configuration: _models.VirtualMachineScaleSetUpdatePublicIPAddressConfiguration | None = None, private_ip_address_version: str | _models.IPVersion | None = None, application_gateway_backend_address_pools: List[_models.SubResource] | None = None, application_security_groups: List[_models.SubResource] | None = None, load_balancer_backend_address_pools: List[_models.SubResource] | None = None, load_balancer_inbound_nat_pools: List[_models.SubResource] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set network profile’s IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network.

Variables:

name (str) – The IP configuration name.
subnet (ApiEntityReference) – The subnet.
primary (bool) – Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
public_ip_address_configuration (VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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’. Known values are: “IPv4” and “IPv6”.
application_gateway_backend_address_pools (list[SubResource]) – The application gateway backend address pools.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – The load balancer backend address pools.
load_balancer_inbound_nat_pools (list[SubResource]) – The load balancer inbound nat pools.

Keyword Arguments:

name (str) – The IP configuration name.
subnet (ApiEntityReference) – The subnet.
primary (bool) – Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
public_ip_address_configuration (VirtualMachineScaleSetUpdatePublicIPAddressConfiguration) – The publicIPAddressConfiguration.
private_ip_address_version (str or IPVersion) – 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’. Known values are: “IPv4” and “IPv6”.
application_gateway_backend_address_pools (list[SubResource]) – The application gateway backend address pools.
application_security_groups (list[SubResource]) – Specifies an array of references to application security group.
load_balancer_backend_address_pools (list[SubResource]) – The load balancer backend address pools.
load_balancer_inbound_nat_pools (list[SubResource]) – The load balancer inbound nat pools.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateNetworkConfiguration(*, name: str | None = None, primary: bool | None = None, enable_accelerated_networking: bool | None = None, disable_tcp_state_tracking: bool | None = None, enable_fpga: bool | None = None, network_security_group: _models.SubResource | None = None, dns_settings: _models.VirtualMachineScaleSetNetworkConfigurationDnsSettings | None = None, ip_configurations: List[_models.VirtualMachineScaleSetUpdateIPConfiguration] | None = None, enable_ip_forwarding: bool | None = None, delete_option: str | _models.DeleteOptions | None = None, auxiliary_mode: str | _models.NetworkInterfaceAuxiliaryMode | None = None, auxiliary_sku: str | _models.NetworkInterfaceAuxiliarySku | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

name (str) – The network configuration name.
primary (bool) – Whether this is a primary NIC on a virtual machine.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
disable_tcp_state_tracking (bool) – Specifies whether the network interface is disabled for tcp state tracking.
enable_fpga (bool) – Specifies whether the network interface is FPGA networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetUpdateIPConfiguration]) – The virtual machine scale set IP Configuration.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.
auxiliary_mode (str or NetworkInterfaceAuxiliaryMode) – Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.
auxiliary_sku (str or NetworkInterfaceAuxiliarySku) – Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

Keyword Arguments:

name (str) – The network configuration name.
primary (bool) – Whether this is a primary NIC on a virtual machine.
enable_accelerated_networking (bool) – Specifies whether the network interface is accelerated networking-enabled.
disable_tcp_state_tracking (bool) – Specifies whether the network interface is disabled for tcp state tracking.
enable_fpga (bool) – Specifies whether the network interface is FPGA networking-enabled.
network_security_group (SubResource) – The network security group.
dns_settings (VirtualMachineScaleSetNetworkConfigurationDnsSettings) – The dns settings to be applied on the network interfaces.
ip_configurations (list[VirtualMachineScaleSetUpdateIPConfiguration]) – The virtual machine scale set IP Configuration.
enable_ip_forwarding (bool) – Whether IP forwarding enabled on this NIC.
delete_option (str or DeleteOptions) – Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.
auxiliary_mode (str or NetworkInterfaceAuxiliaryMode) – Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.
auxiliary_sku (str or NetworkInterfaceAuxiliarySku) – Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateNetworkProfile(*, health_probe: _models.ApiEntityReference | None = None, network_interface_configurations: List[_models.VirtualMachineScaleSetUpdateNetworkConfiguration] | None = None, network_api_version: str | _models.NetworkApiVersion | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set network profile.

Variables:

health_probe (ApiEntityReference) – 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}’. # pylint: disable=line-too-long
network_interface_configurations (list[VirtualMachineScaleSetUpdateNetworkConfiguration]) – The list of network configurations.
network_api_version (str or 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’. “2020-11-01”

Keyword Arguments:

health_probe (ApiEntityReference) – 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}’. # pylint: disable=line-too-long
network_interface_configurations (list[VirtualMachineScaleSetUpdateNetworkConfiguration]) – The list of network configurations.
network_api_version (str or 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’. “2020-11-01”

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateOSDisk(*, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, diff_disk_settings: _models.DiffDiskSettings | None = None, disk_size_gb: int | None = None, image: _models.VirtualHardDisk | None = None, vhd_containers: List[str] | None = None, managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None = None, delete_option: str | _models.DiskDeleteOptionTypes | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.

Variables:

caching (str or CachingTypes) – The caching type. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb (int) – 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.   diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
image (VirtualHardDisk) – The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.
vhd_containers (list[str]) – The list of virtual hard disk container uris.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
delete_option (str or DiskDeleteOptionTypes) – 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. Known values are: “Delete” and “Detach”.

Keyword Arguments:

caching (str or CachingTypes) – The caching type. Known values are: “None”, “ReadOnly”, and “ReadWrite”.
write_accelerator_enabled (bool) – Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings (DiffDiskSettings) – Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
disk_size_gb (int) – 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.   diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
image (VirtualHardDisk) – The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.
vhd_containers (list[str]) – The list of virtual hard disk container uris.
managed_disk (VirtualMachineScaleSetManagedDiskParameters) – The managed disk parameters.
delete_option (str or DiskDeleteOptionTypes) – 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. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateOSProfile(*, custom_data: str | None = None, windows_configuration: _models.WindowsConfiguration | None = None, linux_configuration: _models.LinuxConfiguration | None = None, secrets: List[_models.VaultSecretGroup] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set OS profile.

Variables:

custom_data (str) – A base-64 encoded string of custom data.
windows_configuration (WindowsConfiguration) – The Windows Configuration of the OS profile.
linux_configuration (LinuxConfiguration) – The Linux Configuration of the OS profile.
secrets (list[VaultSecretGroup]) – The List of certificates for addition to the VM.

Keyword Arguments:

custom_data (str) – A base-64 encoded string of custom data.
windows_configuration (WindowsConfiguration) – The Windows Configuration of the OS profile.
linux_configuration (LinuxConfiguration) – The Linux Configuration of the OS profile.
secrets (list[VaultSecretGroup]) – The List of certificates for addition to the VM.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdatePublicIPAddressConfiguration(*, name: str | None = None, idle_timeout_in_minutes: int | None = None, dns_settings: _models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings | None = None, public_ip_prefix: _models.SubResource | None = None, delete_option: str | _models.DeleteOptions | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

name (str) – The publicIP address configuration name.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
delete_option (str or DeleteOptions) – Specify what happens to the public IP when the VM is deleted. Known values are: “Delete” and “Detach”.

Keyword Arguments:

name (str) – The publicIP address configuration name.
idle_timeout_in_minutes (int) – The idle timeout of the public IP address.
dns_settings (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings) – The dns settings to be applied on the publicIP addresses .
public_ip_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.
delete_option (str or DeleteOptions) – Specify what happens to the public IP when the VM is deleted. Known values are: “Delete” and “Detach”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateStorageProfile(*, image_reference: _models.ImageReference | None = None, os_disk: _models.VirtualMachineScaleSetUpdateOSDisk | None = None, data_disks: List[_models.VirtualMachineScaleSetDataDisk] | None = None, disk_controller_type: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set storage profile.

Variables:

image_reference (ImageReference) – The image reference.
os_disk (VirtualMachineScaleSetUpdateOSDisk) – The OS disk.
data_disks (list[VirtualMachineScaleSetDataDisk]) – The data disks.
disk_controller_type (str)

Keyword Arguments:

image_reference (ImageReference) – The image reference.
os_disk (VirtualMachineScaleSetUpdateOSDisk) – The OS disk.
data_disks (list[VirtualMachineScaleSetDataDisk]) – The data disks.
disk_controller_type (str)

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetUpdateVMProfile(*, os_profile: _models.VirtualMachineScaleSetUpdateOSProfile | None = None, storage_profile: _models.VirtualMachineScaleSetUpdateStorageProfile | None = None, network_profile: _models.VirtualMachineScaleSetUpdateNetworkProfile | None = None, security_posture_reference: _models.SecurityPostureReferenceUpdate | None = None, security_profile: _models.SecurityProfile | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, extension_profile: _models.VirtualMachineScaleSetExtensionProfile | None = None, license_type: str | None = None, billing_profile: _models.BillingProfile | None = None, scheduled_events_profile: _models.ScheduledEventsProfile | None = None, user_data: str | None = None, hardware_profile: _models.VirtualMachineScaleSetHardwareProfile | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set virtual machine profile.

Variables:

os_profile (VirtualMachineScaleSetUpdateOSProfile) – The virtual machine scale set OS profile.
storage_profile (VirtualMachineScaleSetUpdateStorageProfile) – The virtual machine scale set storage profile.
network_profile (VirtualMachineScaleSetUpdateNetworkProfile) – The virtual machine scale set network profile.
security_posture_reference (SecurityPostureReferenceUpdate) – The virtual machine scale set security posture reference.
security_profile (SecurityProfile) – The virtual machine scale set Security profile.
diagnostics_profile (DiagnosticsProfile) – The virtual machine scale set diagnostics profile.
extension_profile (VirtualMachineScaleSetExtensionProfile) – The virtual machine scale set extension profile.
license_type (str) – The license type, which is for bring your own license scenario.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.  :code:` `Minimum api-version: 2021-03-01.
hardware_profile (VirtualMachineScaleSetHardwareProfile) – Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.

Keyword Arguments:

os_profile (VirtualMachineScaleSetUpdateOSProfile) – The virtual machine scale set OS profile.
storage_profile (VirtualMachineScaleSetUpdateStorageProfile) – The virtual machine scale set storage profile.
network_profile (VirtualMachineScaleSetUpdateNetworkProfile) – The virtual machine scale set network profile.
security_posture_reference (SecurityPostureReferenceUpdate) – The virtual machine scale set security posture reference.
security_profile (SecurityProfile) – The virtual machine scale set Security profile.
diagnostics_profile (DiagnosticsProfile) – The virtual machine scale set diagnostics profile.
extension_profile (VirtualMachineScaleSetExtensionProfile) – The virtual machine scale set extension profile.
license_type (str) – The license type, which is for bring your own license scenario.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.  :code:` `Minimum api-version: 2021-03-01.
hardware_profile (VirtualMachineScaleSetHardwareProfile) – Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVM(*, location: str, tags: Dict[str, str] | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineIdentity | None = None, hardware_profile: _models.HardwareProfile | None = None, storage_profile: _models.StorageProfile | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, os_profile: _models.OSProfile | None = None, security_profile: _models.SecurityProfile | None = None, network_profile: _models.NetworkProfile | None = None, network_profile_configuration: _models.VirtualMachineScaleSetVMNetworkProfileConfiguration | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, availability_set: _models.SubResource | None = None, license_type: str | None = None, protection_policy: _models.VirtualMachineScaleSetVMProtectionPolicy | None = None, user_data: str | None = None, **kwargs: Any)[source]¶

Bases: Resource

Describes a virtual machine scale set virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Resource Id.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
instance_id (str) – The virtual machine instance ID.
sku (Sku) – The virtual machine SKU.
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.
resources (list[VirtualMachineExtension]) – The virtual machine child extension resources.
zones (list[str]) – The virtual machine zones.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
etag (str) – Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
latest_model_applied (bool) – Specifies whether the latest model has been applied to the virtual machine.
vm_id (str) – Azure VM unique ID.
instance_view (VirtualMachineScaleSetVMInstanceView) – The virtual machine instance view.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
network_profile_configuration (VirtualMachineScaleSetVMNetworkProfileConfiguration) – Specifies the network profile configuration of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set (SubResource) –
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. An existing VM cannot be added to an availability set.
provisioning_state (str) – The provisioning state, which only appears in the response.
license_type (str) –
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.
model_definition_applied (str) – Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
protection_policy (VirtualMachineScaleSetVMProtectionPolicy) – Specifies the protection policy of the virtual machine.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
time_created (datetime) – Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
os_profile (OSProfile) – Specifies the operating system settings for the virtual machine.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machine.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
network_profile_configuration (VirtualMachineScaleSetVMNetworkProfileConfiguration) – Specifies the network profile configuration of the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set (SubResource) –
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. An existing VM cannot be added to an availability set.
license_type (str) –
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.
protection_policy (VirtualMachineScaleSetVMProtectionPolicy) – Specifies the protection policy of the virtual machine.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMExtension(*, location: str | None = None, force_update_tag: str | None = None, publisher: str | None = None, type_properties_type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, instance_view: _models.VirtualMachineExtensionInstanceView | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, provision_after_extensions: List[str] | None = None, **kwargs: Any)[source]¶

Bases: SubResourceReadOnly

Describes a VMSS VM Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
name (str) – The name of the extension.
type (str) – Resource type.
location (str) – The location of the extension.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.

Keyword Arguments:

location (str) – The location of the extension.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
instance_view (VirtualMachineExtensionInstanceView) – The virtual machine extension instance view.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.
provision_after_extensions (list[str]) – Collection of extension names after which this extension needs to be provisioned.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMExtensionUpdate(*, force_update_tag: str | None = None, publisher: str | None = None, type_properties_type: str | None = None, type_handler_version: str | None = None, auto_upgrade_minor_version: bool | None = None, enable_automatic_upgrade: bool | None = None, settings: MutableMapping[str, Any] | None = None, protected_settings: MutableMapping[str, Any] | None = None, suppress_failures: bool | None = None, protected_settings_from_key_vault: _models.KeyVaultSecretReference | None = None, **kwargs: Any)[source]¶

Bases: SubResourceReadOnly

Describes a VMSS VM Extension.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource Id.
name (str) – The name of the extension.
type (str) – Resource type.
force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

Keyword Arguments:

force_update_tag (str) – How the extension handler should be forced to update even if the extension configuration has not changed.
publisher (str) – The name of the extension handler publisher.
type_properties_type (str) – Specifies the type of the extension; an example is “CustomScriptExtension”.
type_handler_version (str) – Specifies the version of the script handler.
auto_upgrade_minor_version (bool) – 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.
enable_automatic_upgrade (bool) – Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings (JSON) – Json formatted public settings for the extension.
protected_settings (JSON) – The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
suppress_failures (bool) – 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.
protected_settings_from_key_vault (KeyVaultSecretReference) – The extensions protected settings that are passed by reference, and consumed from key vault.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMExtensionsListResult(*, value: List[_models.VirtualMachineScaleSetVMExtension] | None = None, **kwargs: Any)[source]¶

Bases: Model

The List VMSS VM Extension operation response.

Variables:: value (list[VirtualMachineScaleSetVMExtension]) – The list of VMSS VM extensions.
Keyword Arguments:: value (list[VirtualMachineScaleSetVMExtension]) – The list of VMSS VM extensions.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMExtensionsSummary(**kwargs: Any)[source]¶

Bases: Model

Extensions summary for virtual machines of a virtual machine scale set.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – The extension name.
statuses_summary (list[VirtualMachineStatusCodeCount]) – The extensions information.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMInstanceIDs(*, instance_ids: List[str] | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies a list of virtual machine instance IDs from the VM scale set.

Variables:: instance_ids (list[str]) – The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.
Keyword Arguments:: instance_ids (list[str]) – The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMInstanceRequiredIDs(*, instance_ids: List[str], **kwargs: Any)[source]¶

Bases: Model

Specifies a list of virtual machine instance IDs from the VM scale set.

All required parameters must be populated in order to send to server.

Variables:: instance_ids (list[str]) – The virtual machine scale set instance ids. Required.
Keyword Arguments:: instance_ids (list[str]) – The virtual machine scale set instance ids. Required.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMInstanceView(*, platform_update_domain: int | None = None, platform_fault_domain: int | None = None, rdp_thumb_print: str | None = None, vm_agent: _models.VirtualMachineAgentInstanceView | None = None, maintenance_redeploy_status: _models.MaintenanceRedeployStatus | None = None, disks: List[_models.DiskInstanceView] | None = None, extensions: List[_models.VirtualMachineExtensionInstanceView] | None = None, boot_diagnostics: _models.BootDiagnosticsInstanceView | None = None, statuses: List[_models.InstanceViewStatus] | None = None, placement_group_id: str | None = None, computer_name: str | None = None, os_name: str | None = None, os_version: str | None = None, hyper_v_generation: str | _models.HyperVGeneration | None = None, **kwargs: Any)[source]¶

Bases: Model

The instance view of a virtual machine scale set VM.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

platform_update_domain (int) – The Update Domain count.
platform_fault_domain (int) – The Fault Domain count.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The disks information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
vm_health (VirtualMachineHealthStatus) – The health status for the VM.
boot_diagnostics (BootDiagnosticsInstanceView) – 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.
statuses (list[InstanceViewStatus]) – The resource status information.
assigned_host (str) – 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.
placement_group_id (str) – The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
computer_name (str) –
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. # pylint: disable=line-too-long
os_name (str) – The Operating System running on the hybrid machine.
os_version (str) – The version of Operating System running on the hybrid machine.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: “V1” and “V2”.

Keyword Arguments:

platform_update_domain (int) – The Update Domain count.
platform_fault_domain (int) – The Fault Domain count.
rdp_thumb_print (str) – The Remote desktop certificate thumbprint.
vm_agent (VirtualMachineAgentInstanceView) – The VM Agent running on the virtual machine.
maintenance_redeploy_status (MaintenanceRedeployStatus) – The Maintenance Operation status on the virtual machine.
disks (list[DiskInstanceView]) – The disks information.
extensions (list[VirtualMachineExtensionInstanceView]) – The extensions information.
boot_diagnostics (BootDiagnosticsInstanceView) – 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.
statuses (list[InstanceViewStatus]) – The resource status information.
placement_group_id (str) – The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
computer_name (str) –
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. # pylint: disable=line-too-long
os_name (str) – The Operating System running on the hybrid machine.
os_version (str) – The version of Operating System running on the hybrid machine.
hyper_v_generation (str or HyperVGeneration) – The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: “V1” and “V2”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMListResult(*, value: List[_models.VirtualMachineScaleSetVM], next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Virtual Machine Scale Set VMs operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[VirtualMachineScaleSetVM]) – The list of virtual machine scale sets VMs. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs.

Keyword Arguments:

value (list[VirtualMachineScaleSetVM]) – The list of virtual machine scale sets VMs. Required.
next_link (str) – The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMNetworkProfileConfiguration(*, network_interface_configurations: List[_models.VirtualMachineScaleSetNetworkConfiguration] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set VM network profile.

Variables:: network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.
Keyword Arguments:: network_interface_configurations (list[VirtualMachineScaleSetNetworkConfiguration]) – The list of network configurations.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMProfile(*, os_profile: _models.VirtualMachineScaleSetOSProfile | None = None, storage_profile: _models.VirtualMachineScaleSetStorageProfile | None = None, network_profile: _models.VirtualMachineScaleSetNetworkProfile | None = None, security_profile: _models.SecurityProfile | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, extension_profile: _models.VirtualMachineScaleSetExtensionProfile | None = None, license_type: str | None = None, priority: str | _models.VirtualMachinePriorityTypes | None = None, eviction_policy: str | _models.VirtualMachineEvictionPolicyTypes | None = None, billing_profile: _models.BillingProfile | None = None, scheduled_events_profile: _models.ScheduledEventsProfile | None = None, user_data: str | None = None, capacity_reservation: _models.CapacityReservationProfile | None = None, application_profile: _models.ApplicationProfile | None = None, hardware_profile: _models.VirtualMachineScaleSetHardwareProfile | None = None, service_artifact_reference: _models.ServiceArtifactReference | None = None, security_posture_reference: _models.SecurityPostureReference | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes a virtual machine scale set virtual machine profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

os_profile (VirtualMachineScaleSetOSProfile) – Specifies the operating system settings for the virtual machines in the scale set.
storage_profile (VirtualMachineScaleSetStorageProfile) – Specifies the storage settings for the virtual machine disks.
network_profile (VirtualMachineScaleSetNetworkProfile) – Specifies properties of the network interfaces of the virtual machines in the scale set.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machines in the scale set.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
extension_profile (VirtualMachineScaleSetExtensionProfile) – Specifies a collection of settings for extensions installed on virtual machines in the scale set.
license_type (str) –
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.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. Known values are: “Regular”, “Low”, and “Spot”.
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – 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. Known values are: “Deallocate” and “Delete”.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – 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.
capacity_reservation (CapacityReservationProfile) – Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.
application_profile (ApplicationProfile) – Specifies the gallery applications that should be made available to the VM/VMSS.
hardware_profile (VirtualMachineScaleSetHardwareProfile) – Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.
service_artifact_reference (ServiceArtifactReference) – Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using ‘latest’ image version. Minimum api-version: 2022-11-01.
security_posture_reference (SecurityPostureReference) – Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01.
time_created (datetime) – Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01.

Keyword Arguments:

os_profile (VirtualMachineScaleSetOSProfile) – Specifies the operating system settings for the virtual machines in the scale set.
storage_profile (VirtualMachineScaleSetStorageProfile) – Specifies the storage settings for the virtual machine disks.
network_profile (VirtualMachineScaleSetNetworkProfile) – Specifies properties of the network interfaces of the virtual machines in the scale set.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machines in the scale set.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
extension_profile (VirtualMachineScaleSetExtensionProfile) – Specifies a collection of settings for extensions installed on virtual machines in the scale set.
license_type (str) –
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.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. Known values are: “Regular”, “Low”, and “Spot”.
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – 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. Known values are: “Deallocate” and “Delete”.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – 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.
capacity_reservation (CapacityReservationProfile) – Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.
application_profile (ApplicationProfile) – Specifies the gallery applications that should be made available to the VM/VMSS.
hardware_profile (VirtualMachineScaleSetHardwareProfile) – Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.
service_artifact_reference (ServiceArtifactReference) – Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using ‘latest’ image version. Minimum api-version: 2022-11-01.
security_posture_reference (SecurityPostureReference) – Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMProtectionPolicy(*, protect_from_scale_in: bool | None = None, protect_from_scale_set_actions: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

The protection policy of a virtual machine scale set VM.

Variables:

protect_from_scale_in (bool) – Indicates that the virtual machine scale set VM shouldn’t be considered for deletion during a scale-in operation.
protect_from_scale_set_actions (bool) – Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.

Keyword Arguments:

protect_from_scale_in (bool) – Indicates that the virtual machine scale set VM shouldn’t be considered for deletion during a scale-in operation.
protect_from_scale_set_actions (bool) – Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineScaleSetVMReimageParameters(*, temp_disk: bool | None = None, exact_version: str | None = None, os_profile: _models.OSProfileProvisioningData | None = None, force_update_os_disk_for_ephemeral: bool | None = None, **kwargs: Any)[source]¶

Bases: VirtualMachineReimageParameters

Describes a Virtual Machine Scale Set VM Reimage Parameters.

Variables:

temp_disk (bool) – Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
exact_version (str) – Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
os_profile (OSProfileProvisioningData) – Specifies information required for reimaging the non-ephemeral OS disk.
force_update_os_disk_for_ephemeral (bool) – Parameter to force update ephemeral OS disk for a virtual machine scale set VM.

Keyword Arguments:

temp_disk (bool) – Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk.
exact_version (str) – Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
os_profile (OSProfileProvisioningData) – Specifies information required for reimaging the non-ephemeral OS disk.
force_update_os_disk_for_ephemeral (bool) – Parameter to force update ephemeral OS disk for a virtual machine scale set VM.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineSize(*, name: str | None = None, number_of_cores: int | None = None, os_disk_size_in_mb: int | None = None, resource_disk_size_in_mb: int | None = None, memory_in_mb: int | None = None, max_data_disk_count: int | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes the properties of a VM size.

Variables:

name (str) – The name of the virtual machine size.
number_of_cores (int) – The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list.
os_disk_size_in_mb (int) – The OS disk size, in MB, allowed by the virtual machine size.
resource_disk_size_in_mb (int) – The resource disk size, in MB, allowed by the virtual machine size.
memory_in_mb (int) – The amount of memory, in MB, supported by the virtual machine size.
max_data_disk_count (int) – The maximum number of data disks that can be attached to the virtual machine size.

Keyword Arguments:

name (str) – The name of the virtual machine size.
number_of_cores (int) – The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list.
os_disk_size_in_mb (int) – The OS disk size, in MB, allowed by the virtual machine size.
resource_disk_size_in_mb (int) – The resource disk size, in MB, allowed by the virtual machine size.
memory_in_mb (int) – The amount of memory, in MB, supported by the virtual machine size.
max_data_disk_count (int) – The maximum number of data disks that can be attached to the virtual machine size.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineSizeListResult(*, value: List[_models.VirtualMachineSize] | None = None, **kwargs: Any)[source]¶

Bases: Model

The List Virtual Machine operation response.

Variables:: value (list[VirtualMachineSize]) – The list of virtual machine sizes.
Keyword Arguments:: value (list[VirtualMachineSize]) – The list of virtual machine sizes.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineSizeTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The 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.

BASIC_A0 = 'Basic_A0'¶

BASIC_A1 = 'Basic_A1'¶

BASIC_A2 = 'Basic_A2'¶

BASIC_A3 = 'Basic_A3'¶

BASIC_A4 = 'Basic_A4'¶

STANDARD_A0 = 'Standard_A0'¶

STANDARD_A1 = 'Standard_A1'¶

STANDARD_A10 = 'Standard_A10'¶

STANDARD_A11 = 'Standard_A11'¶

STANDARD_A1_V2 = 'Standard_A1_v2'¶

STANDARD_A2 = 'Standard_A2'¶

STANDARD_A2_M_V2 = 'Standard_A2m_v2'¶

STANDARD_A2_V2 = 'Standard_A2_v2'¶

STANDARD_A3 = 'Standard_A3'¶

STANDARD_A4 = 'Standard_A4'¶

STANDARD_A4_M_V2 = 'Standard_A4m_v2'¶

STANDARD_A4_V2 = 'Standard_A4_v2'¶

STANDARD_A5 = 'Standard_A5'¶

STANDARD_A6 = 'Standard_A6'¶

STANDARD_A7 = 'Standard_A7'¶

STANDARD_A8 = 'Standard_A8'¶

STANDARD_A8_M_V2 = 'Standard_A8m_v2'¶

STANDARD_A8_V2 = 'Standard_A8_v2'¶

STANDARD_A9 = 'Standard_A9'¶

STANDARD_B1_MS = 'Standard_B1ms'¶

STANDARD_B1_S = 'Standard_B1s'¶

STANDARD_B2_MS = 'Standard_B2ms'¶

STANDARD_B2_S = 'Standard_B2s'¶

STANDARD_B4_MS = 'Standard_B4ms'¶

STANDARD_B8_MS = 'Standard_B8ms'¶

STANDARD_D1 = 'Standard_D1'¶

STANDARD_D11 = 'Standard_D11'¶

STANDARD_D11_V2 = 'Standard_D11_v2'¶

STANDARD_D12 = 'Standard_D12'¶

STANDARD_D12_V2 = 'Standard_D12_v2'¶

STANDARD_D13 = 'Standard_D13'¶

STANDARD_D13_V2 = 'Standard_D13_v2'¶

STANDARD_D14 = 'Standard_D14'¶

STANDARD_D14_V2 = 'Standard_D14_v2'¶

STANDARD_D15_V2 = 'Standard_D15_v2'¶

STANDARD_D16_S_V3 = 'Standard_D16s_v3'¶

STANDARD_D16_V3 = 'Standard_D16_v3'¶

STANDARD_D1_V2 = 'Standard_D1_v2'¶

STANDARD_D2 = 'Standard_D2'¶

STANDARD_D2_S_V3 = 'Standard_D2s_v3'¶

STANDARD_D2_V2 = 'Standard_D2_v2'¶

STANDARD_D2_V3 = 'Standard_D2_v3'¶

STANDARD_D3 = 'Standard_D3'¶

STANDARD_D32_S_V3 = 'Standard_D32s_v3'¶

STANDARD_D32_V3 = 'Standard_D32_v3'¶

STANDARD_D3_V2 = 'Standard_D3_v2'¶

STANDARD_D4 = 'Standard_D4'¶

STANDARD_D4_S_V3 = 'Standard_D4s_v3'¶

STANDARD_D4_V2 = 'Standard_D4_v2'¶

STANDARD_D4_V3 = 'Standard_D4_v3'¶

STANDARD_D5_V2 = 'Standard_D5_v2'¶

STANDARD_D64_S_V3 = 'Standard_D64s_v3'¶

STANDARD_D64_V3 = 'Standard_D64_v3'¶

STANDARD_D8_S_V3 = 'Standard_D8s_v3'¶

STANDARD_D8_V3 = 'Standard_D8_v3'¶

STANDARD_DS1 = 'Standard_DS1'¶

STANDARD_DS11 = 'Standard_DS11'¶

STANDARD_DS11_V2 = 'Standard_DS11_v2'¶

STANDARD_DS12 = 'Standard_DS12'¶

STANDARD_DS12_V2 = 'Standard_DS12_v2'¶

STANDARD_DS13 = 'Standard_DS13'¶

STANDARD_DS13_2_V2 = 'Standard_DS13-2_v2'¶

STANDARD_DS13_4_V2 = 'Standard_DS13-4_v2'¶

STANDARD_DS13_V2 = 'Standard_DS13_v2'¶

STANDARD_DS14 = 'Standard_DS14'¶

STANDARD_DS14_4_V2 = 'Standard_DS14-4_v2'¶

STANDARD_DS14_8_V2 = 'Standard_DS14-8_v2'¶

STANDARD_DS14_V2 = 'Standard_DS14_v2'¶

STANDARD_DS15_V2 = 'Standard_DS15_v2'¶

STANDARD_DS1_V2 = 'Standard_DS1_v2'¶

STANDARD_DS2 = 'Standard_DS2'¶

STANDARD_DS2_V2 = 'Standard_DS2_v2'¶

STANDARD_DS3 = 'Standard_DS3'¶

STANDARD_DS3_V2 = 'Standard_DS3_v2'¶

STANDARD_DS4 = 'Standard_DS4'¶

STANDARD_DS4_V2 = 'Standard_DS4_v2'¶

STANDARD_DS5_V2 = 'Standard_DS5_v2'¶

STANDARD_E16_S_V3 = 'Standard_E16s_v3'¶

STANDARD_E16_V3 = 'Standard_E16_v3'¶

STANDARD_E2_S_V3 = 'Standard_E2s_v3'¶

STANDARD_E2_V3 = 'Standard_E2_v3'¶

STANDARD_E32_16_V3 = 'Standard_E32-16_v3'¶

STANDARD_E32_8_S_V3 = 'Standard_E32-8s_v3'¶

STANDARD_E32_S_V3 = 'Standard_E32s_v3'¶

STANDARD_E32_V3 = 'Standard_E32_v3'¶

STANDARD_E4_S_V3 = 'Standard_E4s_v3'¶

STANDARD_E4_V3 = 'Standard_E4_v3'¶

STANDARD_E64_16_S_V3 = 'Standard_E64-16s_v3'¶

STANDARD_E64_32_S_V3 = 'Standard_E64-32s_v3'¶

STANDARD_E64_S_V3 = 'Standard_E64s_v3'¶

STANDARD_E64_V3 = 'Standard_E64_v3'¶

STANDARD_E8_S_V3 = 'Standard_E8s_v3'¶

STANDARD_E8_V3 = 'Standard_E8_v3'¶

STANDARD_F1 = 'Standard_F1'¶

STANDARD_F16 = 'Standard_F16'¶

STANDARD_F16_S = 'Standard_F16s'¶

STANDARD_F16_S_V2 = 'Standard_F16s_v2'¶

STANDARD_F1_S = 'Standard_F1s'¶

STANDARD_F2 = 'Standard_F2'¶

STANDARD_F2_S = 'Standard_F2s'¶

STANDARD_F2_S_V2 = 'Standard_F2s_v2'¶

STANDARD_F32_S_V2 = 'Standard_F32s_v2'¶

STANDARD_F4 = 'Standard_F4'¶

STANDARD_F4_S = 'Standard_F4s'¶

STANDARD_F4_S_V2 = 'Standard_F4s_v2'¶

STANDARD_F64_S_V2 = 'Standard_F64s_v2'¶

STANDARD_F72_S_V2 = 'Standard_F72s_v2'¶

STANDARD_F8 = 'Standard_F8'¶

STANDARD_F8_S = 'Standard_F8s'¶

STANDARD_F8_S_V2 = 'Standard_F8s_v2'¶

STANDARD_G1 = 'Standard_G1'¶

STANDARD_G2 = 'Standard_G2'¶

STANDARD_G3 = 'Standard_G3'¶

STANDARD_G4 = 'Standard_G4'¶

STANDARD_G5 = 'Standard_G5'¶

STANDARD_GS1 = 'Standard_GS1'¶

STANDARD_GS2 = 'Standard_GS2'¶

STANDARD_GS3 = 'Standard_GS3'¶

STANDARD_GS4 = 'Standard_GS4'¶

STANDARD_GS4_4 = 'Standard_GS4-4'¶

STANDARD_GS4_8 = 'Standard_GS4-8'¶

STANDARD_GS5 = 'Standard_GS5'¶

STANDARD_GS5_16 = 'Standard_GS5-16'¶

STANDARD_GS5_8 = 'Standard_GS5-8'¶

STANDARD_H16 = 'Standard_H16'¶

STANDARD_H16_M = 'Standard_H16m'¶

STANDARD_H16_MR = 'Standard_H16mr'¶

STANDARD_H16_R = 'Standard_H16r'¶

STANDARD_H8 = 'Standard_H8'¶

STANDARD_H8_M = 'Standard_H8m'¶

STANDARD_L16_S = 'Standard_L16s'¶

STANDARD_L32_S = 'Standard_L32s'¶

STANDARD_L4_S = 'Standard_L4s'¶

STANDARD_L8_S = 'Standard_L8s'¶

STANDARD_M128_32_MS = 'Standard_M128-32ms'¶

STANDARD_M128_64_MS = 'Standard_M128-64ms'¶

STANDARD_M128_MS = 'Standard_M128ms'¶

STANDARD_M128_S = 'Standard_M128s'¶

STANDARD_M64_16_MS = 'Standard_M64-16ms'¶

STANDARD_M64_32_MS = 'Standard_M64-32ms'¶

STANDARD_M64_MS = 'Standard_M64ms'¶

STANDARD_M64_S = 'Standard_M64s'¶

STANDARD_NC12 = 'Standard_NC12'¶

STANDARD_NC12_S_V2 = 'Standard_NC12s_v2'¶

STANDARD_NC12_S_V3 = 'Standard_NC12s_v3'¶

STANDARD_NC24 = 'Standard_NC24'¶

STANDARD_NC24_R = 'Standard_NC24r'¶

STANDARD_NC24_RS_V2 = 'Standard_NC24rs_v2'¶

STANDARD_NC24_RS_V3 = 'Standard_NC24rs_v3'¶

STANDARD_NC24_S_V2 = 'Standard_NC24s_v2'¶

STANDARD_NC24_S_V3 = 'Standard_NC24s_v3'¶

STANDARD_NC6 = 'Standard_NC6'¶

STANDARD_NC6_S_V2 = 'Standard_NC6s_v2'¶

STANDARD_NC6_S_V3 = 'Standard_NC6s_v3'¶

STANDARD_ND12_S = 'Standard_ND12s'¶

STANDARD_ND24_RS = 'Standard_ND24rs'¶

STANDARD_ND24_S = 'Standard_ND24s'¶

STANDARD_ND6_S = 'Standard_ND6s'¶

STANDARD_NV12 = 'Standard_NV12'¶

STANDARD_NV24 = 'Standard_NV24'¶

STANDARD_NV6 = 'Standard_NV6'¶

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineSoftwarePatchProperties(**kwargs: Any)[source]¶

Bases: Model

Describes the properties of a Virtual Machine software patch.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

patch_id (str) – A unique identifier for the patch.
name (str) – The friendly name of the patch.
version (str) – The version number of the patch. This property applies only to Linux patches.
kb_id (str) – The KBID of the patch. Only applies to Windows patches.
classifications (list[str]) – The classification(s) of the patch as provided by the patch publisher.
reboot_behavior (str or VMGuestPatchRebootBehavior) – Describes the reboot requirements of the patch. Known values are: “Unknown”, “NeverReboots”, “AlwaysRequiresReboot”, and “CanRequestReboot”.
activity_id (str) – The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
published_date (datetime) – The UTC timestamp when the repository published this patch.
last_modified_date_time (datetime) – The UTC timestamp of the last update to this patch record.
assessment_state (str or PatchAssessmentState) – Describes the availability of a given patch. Known values are: “Unknown” and “Available”.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineStatusCodeCount(**kwargs: Any)[source]¶

Bases: Model

The status code and count of the virtual machine scale set instance view status summary.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The instance view status code.
count (int) – The number of instances having a particular status code.

class azure.mgmt.compute.v2024_07_01.models.VirtualMachineUpdate(*, tags: Dict[str, str] | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineIdentity | None = None, zones: List[str] | None = None, hardware_profile: _models.HardwareProfile | None = None, scheduled_events_policy: _models.ScheduledEventsPolicy | None = None, storage_profile: _models.StorageProfile | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, os_profile: _models.OSProfile | None = None, network_profile: _models.NetworkProfile | None = None, security_profile: _models.SecurityProfile | None = None, diagnostics_profile: _models.DiagnosticsProfile | None = None, availability_set: _models.SubResource | None = None, virtual_machine_scale_set: _models.SubResource | None = None, proximity_placement_group: _models.SubResource | None = None, priority: str | _models.VirtualMachinePriorityTypes | None = None, eviction_policy: str | _models.VirtualMachineEvictionPolicyTypes | None = None, billing_profile: _models.BillingProfile | None = None, host: _models.SubResource | None = None, host_group: _models.SubResource | None = None, license_type: str | None = None, extensions_time_budget: str | None = None, platform_fault_domain: int | None = None, scheduled_events_profile: _models.ScheduledEventsProfile | None = None, user_data: str | None = None, capacity_reservation: _models.CapacityReservationProfile | None = None, application_profile: _models.ApplicationProfile | None = None, **kwargs: Any)[source]¶

Bases: UpdateResource

Describes a Virtual Machine Update.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

tags (dict[str, str]) – Resource tags.
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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
zones (list[str]) – The virtual machine zones.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set (SubResource) –
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.
virtual_machine_scale_set (SubResource) – 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.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Known values are: “Regular”, “Low”, and “Spot”.
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – 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. Known values are: “Deallocate” and “Delete”.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
host (SubResource) – Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
host_group (SubResource) – Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.
provisioning_state (str) – The provisioning state, which only appears in the response.
instance_view (VirtualMachineInstanceView) – The virtual machine instance view.
license_type (str) –
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.
vm_id (str) – 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.
extensions_time_budget (str) – 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.
platform_fault_domain (int) – 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’ greater than 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.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
capacity_reservation (CapacityReservationProfile) – Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
application_profile (ApplicationProfile) – Specifies the gallery applications that should be made available to the VM/VMSS.
time_created (datetime) – Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
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.
identity (VirtualMachineIdentity) – The identity of the virtual machine, if configured.
zones (list[str]) – The virtual machine zones.
hardware_profile (HardwareProfile) – Specifies the hardware settings for the virtual machine.
scheduled_events_policy (ScheduledEventsPolicy) – Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
storage_profile (StorageProfile) – Specifies the storage settings for the virtual machine disks.
additional_capabilities (AdditionalCapabilities) – Specifies additional capabilities enabled or disabled on the virtual machine.
os_profile (OSProfile) – Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
network_profile (NetworkProfile) – Specifies the network interfaces of the virtual machine.
security_profile (SecurityProfile) – Specifies the Security related profile settings for the virtual machine.
diagnostics_profile (DiagnosticsProfile) – Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
availability_set (SubResource) –
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.
virtual_machine_scale_set (SubResource) – 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.
proximity_placement_group (SubResource) – Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
priority (str or VirtualMachinePriorityTypes) – Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01. Known values are: “Regular”, “Low”, and “Spot”.
eviction_policy (str or VirtualMachineEvictionPolicyTypes) – 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. Known values are: “Deallocate” and “Delete”.
billing_profile (BillingProfile) – Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
host (SubResource) – Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.
host_group (SubResource) – Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.
license_type (str) –
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.
extensions_time_budget (str) – 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.
platform_fault_domain (int) – 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’ greater than 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.
scheduled_events_profile (ScheduledEventsProfile) – Specifies Scheduled Event related configurations.
user_data (str) – UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.
capacity_reservation (CapacityReservationProfile) – Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
application_profile (ApplicationProfile) – Specifies the gallery applications that should be made available to the VM/VMSS.

class azure.mgmt.compute.v2024_07_01.models.VmDiskTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

VM disk types which are disallowed.

NONE = 'None'¶

UNMANAGED = 'Unmanaged'¶

class azure.mgmt.compute.v2024_07_01.models.VmImagesInEdgeZoneListResult(*, value: List[_models.VirtualMachineImageResource] | None = None, next_link: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The List VmImages in EdgeZone operation response.

Variables:

value (list[VirtualMachineImageResource]) – The list of VMImages in EdgeZone.
next_link (str) – The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages.

Keyword Arguments:

value (list[VirtualMachineImageResource]) – The list of VMImages in EdgeZone.
next_link (str) – The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages.

class azure.mgmt.compute.v2024_07_01.models.WinRMConfiguration(*, listeners: List[_models.WinRMListener] | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes Windows Remote Management configuration of the VM.

Variables:: listeners (list[WinRMListener]) – The list of Windows Remote Management listeners.
Keyword Arguments:: listeners (list[WinRMListener]) – The list of Windows Remote Management listeners.

class azure.mgmt.compute.v2024_07_01.models.WinRMListener(*, protocol: str | _models.ProtocolTypes | None = None, certificate_url: str | None = None, **kwargs: Any)[source]¶

Bases: Model

Describes Protocol and thumbprint of Windows Remote Management listener.

Variables:

protocol (str or ProtocolTypes) – Specifies the protocol of WinRM listener. Possible values are: http, https.. Known values are: “Http” and “Https”.
certificate_url (str) –
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 the Base64 encoding of the following JSON Object which is encoded in UTF-8:   {  “data”:”<Base64-encoded-certificate>”,  “dataType”:”pfx”,  “password”:”<pfx-file-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.

Keyword Arguments:

protocol (str or ProtocolTypes) – Specifies the protocol of WinRM listener. Possible values are: http, https.. Known values are: “Http” and “Https”.
certificate_url (str) –
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 the Base64 encoding of the following JSON Object which is encoded in UTF-8:   {  “data”:”<Base64-encoded-certificate>”,  “dataType”:”pfx”,  “password”:”<pfx-file-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.

class azure.mgmt.compute.v2024_07_01.models.WindowsConfiguration(*, provision_vm_agent: bool | None = None, enable_automatic_updates: bool | None = None, time_zone: str | None = None, additional_unattend_content: List[_models.AdditionalUnattendContent] | None = None, patch_settings: _models.PatchSettings | None = None, win_rm: _models.WinRMConfiguration | None = None, **kwargs: Any)[source]¶

Bases: Model

Specifies Windows operating system settings on the virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provision_vm_agent (bool) – Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
enable_automatic_updates (bool) – Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
time_zone (str) – Specifies the time zone of the virtual machine. e.g. “Pacific Standard Time”. Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
additional_unattend_content (list[AdditionalUnattendContent]) – Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
patch_settings (PatchSettings) – [Preview Feature] Specifies settings related to VM Guest Patching on Windows.
win_rm (WinRMConfiguration) – Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
enable_vm_agent_platform_updates (bool) – Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine.

Keyword Arguments:

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

class azure.mgmt.compute.v2024_07_01.models.WindowsParameters(*, classifications_to_include: List[str | _models.VMGuestPatchClassificationWindows] | None = None, kb_numbers_to_include: List[str] | None = None, kb_numbers_to_exclude: List[str] | None = None, exclude_kbs_requiring_reboot: bool | None = None, max_patch_publish_date: datetime | None = None, **kwargs: Any)[source]¶

Bases: Model

Input for InstallPatches on a Windows VM, as directly received by the API.

Variables:

classifications_to_include (list[str or VMGuestPatchClassificationWindows]) – The update classifications to select when installing patches for Windows.
kb_numbers_to_include (list[str]) – Kbs to include in the patch operation.
kb_numbers_to_exclude (list[str]) – Kbs to exclude in the patch operation.
exclude_kbs_requiring_reboot (bool) – Filters out Kbs that don’t have an InstallationRebootBehavior of ‘NeverReboots’ when this is set to true.
max_patch_publish_date (datetime) – This is used to install patches that were published on or before this given max published date.

Keyword Arguments:

classifications_to_include (list[str or VMGuestPatchClassificationWindows]) – The update classifications to select when installing patches for Windows.
kb_numbers_to_include (list[str]) – Kbs to include in the patch operation.
kb_numbers_to_exclude (list[str]) – Kbs to exclude in the patch operation.
exclude_kbs_requiring_reboot (bool) – Filters out Kbs that don’t have an InstallationRebootBehavior of ‘NeverReboots’ when this is set to true.
max_patch_publish_date (datetime) – This is used to install patches that were published on or before this given max published date.

class azure.mgmt.compute.v2024_07_01.models.WindowsPatchAssessmentMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'¶

IMAGE_DEFAULT = 'ImageDefault'¶

class azure.mgmt.compute.v2024_07_01.models.WindowsVMGuestPatchAutomaticByPlatformRebootSetting(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

ALWAYS = 'Always'¶

IF_REQUIRED = 'IfRequired'¶

NEVER = 'Never'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.compute.v2024_07_01.models.WindowsVMGuestPatchAutomaticByPlatformSettings(*, reboot_setting: str | _models.WindowsVMGuestPatchAutomaticByPlatformRebootSetting | None = None, bypass_platform_safety_checks_on_user_schedule: bool | None = None, **kwargs: Any)[source]¶

Bases: Model

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

Variables:

reboot_setting (str or WindowsVMGuestPatchAutomaticByPlatformRebootSetting) – Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values are: “Unknown”, “IfRequired”, “Never”, and “Always”.
bypass_platform_safety_checks_on_user_schedule (bool) – Enables customer to schedule patching without accidental upgrades.

Keyword Arguments:

reboot_setting (str or WindowsVMGuestPatchAutomaticByPlatformRebootSetting) – Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values are: “Unknown”, “IfRequired”, “Never”, and “Always”.
bypass_platform_safety_checks_on_user_schedule (bool) – Enables customer to schedule patching without accidental upgrades.

class azure.mgmt.compute.v2024_07_01.models.WindowsVMGuestPatchMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

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.

AUTOMATIC_BY_OS = 'AutomaticByOS'¶

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'¶

MANUAL = 'Manual'¶

class azure.mgmt.compute.v2024_07_01.models.ZonalPlatformFaultDomainAlignMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.

ALIGNED = 'Aligned'¶

UNALIGNED = 'Unaligned'¶