azure.mgmt.computefleet.models module

class azure.mgmt.computefleet.models.ActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'

Actions are for internal-only APIs.

class azure.mgmt.computefleet.models.AdditionalUnattendContent(*args: Any, **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.

component_name: Literal['Microsoft-Windows-Shell-Setup'] | None

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Default value is “Microsoft-Windows-Shell-Setup”.

content: str | None

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.

pass_name: Literal['OobeSystem'] | None

The pass name. Currently, the only allowable value is OobeSystem. Default value is “OobeSystem”.

setting_name: str | _models.SettingNames | None

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

class azure.mgmt.computefleet.models.ApiEntityReference(*args: Any, **kwargs: Any)[source]

Bases: Model

The API entity reference.

Variables:

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

id: str | None

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

class azure.mgmt.computefleet.models.ApiError(*args: Any, **kwargs: Any)[source]

Bases: Model

ApiError for Fleet.

Variables:

  • code (str) – The error code.

  • target (str) – The target of the particular error.

  • message (str) – The error message.

  • details (list[ApiErrorBase]) – The API error details.

  • innererror (InnerError) – The API inner error.

code: str | None

The error code.

details: List[_models.ApiErrorBase] | None

The API error details.

innererror: _models.InnerError | None

The API inner error.

message: str | None

The error message.

target: str | None

The target of the particular error.

class azure.mgmt.computefleet.models.ApiErrorBase(*args: Any, **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.

code: str | None

The error code.

message: str | None

The error message.

target: str | None

The target of the particular error.

class azure.mgmt.computefleet.models.ApplicationProfile(*args: Any, **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.

gallery_applications: List[_models.VMGalleryApplication] | None

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

class azure.mgmt.computefleet.models.BaseVirtualMachineProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes the base virtual machine profile for fleet.

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

  • 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. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15.

  • 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 for all virtual machines 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. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: “2024-07-01T00:00:01.1234567+00:00”.

application_profile: _models.ApplicationProfile | None

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

capacity_reservation: _models.CapacityReservationProfile | None

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

diagnostics_profile: _models.DiagnosticsProfile | None

Specifies the boot diagnostic settings state.

extension_profile: _models.VirtualMachineScaleSetExtensionProfile | None

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

hardware_profile: _models.VirtualMachineScaleSetHardwareProfile | None

Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.

license_type: str | None

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15.

network_profile: _models.VirtualMachineScaleSetNetworkProfile | None

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

os_profile: _models.VirtualMachineScaleSetOSProfile | None

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

scheduled_events_profile: _models.ScheduledEventsProfile | None

Specifies Scheduled Event related configurations.

security_posture_reference: _models.SecurityPostureReference | None

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

security_profile: _models.SecurityProfile | None

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

service_artifact_reference: _models.ServiceArtifactReference | None

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.

storage_profile: _models.VirtualMachineScaleSetStorageProfile | None

Specifies the storage settings for the virtual machine disks.

time_created: datetime | None

Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: “2024-07-01T00:00:01.1234567+00:00”.

user_data: str | None

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.

class azure.mgmt.computefleet.models.BootDiagnostics(*args: Any, **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.

enabled: bool | None

Whether boot diagnostics should be enabled on the Virtual Machine.

storage_uri: str | None

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.computefleet.models.CachingTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Specifies the caching requirements.

NONE = 'None'

‘None’ is default for Standard Storage

READ_ONLY = 'ReadOnly'

‘ReadOnly’ is default for Premium Storage

READ_WRITE = 'ReadWrite'

‘ReadWrite’ is default for OS Disk

class azure.mgmt.computefleet.models.CapacityReservationProfile(*args: Any, **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.

capacity_reservation_group: _models.SubResource | None

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.computefleet.models.ComputeProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Compute Profile to use for running user’s workloads.

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

Variables:

  • base_virtual_machine_profile (BaseVirtualMachineProfile) – Base Virtual Machine Profile Properties to be specified according to “specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile”. # pylint: disable=line-too-long Required.

  • compute_api_version (str) – Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet.

  • platform_fault_domain_count (int) – Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents “Max Spreading” (using as many fault domains as possible). This property cannot be updated.

base_virtual_machine_profile: _models.BaseVirtualMachineProfile

Base Virtual Machine Profile Properties to be specified according to “specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile”. # pylint: disable=line-too-long Required.

compute_api_version: str | None

Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet.

platform_fault_domain_count: int | None

Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents “Max Spreading” (using as many fault domains as possible). This property cannot be updated.

class azure.mgmt.computefleet.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The kind of entity that created the resource.

APPLICATION = 'Application'

The entity was created by an application.

KEY = 'Key'

The entity was created by a key.

MANAGED_IDENTITY = 'ManagedIdentity'

The entity was created by a managed identity.

USER = 'User'

The entity was created by a user.

class azure.mgmt.computefleet.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'

Delete Option

DETACH = 'Detach'

Detach Option

class azure.mgmt.computefleet.models.DiagnosticsProfile(*args: Any, **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.

boot_diagnostics: _models.BootDiagnostics | None

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

Local Option.

class azure.mgmt.computefleet.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 or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Minimum api-version for NvmeDisk: 2024-03-01.

CACHE_DISK = 'CacheDisk'

CacheDisk option.

NVME_DISK = 'NvmeDisk'

NvmeDisk option.

RESOURCE_DISK = 'ResourceDisk'

Resource Disk option.

class azure.mgmt.computefleet.models.DiffDiskSettings(*args: Any, **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 | _models.DiffDiskOptions | None

Specifies the ephemeral disk settings for operating system disk. “Local”

placement: str | _models.DiffDiskPlacement | None

Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk 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. Known values are: “CacheDisk”, “ResourceDisk”, and “NvmeDisk”.

class azure.mgmt.computefleet.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.

N_V_ME = 'NVMe'

NVMe disk type

SCSI = 'SCSI'

SCSI disk type

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

Bases: str, Enum

Specifies how the virtual machine should be created.

ATTACH = 'Attach'

This value is used when you are using a specialized disk to create the virtual machine.

COPY = 'Copy'

This value is used to create a data disk from a snapshot or another disk.

EMPTY = 'Empty'

This value is used when creating an empty data disk.

FROM_IMAGE = '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.

RESTORE = 'Restore'

This value is used to create a data disk from a disk restore point.

class azure.mgmt.computefleet.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'

If this value is used, the managed disk is deleted when VM gets deleted.

DETACH = 'Detach'

If this value is used, the managed disk is retained after VM gets deleted.

class azure.mgmt.computefleet.models.DiskEncryptionSetParameters(*args: Any, **kwargs: Any)[source]

Bases: Model

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.

id: str | None

Resource Id.

class azure.mgmt.computefleet.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'

NoReuse type

RESOURCE_GROUP_REUSE = 'ResourceGroupReuse'

ResourceGroupReuse type

SUBSCRIPTION_REUSE = 'SubscriptionReuse'

SubscriptionReuse type

TENANT_REUSE = 'TenantReuse'

TenantReuse type

class azure.mgmt.computefleet.models.EncryptionIdentity(*args: Any, **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.

user_assigned_identity_resource_id: str | None

Specifies ARM Resource ID of one of the user identities associated with the VM.

class azure.mgmt.computefleet.models.ErrorAdditionalInfo(*args: Any, **kwargs: Any)[source]

Bases: Model

The resource management error additional info.

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

Variables:

  • type (str) – The additional info type.

  • info (any) – The additional info.

info: Any | None

The additional info.

type: str | None

The additional info type.

class azure.mgmt.computefleet.models.ErrorDetail(*args: Any, **kwargs: Any)[source]

Bases: Model

The error detail.

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

Variables:
additional_info: List[_models.ErrorAdditionalInfo] | None

The error additional info.

code: str | None

The error code.

details: List[_models.ErrorDetail] | None

The error details.

message: str | None

The error message.

target: str | None

The error target.

class azure.mgmt.computefleet.models.ErrorResponse(*args: Any, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Variables:

error (ErrorDetail) – The error object.

error: _models.ErrorDetail | None

The error object.

class azure.mgmt.computefleet.models.EvictionPolicy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Different kind of eviction policies.

DEALLOCATE = 'Deallocate'

When evicted, the Spot VM will be deallocated/stopped

DELETE = 'Delete'

When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this.

class azure.mgmt.computefleet.models.Fleet(*args: Any, **kwargs: Any)[source]

Bases: TrackedResource

An Compute Fleet resource.

Readonly 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) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

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

  • location (str) – The geo-location where the resource lives. Required.

  • properties (FleetProperties) – The resource-specific properties for this resource.

  • zones (list[str]) – Zones in which the Compute Fleet is available.

  • identity (ManagedServiceIdentity) – The managed service identities assigned to this resource.

  • plan (Plan) – Details of the resource plan.

identity: _models.ManagedServiceIdentity | None

The managed service identities assigned to this resource.

plan: _models.Plan | None

Details of the resource plan.

properties: _models.FleetProperties | None

The resource-specific properties for this resource.

zones: List[str] | None

Zones in which the Compute Fleet is available.

class azure.mgmt.computefleet.models.FleetProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of the Compute Fleet.

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

  • provisioning_state (str or ProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, “Deleting”, and “Migrating”.

  • spot_priority_profile (SpotPriorityProfile) – Configuration Options for Spot instances in Compute Fleet.

  • regular_priority_profile (RegularPriorityProfile) – Configuration Options for Regular instances in Compute Fleet.

  • vm_sizes_profile (list[VmSizeProfile]) – List of VM sizes supported for Compute Fleet. Required.

  • compute_profile (ComputeProfile) – Compute Profile to use for running user’s workloads. Required.

  • time_created (datetime) – Specifies the time at which the Compute Fleet is created.

  • unique_id (str) – Specifies the ID which uniquely identifies a Compute Fleet.

compute_profile: _models.ComputeProfile

Compute Profile to use for running user’s workloads. Required.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, “Deleting”, and “Migrating”.

Type:

The status of the last operation. Known values are

regular_priority_profile: _models.RegularPriorityProfile | None

Configuration Options for Regular instances in Compute Fleet.

spot_priority_profile: _models.SpotPriorityProfile | None

Configuration Options for Spot instances in Compute Fleet.

time_created: datetime | None

Specifies the time at which the Compute Fleet is created.

unique_id: str | None

Specifies the ID which uniquely identifies a Compute Fleet.

vm_sizes_profile: List[_models.VmSizeProfile]

List of VM sizes supported for Compute Fleet. Required.

class azure.mgmt.computefleet.models.FleetUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

Fleet Update Model.

Variables:
identity: _models.ManagedServiceIdentityUpdate | None

Updatable managed service identity.

plan: _models.ResourcePlanUpdate | None

Updatable resource plan.

properties: _models.FleetProperties | None

RP-specific updatable properties.

tags: Dict[str, str] | None

Resource tags.

class azure.mgmt.computefleet.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'

IPv4 version

I_PV6 = 'IPv6'

IPv6 version

class azure.mgmt.computefleet.models.ImageReference(*args: Any, **kwargs: Any)[source]

Bases: Model

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.

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

Variables:

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

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

exact_version: str | None

Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from ‘version’, only if the value specified in ‘version’ field is ‘latest’.

id: str | None

Resource Id.

offer: str | None

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

publisher: str | None

The image publisher.

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

sku: str | None

The image SKU.

version: str | None

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.

class azure.mgmt.computefleet.models.InnerError(*args: Any, **kwargs: Any)[source]

Bases: Model

Inner error details.

Variables:

  • exception_type (str) – The exception type.

  • error_detail (str) – The internal error message or exception dump.

error_detail: str | None

The internal error message or exception dump.

exception_type: str | None

The exception type.

class azure.mgmt.computefleet.models.KeyVaultSecretReference(*args: Any, **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.

secret_url: str

The URL referencing a secret in a Key Vault. Required.

source_vault: _models.SubResource

The relative URL of the Key Vault containing the secret. Required.

class azure.mgmt.computefleet.models.LinuxConfiguration(*args: Any, **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_v_m_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_v_m_agent_platform_updates (bool) – Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.

disable_password_authentication: bool | None

Specifies whether password authentication should be disabled.

enable_v_m_agent_platform_updates: bool | None

Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.

patch_settings: _models.LinuxPatchSettings | None

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

provision_v_m_agent: bool | None

Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

ssh: _models.SshConfiguration | None

Specifies the ssh key configuration for a Linux OS.

class azure.mgmt.computefleet.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.:code:<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine. <br /><br /> AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'

The platform will trigger periodic patch assessments.The property provisionVMAgent must be true.

IMAGE_DEFAULT = 'ImageDefault'

You control the timing of patch assessments on a virtual machine.

class azure.mgmt.computefleet.models.LinuxPatchSettings(*args: Any, **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.:code:<br /><br /> Possible values are:<br /><br /> ImageDefault - The virtual machine’s default patching configuration is used. <br /><br /> 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.:code:<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine. <br /><br /> 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.

assessment_mode: str | _models.LinuxPatchAssessmentMode | None

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.:code:<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine. <br /><br /> AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. Known values are: “ImageDefault” and “AutomaticByPlatform”.

automatic_by_platform_settings: _models.LinuxVMGuestPatchAutomaticByPlatformSettings | None

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

patch_mode: str | _models.LinuxVMGuestPatchMode | None

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

class azure.mgmt.computefleet.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'

Always Reboot setting

IF_REQUIRED = 'IfRequired'

IfRequired Reboot setting

NEVER = 'Never'

Never Reboot setting

UNKNOWN = 'Unknown'

Unknown Reboot setting

class azure.mgmt.computefleet.models.LinuxVMGuestPatchAutomaticByPlatformSettings(*args: Any, **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.

bypass_platform_safety_checks_on_user_schedule: bool | None

Enables customer to schedule patching without accidental upgrades.

reboot_setting: str | _models.LinuxVMGuestPatchAutomaticByPlatformRebootSetting | None

Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values are: “Unknown”, “IfRequired”, “Never”, and “Always”.

class azure.mgmt.computefleet.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.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'

The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true.

IMAGE_DEFAULT = 'ImageDefault'

The virtual machine’s default patching configuration is used.

class azure.mgmt.computefleet.models.ManagedServiceIdentity(*args: Any, **kwargs: Any)[source]

Bases: Model

Managed service identity (system assigned and/or user assigned identities).

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

  • principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

  • tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

  • type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

principal_id: str | None

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenant_id: str | None

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type: str | _models.ManagedServiceIdentityType

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:

The type of managed identity assigned to this resource. Required. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None

The identities assigned to this resource by the user.

class azure.mgmt.computefleet.models.ManagedServiceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NONE = 'None'

No managed identity.

SYSTEM_AND_USER_ASSIGNED = 'SystemAssigned,UserAssigned'

System and user assigned managed identity.

SYSTEM_ASSIGNED = 'SystemAssigned'

System assigned managed identity.

USER_ASSIGNED = 'UserAssigned'

User assigned managed identity.

class azure.mgmt.computefleet.models.ManagedServiceIdentityUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The template for adding optional properties.

Variables:

  • type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

type: str | _models.ManagedServiceIdentityType | None

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:

The type of managed identity assigned to this resource. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None

The identities assigned to this resource by the user.

class azure.mgmt.computefleet.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'

Audit Mode

ENFORCE = 'Enforce'

Enforce Mode

class azure.mgmt.computefleet.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 for Virtual Machine Scale Set with orchestration mode ‘Flexible’.

ENUM_2020_11_01 = '2020-11-01'

Initial version supported. Later versions are supported as well.

class azure.mgmt.computefleet.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'

AcceleratedConnections Mode

FLOATING = 'Floating'

Floating Mode

NONE = 'None'

None Mode

class azure.mgmt.computefleet.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'

A1 sku

A2 = 'A2'

A2 sku

A4 = 'A4'

A4 sku

A8 = 'A8'

A8 sku

NONE = 'None'

no sku

class azure.mgmt.computefleet.models.OSImageNotificationProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifies OS Image Scheduled Event related configurations.

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 not exceed 15 minutes (PT15M).

  • enable (bool) – Specifies whether the OS Image Scheduled event is enabled or disabled.

enable: bool | None

Specifies whether the OS Image Scheduled event is enabled or disabled.

not_before_timeout: str | None

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 not exceed 15 minutes (PT15M).

class azure.mgmt.computefleet.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'

Linux OS type

WINDOWS = 'Windows'

Windows OS type

class azure.mgmt.computefleet.models.Operation(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

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

Variables:

  • name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

  • is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.

  • display (OperationDisplay) – Localized display information for this particular operation.

  • origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.

  • action_type (str or ActionType) – Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

action_type: str | _models.ActionType | None

Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

display: _models.OperationDisplay | None

Localized display information for this particular operation.

is_data_action: bool | None

Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.

name: str | None

The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

origin: str | _models.Origin | None

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.

class azure.mgmt.computefleet.models.OperationDisplay(*args: Any, **kwargs: Any)[source]

Bases: Model

Localized display information for and operation.

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

Variables:

  • provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

  • resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

  • operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

  • description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

description: str | None

The short, localized friendly description of the operation; suitable for tool tips and detailed views.

operation: str | None

The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

provider: str | None

The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

resource: str | None

The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

class azure.mgmt.computefleet.models.Origin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'

Indicates the operation is initiated by a system.

USER = 'user'

Indicates the operation is initiated by a user.

USER_SYSTEM = 'user,system'

Indicates the operation is initiated by a user or system.

class azure.mgmt.computefleet.models.PatchSettings(*args: Any, **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.:code:<br /><br /> Possible values are:<br /><br /> 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:code:<br /><br /> AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> 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.:code:<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine.:code:<br /><br /> 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.

assessment_mode: str | _models.WindowsPatchAssessmentMode | None

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.:code:<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine.:code:<br /><br /> AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. Known values are: “ImageDefault” and “AutomaticByPlatform”.

automatic_by_platform_settings: _models.WindowsVMGuestPatchAutomaticByPlatformSettings | None

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

enable_hotpatching: bool | None

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

patch_mode: str | _models.WindowsVMGuestPatchMode | None

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.:code:<br /><br /> Possible values are:<br /><br /> 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:code:<br /><br /> AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> 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”.

class azure.mgmt.computefleet.models.Plan(*args: Any, **kwargs: Any)[source]

Bases: Model

Plan for the resource.

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

Variables:

  • name (str) – A user defined name of the 3rd Party Artifact that is being procured. Required.

  • publisher (str) – The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic. Required.

  • product (str) – The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. Required.

  • promotion_code (str) – A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

  • version (str) – The version of the desired product/artifact.

name: str

A user defined name of the 3rd Party Artifact that is being procured. Required.

product: str

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. Required.

promotion_code: str | None

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

publisher: str

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic. Required.

version: str | None

The version of the desired product/artifact.

class azure.mgmt.computefleet.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'

Http protocol

HTTPS = 'Https'

Https protocol

class azure.mgmt.computefleet.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The status of the current operation.

CANCELED = 'Canceled'

Resource creation was canceled.

CREATING = 'Creating'

Initial creation in progress.

DELETING = 'Deleting'

Deletion in progress.

FAILED = 'Failed'

Resource creation failed.

MIGRATING = 'Migrating'

Resource is being migrated from one subscription or resource group to another.

SUCCEEDED = 'Succeeded'

Resource has been created.

UPDATING = 'Updating'

Update in progress.

class azure.mgmt.computefleet.models.ProxyAgentSettings(*args: Any, **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.

enabled: bool | None

Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.

key_incarnation_id: int | None

Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.

mode: str | _models.Mode | None

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

class azure.mgmt.computefleet.models.PublicIPAddressSku(*args: Any, **kwargs: Any)[source]

Bases: Model

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

Variables:
name: str | _models.PublicIPAddressSkuName | None

“Basic” and “Standard”.

Type:

Specify public IP sku name. Known values are

tier: str | _models.PublicIPAddressSkuTier | None

“Regional” and “Global”.

Type:

Specify public IP sku tier. Known values are

class azure.mgmt.computefleet.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'

Basic sku name

STANDARD = 'Standard'

Standard sku name

class azure.mgmt.computefleet.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 sku tier

REGIONAL = 'Regional'

Regional sku tier

class azure.mgmt.computefleet.models.RegularPriorityAllocationStrategy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Regular VM Allocation strategy types for Compute Fleet.

LOWEST_PRICE = 'LowestPrice'

Default. VM sizes distribution will be determined to optimize for price.

PRIORITIZED = 'Prioritized'

VM sizes distribution will be determined to optimize for the ‘priority’ as specified for each vm size.

class azure.mgmt.computefleet.models.RegularPriorityProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Configuration Options for Regular instances in Compute Fleet.

Variables:

  • capacity (int) – Total capacity to achieve. It is currently in terms of number of VMs.

  • min_capacity (int) – Minimum capacity to achieve which cannot be updated. If we will not be able to “guarantee” minimum capacity, we will reject the request in the sync path itself.

  • allocation_strategy (str or RegularPriorityAllocationStrategy) – Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. Known values are: “LowestPrice” and “Prioritized”.

allocation_strategy: str | _models.RegularPriorityAllocationStrategy | None

Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. Known values are: “LowestPrice” and “Prioritized”.

capacity: int | None

Total capacity to achieve. It is currently in terms of number of VMs.

min_capacity: int | None

Minimum capacity to achieve which cannot be updated. If we will not be able to “guarantee” minimum capacity, we will reject the request in the sync path itself.

class azure.mgmt.computefleet.models.Resource(*args: Any, **kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

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

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

id: str | None

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

name: str | None

The name of the resource.

system_data: _models.SystemData | None

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type: str | None

The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.computefleet.models.ResourcePlanUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The template for adding optional properties.

Variables:

  • name (str) – A user defined name of the 3rd Party Artifact that is being procured.

  • publisher (str) – The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic.

  • product (str) – The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

  • promotion_code (str) – A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

  • version (str) – The version of the desired product/artifact.

name: str | None

A user defined name of the 3rd Party Artifact that is being procured.

product: str | None

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

promotion_code: str | None

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

publisher: str | None

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic.

version: str | None

The version of the desired product/artifact.

class azure.mgmt.computefleet.models.ScheduledEventsProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifies Scheduled Event related configurations.

Variables:
os_image_notification_profile: _models.OSImageNotificationProfile | None

Specifies OS Image Scheduled Event related configurations.

terminate_notification_profile: _models.TerminateNotificationProfile | None

Specifies Terminate Scheduled Event related configurations.

class azure.mgmt.computefleet.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. Note: It can be set for only Confidential VMs.

DISK_WITH_V_M_GUEST_STATE = 'DiskWithVMGuestState'

EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob.

NON_PERSISTED_T_P_M = 'NonPersistedTPM'

EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob.

V_M_GUEST_STATE_ONLY = 'VMGuestStateOnly'

EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob.

class azure.mgmt.computefleet.models.SecurityPostureReference(*args: Any, **kwargs: Any)[source]

Bases: Model

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

Variables:

id – The security posture reference id in the form of

/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest. # pylint: disable=line-too-long :vartype id: str :ivar exclude_extensions: List of virtual machine extension names to exclude when applying the

security posture.

Variables:

is_overridable (bool) – Whether the security posture can be overridden by the user.

exclude_extensions: List[str] | None

List of virtual machine extension names to exclude when applying the security posture.

id: str | None

The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest. # pylint: disable=line-too-long

is_overridable: bool | None

Whether the security posture can be overridden by the user.

class azure.mgmt.computefleet.models.SecurityProfile(*args: Any, **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.

encryption_at_host: bool | None

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.

encryption_identity: _models.EncryptionIdentity | None

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

proxy_agent_settings: _models.ProxyAgentSettings | None

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

security_type: str | _models.SecurityTypes | None

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

uefi_settings: _models.UefiSettings | None

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

class azure.mgmt.computefleet.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_V_M = 'ConfidentialVM'

ConfidentialVM security type

TRUSTED_LAUNCH = 'TrustedLaunch'

TrustedLaunch security type

class azure.mgmt.computefleet.models.ServiceArtifactReference(*args: Any, **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 – 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 :vartype id: str

id: str | None

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

AutoLogon setting

FIRST_LOGON_COMMANDS = 'FirstLogonCommands'

FirstLogonCommands setting

class azure.mgmt.computefleet.models.SpotAllocationStrategy(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Spot allocation strategy types for Compute Fleet.

CAPACITY_OPTIMIZED = 'CapacityOptimized'

VM sizes distribution will be determined to optimize for capacity.

LOWEST_PRICE = 'LowestPrice'

Capacity will still be considered here but will be given much less weight.

Type:

VM sizes distribution will be determined to optimize for price. Note

PRICE_CAPACITY_OPTIMIZED = 'PriceCapacityOptimized'

Default. VM sizes distribution will be determined to optimize for both price and capacity.

class azure.mgmt.computefleet.models.SpotPriorityProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Configuration Options for Spot instances in Compute Fleet.

Variables:

  • capacity (int) – Total capacity to achieve. It is currently in terms of number of VMs.

  • min_capacity (int) – Minimum capacity to achieve which cannot be updated. If we will not be able to “guarantee” minimum capacity, we will reject the request in the sync path itself.

  • max_price_per_v_m (float) – Price per hour of each Spot VM will never exceed this.

  • eviction_policy (str or EvictionPolicy) – Eviction Policy to follow when evicting Spot VMs. Known values are: “Delete” and “Deallocate”.

  • allocation_strategy (str or SpotAllocationStrategy) – Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. Known values are: “PriceCapacityOptimized”, “LowestPrice”, and “CapacityOptimized”.

  • maintain (bool) – Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default.

allocation_strategy: str | _models.SpotAllocationStrategy | None

Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. Known values are: “PriceCapacityOptimized”, “LowestPrice”, and “CapacityOptimized”.

capacity: int | None

Total capacity to achieve. It is currently in terms of number of VMs.

eviction_policy: str | _models.EvictionPolicy | None

“Delete” and “Deallocate”.

Type:

Eviction Policy to follow when evicting Spot VMs. Known values are

maintain: bool | None

Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default.

max_price_per_v_m: float | None

Price per hour of each Spot VM will never exceed this.

min_capacity: int | None

Minimum capacity to achieve which cannot be updated. If we will not be able to “guarantee” minimum capacity, we will reject the request in the sync path itself.

class azure.mgmt.computefleet.models.SshConfiguration(*args: Any, **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.

public_keys: List[_models.SshPublicKey] | None

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

class azure.mgmt.computefleet.models.SshPublicKey(*args: Any, **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).

key_data: str | None

SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path: str | None

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.

class azure.mgmt.computefleet.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_L_R_S = 'Premium_LRS'

Premium_LRS option.

PREMIUM_V2_L_R_S = 'PremiumV2_LRS'

PremiumV2_LRS option.

PREMIUM_Z_R_S = 'Premium_ZRS'

Premium_ZRS option.

STANDARD_L_R_S = 'Standard_LRS'

Standard_LRS option.

STANDARD_S_S_D_L_R_S = 'StandardSSD_LRS'

StandardSSD_LRS option.

STANDARD_S_S_D_Z_R_S = 'StandardSSD_ZRS'

StandardSSD_ZRS option.

ULTRA_S_S_D_L_R_S = 'UltraSSD_LRS'

UltraSSD_LRS option.

class azure.mgmt.computefleet.models.SubResource(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes SubResource.

Variables:

id (str) – Resource Id.

id: str | None

Resource Id.

class azure.mgmt.computefleet.models.SystemData(*args: Any, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

created_at: datetime | None

The timestamp of resource creation (UTC).

created_by: str | None

The identity that created the resource.

created_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:

The type of identity that created the resource. Known values are

last_modified_at: datetime | None

The timestamp of resource last modification (UTC).

last_modified_by: str | None

The identity that last modified the resource.

last_modified_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:

The type of identity that last modified the resource. Known values are

class azure.mgmt.computefleet.models.TerminateNotificationProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifies Terminate Scheduled Event related configurations.

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.

enable: bool | None

Specifies whether the Terminate Scheduled event is enabled or disabled.

not_before_timeout: str | None

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

class azure.mgmt.computefleet.models.TrackedResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Readonly 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) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

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

  • location (str) – The geo-location where the resource lives. Required.

location: str

The geo-location where the resource lives. Required.

tags: Dict[str, str] | None

Resource tags.

class azure.mgmt.computefleet.models.UefiSettings(*args: Any, **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.

secure_boot_enabled: bool | None

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

v_tpm_enabled: bool | None

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

class azure.mgmt.computefleet.models.UserAssignedIdentity(*args: Any, **kwargs: Any)[source]

Bases: Model

User assigned identity properties.

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

Variables:

  • principal_id (str) – The principal ID of the assigned identity.

  • client_id (str) – The client ID of the assigned identity.

client_id: str | None

The client ID of the assigned identity.

principal_id: str | None

The principal ID of the assigned identity.

class azure.mgmt.computefleet.models.VMDiskSecurityProfile(*args: Any, **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.

disk_encryption_set: _models.DiskEncryptionSetParameters | None

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.

security_encryption_type: str | _models.SecurityEncryptionTypes | None

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

class azure.mgmt.computefleet.models.VMGalleryApplication(*args: Any, **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 – 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.

Variables:

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

configuration_reference: str | None

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

enable_automatic_upgrade: bool | None

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

order: int | None

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.

tags: str | None

Optional, Specifies a passthrough value for more generic context.

treat_failure_as_deployment_failure: bool | None

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

class azure.mgmt.computefleet.models.VMSizeProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifies VM Size Property settings on the virtual machine.

Variables:

  • v_c_p_us_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_c_p_us_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..

v_c_p_us_available: int | None

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_c_p_us_per_core: int | None

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.computefleet.models.VaultCertificate(*args: Any, **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: <br><br> {<br> “data”:”<Base64-encoded-certificate>”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>”<br>} <br> 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 &lt;UppercaseThumbprint&gt;.crt for the X509 certificate file and &lt;UppercaseThumbprint&gt;.prv for private key. Both of these files are .pem formatted.

certificate_store: str | None

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 &lt;UppercaseThumbprint&gt;.crt for the X509 certificate file and &lt;UppercaseThumbprint&gt;.prv for private key. Both of these files are .pem formatted.

certificate_url: str | None

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: <br><br> {<br> “data”:”<Base64-encoded-certificate>”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>”<br>} <br> 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.computefleet.models.VaultSecretGroup(*args: Any, **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.

source_vault: _models.SubResource | None

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

vault_certificates: List[_models.VaultCertificate] | None

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

class azure.mgmt.computefleet.models.VirtualHardDisk(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes the uri of a disk.

Variables:

uri (str) – Specifies the virtual hard disk’s uri.

uri: str | None

Specifies the virtual hard disk’s uri.

class azure.mgmt.computefleet.models.VirtualMachineScaleSet(*args: Any, **kwargs: Any)[source]

Bases: Model

An AzureFleet’s virtualMachineScaleSet.

Readonly 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 – The compute RP resource id of the virtualMachineScaleSet

“subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}”.

Required.

Variables:

  • type (str) – Type of the virtualMachineScaleSet.

  • operation_status (str or ProvisioningState) – This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource. Required. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, “Deleting”, and “Migrating”.

  • error (ApiError) – Error Information when operationStatus is Failed.

error: _models.ApiError | None

Error Information when operationStatus is Failed.

id: str

The compute RP resource id of the virtualMachineScaleSet “subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}”. Required.

operation_status: str | _models.ProvisioningState

This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource. Required. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, “Deleting”, and “Migrating”.

type: str | None

Type of the virtualMachineScaleSet.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetDataDisk(*args: Any, **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_g_b (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_i_o_p_s_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).:code:<br><br> Possible values: <br><br> Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.:code:<br><br> Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted.:code:<br><br> The default value is set to Delete. Known values are: “Delete” and “Detach”.

caching: str | _models.CachingTypes | None

None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

Type:

Specifies the caching requirements. Possible values are

create_option: str | _models.DiskCreateOptionTypes

“FromImage”, “Empty”, “Attach”, “Copy”, and “Restore”.

Type:

The create option. Required. Known values are

delete_option: str | _models.DiskDeleteOptionTypes | None

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

disk_i_o_p_s_read_write: int | None

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

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.

disk_size_g_b: int | None

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.

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.

managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None

The managed disk parameters.

name: str | None

The disk name.

write_accelerator_enabled: bool | None

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

class azure.mgmt.computefleet.models.VirtualMachineScaleSetExtension(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes a Virtual Machine Scale Set Extension.

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

Variables:
id: str | None

Resource Id.

name: str | None

The name of the extension.

properties: _models.VirtualMachineScaleSetExtensionProperties | None

Describes the properties of a Virtual Machine Scale Set Extension.

type: str | None

Resource type.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetExtensionProfile(*args: Any, **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.

extensions: List[_models.VirtualMachineScaleSetExtension] | None

The virtual machine scale set child extension resources.

extensions_time_budget: str | None

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.computefleet.models.VirtualMachineScaleSetExtensionProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes the properties of a Virtual Machine Scale Set Extension.

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

Variables:

  • 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 (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 (dict[str, any]) – Json formatted public settings for the extension.

  • protected_settings (dict[str, any]) – 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.

auto_upgrade_minor_version: bool | None

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

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

force_update_tag: str | None

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.

protected_settings: Dict[str, Any] | None

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

protected_settings_from_key_vault: _models.KeyVaultSecretReference | None

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

provision_after_extensions: List[str] | None

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

provisioning_state: str | None

The provisioning state, which only appears in the response.

publisher: str | None

The name of the extension handler publisher.

settings: Dict[str, Any] | None

Json formatted public settings for the extension.

suppress_failures: bool | None

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

type: str | None

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

type_handler_version: str | None

Specifies the version of the script handler.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetHardwareProfile(*args: Any, **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.

vm_size_properties: _models.VMSizeProperties | None

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.computefleet.models.VirtualMachineScaleSetIPConfiguration(*args: Any, **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.

properties: _models.VirtualMachineScaleSetIPConfigurationProperties | None

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

class azure.mgmt.computefleet.models.VirtualMachineScaleSetIPConfigurationProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

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

Variables:

  • 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_i_p_address_configuration (VirtualMachineScaleSetPublicIPAddressConfiguration) – The publicIPAddressConfiguration.

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

application_gateway_backend_address_pools: List[_models.SubResource] | None

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[_models.SubResource] | None

Specifies an array of references to application security group.

load_balancer_backend_address_pools: List[_models.SubResource] | None

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[_models.SubResource] | None

Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.

primary: bool | None

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

private_i_p_address_version: str | _models.IPVersion | None

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

public_i_p_address_configuration: _models.VirtualMachineScaleSetPublicIPAddressConfiguration | None

The publicIPAddressConfiguration.

subnet: _models.ApiEntityReference | None

Specifies the identifier of the subnet.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetIpTag(*args: Any, **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.

ip_tag_type: str | None

FirstPartyUsage.

Type:

IP tag type. Example

tag: str | None

SQL, Storage etc.

Type:

IP tag associated with the public IP. Example

class azure.mgmt.computefleet.models.VirtualMachineScaleSetManagedDiskParameters(*args: Any, **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.

disk_encryption_set: _models.DiskEncryptionSetParameters | None

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

security_profile: _models.VMDiskSecurityProfile | None

Specifies the security profile for the managed disk.

storage_account_type: str | _models.StorageAccountTypes | None

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

Type:

Specifies the storage account type for the managed disk. NOTE

class azure.mgmt.computefleet.models.VirtualMachineScaleSetNetworkConfiguration(*args: Any, **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.

properties: _models.VirtualMachineScaleSetNetworkConfigurationProperties | None

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

class azure.mgmt.computefleet.models.VirtualMachineScaleSetNetworkConfigurationDnsSettings(*args: Any, **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.

dns_servers: List[str] | None

List of DNS servers IP addresses.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetNetworkConfigurationProperties(*args: Any, **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:

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

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

auxiliary_mode: str | _models.NetworkInterfaceAuxiliaryMode | None

Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values are: “None”, “AcceleratedConnections”, and “Floating”.

auxiliary_sku: str | _models.NetworkInterfaceAuxiliarySku | None

Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values are: “None”, “A1”, “A2”, “A4”, and “A8”.

delete_option: str | _models.DeleteOptions | None

Specify what happens to the network interface when the VM is deleted. Known values are: “Delete” and “Detach”.

disable_tcp_state_tracking: bool | None

Specifies whether the network interface is disabled for tcp state tracking.

dns_settings: _models.VirtualMachineScaleSetNetworkConfigurationDnsSettings | None

The dns settings to be applied on the network interfaces.

enable_accelerated_networking: bool | None

Specifies whether the network interface is accelerated networking-enabled.

enable_fpga: bool | None

Specifies whether the network interface is FPGA networking-enabled.

enable_i_p_forwarding: bool | None

Whether IP forwarding enabled on this NIC.

ip_configurations: List[_models.VirtualMachineScaleSetIPConfiguration]

Specifies the IP configurations of the network interface. Required.

network_security_group: _models.SubResource | None

The network security group.

primary: bool | None

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

class azure.mgmt.computefleet.models.VirtualMachineScaleSetNetworkProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes a virtual machine scale set network profile.

Variables:

health_probe – 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 :vartype health_probe: ~azure.mgmt.computefleet.models.ApiEntityReference :ivar network_interface_configurations: The list of network configurations. :vartype network_interface_configurations:

list[~azure.mgmt.computefleet.models.VirtualMachineScaleSetNetworkConfiguration]

Variables:

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”

health_probe: _models.ApiEntityReference | None

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_api_version: str | _models.NetworkApiVersion | None

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”

network_interface_configurations: List[_models.VirtualMachineScaleSetNetworkConfiguration] | None

The list of network configurations.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetOSDisk(*args: Any, **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_g_b (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). <br><br> Possible values: <br><br> Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.:code:<br><br> Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> 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”.

caching: str | _models.CachingTypes | None

None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.. Known values are: “None”, “ReadOnly”, and “ReadWrite”.

Type:

Specifies the caching requirements. Possible values are

create_option: str | _models.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”.

delete_option: str | _models.DiskDeleteOptionTypes | None

Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br><br> Possible values: <br><br> Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.:code:<br><br> Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> 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”.

diff_disk_settings: _models.DiffDiskSettings | None

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

disk_size_g_b: int | None

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.

image: _models.VirtualHardDisk | None

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

managed_disk: _models.VirtualMachineScaleSetManagedDiskParameters | None

The managed disk parameters.

name: str | None

The disk name.

os_type: str | _models.OperatingSystemTypes | None

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

vhd_containers: List[str] | None

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

write_accelerator_enabled: bool | None

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

class azure.mgmt.computefleet.models.VirtualMachineScaleSetOSProfile(*args: Any, **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. <br><br> Windows-only restriction: Cannot end in “.” <br><br> 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”. <br><br> Minimum-length (Linux): 1 character <br><br> Max-length (Linux): 64 characters <br><br> Max-length (Windows): 20 characters.

  • admin_password (str) – Specifies the password of the administrator account. <br><br> Minimum-length (Windows): 8 characters <br><br> Minimum-length (Linux): 6 characters <br><br> Max-length (Windows): 123 characters <br><br> Max-length (Linux): 72 characters <br><br> Complexity requirements: 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>`Has upper characters :code:`<br> Has a digit <br> Has a special character (Regex match [W_]) <br><br> Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!” <br><br> For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM <br><br> 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.

admin_password: str | None

Specifies the password of the administrator account. <br><br> Minimum-length (Windows): 8 characters <br><br> Minimum-length (Linux): 6 characters <br><br> Max-length (Windows): 123 characters <br><br> Max-length (Linux): 72 characters <br><br> Complexity requirements: 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>`Has upper characters :code:`<br> Has a digit <br> Has a special character (Regex match [W_]) <br><br> Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!” <br><br> For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM <br><br> For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension.

admin_username: str | None

Specifies the name of the administrator account. <br><br> Windows-only restriction: Cannot end in “.” <br><br> 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”. <br><br> Minimum-length (Linux): 1 character <br><br> Max-length (Linux): 64 characters <br><br> Max-length (Windows): 20 characters.

allow_extension_operations: bool | None

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.

computer_name_prefix: str | None

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.

custom_data: str | None

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.

linux_configuration: _models.LinuxConfiguration | None

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

require_guest_provision_signal: bool | None

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

secrets: List[_models.VaultSecretGroup] | None

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.

windows_configuration: _models.WindowsConfiguration | None

Specifies Windows operating system settings on the virtual machine.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetPublicIPAddressConfiguration(*args: Any, **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.

properties: _models.VirtualMachineScaleSetPublicIPAddressConfigurationProperties | None

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

sku: _models.PublicIPAddressSku | None

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

class azure.mgmt.computefleet.models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings(*args: Any, **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”.

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 | _models.DomainNameLabelScopeTypes | None

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.computefleet.models.VirtualMachineScaleSetPublicIPAddressConfigurationProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

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

Variables:

  • 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_i_p_prefix (SubResource) – The PublicIPPrefix from which to allocate publicIP addresses.

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

delete_option: str | _models.DeleteOptions | None

“Delete” and “Detach”.

Type:

Specify what happens to the public IP when the VM is deleted. Known values are

dns_settings: _models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings | None

The dns settings to be applied on the publicIP addresses .

idle_timeout_in_minutes: int | None

The idle timeout of the public IP address.

ip_tags: List[_models.VirtualMachineScaleSetIpTag] | None

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

public_i_p_address_version: str | _models.IPVersion | None

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_i_p_prefix: _models.SubResource | None

The PublicIPPrefix from which to allocate publicIP addresses.

class azure.mgmt.computefleet.models.VirtualMachineScaleSetStorageProfile(*args: Any, **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 or DiskControllerTypes) – Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01. Known values are: “SCSI” and “NVMe”.

data_disks: List[_models.VirtualMachineScaleSetDataDisk] | None

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 | _models.DiskControllerTypes | None

Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01. Known values are: “SCSI” and “NVMe”.

image_reference: _models.ImageReference | None

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: _models.VirtualMachineScaleSetOSDisk | None

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.

class azure.mgmt.computefleet.models.VmSizeProfile(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifications about a VM Size. This will also contain the corresponding rank and weight in future.

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

Variables:

  • name (str) – The Sku name (e.g. ‘Standard_DS1_v2’). Required.

  • rank (int) – The rank of the VM size. This is used with ‘RegularPriorityAllocationStrategy.Prioritized’ The lower the number, the higher the priority. Starting with 0.

name: str

The Sku name (e.g. ‘Standard_DS1_v2’). Required.

rank: int | None

The rank of the VM size. This is used with ‘RegularPriorityAllocationStrategy.Prioritized’ The lower the number, the higher the priority. Starting with 0.

class azure.mgmt.computefleet.models.WinRMConfiguration(*args: Any, **kwargs: Any)[source]

Bases: Model

Describes Windows Remote Management configuration of the VM.

Variables:

listeners (list[WinRMListener]) – The list of Windows Remote Management listeners.

listeners: List[_models.WinRMListener] | None

The list of Windows Remote Management listeners.

class azure.mgmt.computefleet.models.WinRMListener(*args: Any, **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: <br><br> {<br> “data”:”<Base64-encoded-certificate>”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>”<br>} <br> 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_url: str | None

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: <br><br> {<br> “data”:”<Base64-encoded-certificate>”,:code:<br> “dataType”:”pfx”,:code:<br> “password”:”<pfx-file-password>”<br>} <br> 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.

protocol: str | _models.ProtocolTypes | None

http, https.. Known values are: “Http” and “Https”.

Type:

Specifies the protocol of WinRM listener. Possible values are

class azure.mgmt.computefleet.models.WindowsConfiguration(*args: Any, **kwargs: Any)[source]

Bases: Model

Specifies Windows operating system settings on the virtual machine.

Variables:

  • provision_v_m_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_r_m (WinRMConfiguration) – Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

  • enable_v_m_agent_platform_updates (bool) – Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.

additional_unattend_content: List[_models.AdditionalUnattendContent] | None

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

enable_automatic_updates: bool | None

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.

enable_v_m_agent_platform_updates: bool | None

Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.

patch_settings: _models.PatchSettings | None

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

provision_v_m_agent: bool | None

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.

time_zone: str | None

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.

win_r_m: _models.WinRMConfiguration | None

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

class azure.mgmt.computefleet.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.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'

The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

IMAGE_DEFAULT = 'ImageDefault'

You control the timing of patch assessments on a virtual machine.

class azure.mgmt.computefleet.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'

Always Reboot setting

IF_REQUIRED = 'IfRequired'

IfRequired Reboot setting

NEVER = 'Never'

Never Reboot setting

UNKNOWN = 'Unknown'

Unknown Reboot setting

class azure.mgmt.computefleet.models.WindowsVMGuestPatchAutomaticByPlatformSettings(*args: Any, **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.

bypass_platform_safety_checks_on_user_schedule: bool | None

Enables customer to schedule patching without accidental upgrades.

reboot_setting: str | _models.WindowsVMGuestPatchAutomaticByPlatformRebootSetting | None

Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values are: “Unknown”, “IfRequired”, “Never”, and “Always”.

class azure.mgmt.computefleet.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.

AUTOMATIC_BY_O_S = 'AutomaticByOS'

The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

AUTOMATIC_BY_PLATFORM = 'AutomaticByPlatform'

The virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true.

MANUAL = '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