@azure/arm-computefleet package

Classes

AzureFleetClient

Interfaces

AdditionalCapabilities

AdditionalCapabilities for VM.

AdditionalLocationsProfile

Represents the configuration for additional locations where Fleet resources may be deployed.

AdditionalUnattendContent

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

ApiEntityReference

The API entity reference.

ApiError

ApiError for Fleet

ApiErrorBase

API error base.

ApplicationProfile

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

AzureFleetClientOptionalParams

Optional parameters for the client.

BaseVirtualMachineProfile

Describes the base virtual machine profile for fleet

BootDiagnostics

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

CapacityReservationProfile

The parameters of a capacity reservation Profile.

ComputeProfile

Compute Profile to use for running user's workloads.

DiagnosticsProfile

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

DiffDiskSettings

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

DiskEncryptionSetParameters

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

EncryptionIdentity

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

Fleet

An Compute Fleet resource

FleetProperties

Details of the Compute Fleet.

FleetUpdate

Fleet Update Model

FleetsCreateOrUpdateOptionalParams

Optional parameters.

FleetsDeleteOptionalParams

Optional parameters.

FleetsGetOptionalParams

Optional parameters.

FleetsListByResourceGroupOptionalParams

Optional parameters.

FleetsListBySubscriptionOptionalParams

Optional parameters.

FleetsListVirtualMachineScaleSetsOptionalParams

Optional parameters.

FleetsOperations

Interface representing a Fleets operations.

FleetsUpdateOptionalParams

Optional parameters.

ImageReference

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

InnerError

Inner error details.

KeyVaultSecretReference

Describes a reference to Key Vault Secret

LinuxConfiguration

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

LinuxPatchSettings

Specifies settings related to VM Guest Patching on Linux.

LinuxVMGuestPatchAutomaticByPlatformSettings

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

LocationProfile

Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional).

ManagedServiceIdentity

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

ManagedServiceIdentityUpdate

The template for adding optional properties.

OSImageNotificationProfile

Specifies OS Image Scheduled Event related configurations.

Operation

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

OperationDisplay

Localized display information for and operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

Plan

Plan for the resource.

ProxyAgentSettings

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

PublicIPAddressSku

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

RegularPriorityProfile

Configuration Options for Regular instances in Compute Fleet.

Resource

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

ResourcePlanUpdate

The template for adding optional properties.

RestorePollerOptions
ScheduledEventsProfile

Specifies Scheduled Event related configurations.

SecurityPostureReference

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

SecurityProfile

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

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

SpotPriorityProfile

Configuration Options for Spot instances in Compute Fleet.

SshConfiguration

SSH configuration for Linux based VMs running on Azure

SshPublicKey

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

SubResource

Describes SubResource

SystemData

Metadata pertaining to creation and last modification of the resource.

TerminateNotificationProfile

Specifies Terminate Scheduled Event related configurations.

TrackedResource

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

UefiSettings

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

UserAssignedIdentity

User assigned identity properties

VMAttributeMinMaxDouble

VMAttributes using double values.

VMAttributeMinMaxInteger

While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes.

VMAttributes

VMAttributes that will be used to filter VMSizes which will be used to build Fleet.

VMDiskSecurityProfile

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

VMGalleryApplication

Specifies the required information to reference a compute gallery application version

VMSizeProperties

Specifies VM Size Property settings on the virtual machine.

VaultCertificate

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

VaultSecretGroup

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

VirtualHardDisk

Describes the uri of a disk.

VirtualMachineScaleSet

An AzureFleet's virtualMachineScaleSet

VirtualMachineScaleSetDataDisk

Describes a virtual machine scale set data disk.

VirtualMachineScaleSetExtension

Describes a Virtual Machine Scale Set Extension.

VirtualMachineScaleSetExtensionProfile

Describes a virtual machine scale set extension profile.

VirtualMachineScaleSetExtensionProperties

Describes the properties of a Virtual Machine Scale Set Extension.

VirtualMachineScaleSetHardwareProfile

Specifies the hardware settings for the virtual machine scale set.

VirtualMachineScaleSetIPConfiguration

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

VirtualMachineScaleSetIPConfigurationProperties

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

VirtualMachineScaleSetIpTag

Contains the IP tag associated with the public IP address.

VirtualMachineScaleSetManagedDiskParameters

Describes the parameters of a ScaleSet managed disk.

VirtualMachineScaleSetNetworkConfiguration

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

VirtualMachineScaleSetNetworkConfigurationDnsSettings

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

VirtualMachineScaleSetNetworkConfigurationProperties

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

VirtualMachineScaleSetNetworkProfile

Describes a virtual machine scale set network profile.

VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

VirtualMachineScaleSetOSProfile

Describes a virtual machine scale set OS profile.

VirtualMachineScaleSetPublicIPAddressConfiguration

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

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

VirtualMachineScaleSetPublicIPAddressConfigurationProperties

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

VirtualMachineScaleSetStorageProfile

Describes a virtual machine scale set storage profile.

VmSizeProfile

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

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

WindowsVMGuestPatchAutomaticByPlatformSettings

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

Type Aliases

AcceleratorManufacturer

Accelerator manufacturers supported by Azure VMs.
KnownAcceleratorManufacturer can be used interchangeably with AcceleratorManufacturer, this enum contains the known values that the service supports.

Known values supported by the service

AMD: AMD GpuType
Nvidia: Nvidia GpuType
Xilinx: Xilinx GpuType

AcceleratorType

Accelerator types supported by Azure VMs.
KnownAcceleratorType can be used interchangeably with AcceleratorType, this enum contains the known values that the service supports.

Known values supported by the service

GPU: GPU Accelerator
FPGA: FPGA Accelerator

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

ArchitectureType

Architecture types supported by Azure VMs.
KnownArchitectureType can be used interchangeably with ArchitectureType, this enum contains the known values that the service supports.

Known values supported by the service

ARM64: ARM64 Architecture
X64: X64 Architecture

CachingTypes

Specifies the caching requirements.
KnownCachingTypes can be used interchangeably with CachingTypes, this enum contains the known values that the service supports.

Known values supported by the service

None: 'None' is default for Standard Storage
ReadOnly: 'ReadOnly' is default for Premium Storage
ReadWrite: 'ReadWrite' is default for OS Disk

ContinuablePage

An interface that describes a page of results.

CpuManufacturer

Cpu Manufacturers supported by Azure VMs.
KnownCpuManufacturer can be used interchangeably with CpuManufacturer, this enum contains the known values that the service supports.

Known values supported by the service

Intel: Intel CPU.
AMD: AMD CPU.
Microsoft: Microsoft CPU.
Ampere: Ampere CPU.

CreatedByType

The kind of entity that created the resource.
<xref:KnowncreatedByType> can be used interchangeably with createdByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DeleteOptions

Specify what happens to the network interface when the VM is deleted
KnownDeleteOptions can be used interchangeably with DeleteOptions, this enum contains the known values that the service supports.

Known values supported by the service

Delete: Delete Option
Detach: Detach Option

DiffDiskOptions

Specifies the ephemeral disk option for operating system disk.
KnownDiffDiskOptions can be used interchangeably with DiffDiskOptions, this enum contains the known values that the service supports.

Known values supported by the service

Local: Local Option.

DiffDiskPlacement

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Minimum api-version for NvmeDisk: 2024-03-01.
KnownDiffDiskPlacement can be used interchangeably with DiffDiskPlacement, this enum contains the known values that the service supports.

Known values supported by the service

CacheDisk: CacheDisk option.
ResourceDisk: Resource Disk option.
NvmeDisk: NvmeDisk option.

DiskControllerTypes

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.
KnownDiskControllerTypes can be used interchangeably with DiskControllerTypes, this enum contains the known values that the service supports.

Known values supported by the service

SCSI: SCSI disk type
NVMe: NVMe disk type

DiskCreateOptionTypes

Specifies how the virtual machine should be created.
KnownDiskCreateOptionTypes can be used interchangeably with DiskCreateOptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

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.
Empty: This value is used when creating an empty data disk.
Attach: This value is used when you are using a specialized disk to create the virtual machine.
Copy: This value is used to create a data disk from a snapshot or another disk.
Restore: This value is used to create a data disk from a disk restore point.

DiskDeleteOptionTypes

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.
KnownDiskDeleteOptionTypes can be used interchangeably with DiskDeleteOptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

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.

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
KnownDomainNameLabelScopeTypes can be used interchangeably with DomainNameLabelScopeTypes, this enum contains the known values that the service supports.

Known values supported by the service

TenantReuse: TenantReuse type
SubscriptionReuse: SubscriptionReuse type
ResourceGroupReuse: ResourceGroupReuse type
NoReuse: NoReuse type

EvictionPolicy

Different kind of eviction policies
KnownEvictionPolicy can be used interchangeably with EvictionPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Delete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this.
Deallocate: When evicted, the Spot VM will be deallocated/stopped

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'.
KnownIPVersion can be used interchangeably with IPVersion, this enum contains the known values that the service supports.

Known values supported by the service

IPv4: IPv4 version
IPv6: IPv6 version

LinuxPatchAssessmentMode

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

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

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
KnownLinuxPatchAssessmentMode can be used interchangeably with LinuxPatchAssessmentMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault: You control the timing of patch assessments on a virtual machine.
AutomaticByPlatform: The platform will trigger periodic patch assessments.The property provisionVMAgent must be true.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting can be used interchangeably with LinuxVMGuestPatchAutomaticByPlatformRebootSetting, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown Reboot setting
IfRequired: IfRequired Reboot setting
Never: Never Reboot setting
Always: Always Reboot setting

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.
KnownLinuxVMGuestPatchMode can be used interchangeably with LinuxVMGuestPatchMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault: The virtual machine's default patching configuration is used.
AutomaticByPlatform: The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true.

LocalStorageDiskType

Different kind of Local storage disk types supported by Azure VMs.
KnownLocalStorageDiskType can be used interchangeably with LocalStorageDiskType, this enum contains the known values that the service supports.

Known values supported by the service

HDD: HDD DiskType.
SSD: SDD DiskType.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

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.
KnownMode can be used interchangeably with Mode, this enum contains the known values that the service supports.

Known values supported by the service

Audit: Audit Mode
Enforce: Enforce Mode

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'
KnownNetworkApiVersion can be used interchangeably with NetworkApiVersion, this enum contains the known values that the service supports.

Known values supported by the service

2020-11-01: Initial version supported. Later versions are supported as well.

NetworkInterfaceAuxiliaryMode

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
KnownNetworkInterfaceAuxiliaryMode can be used interchangeably with NetworkInterfaceAuxiliaryMode, this enum contains the known values that the service supports.

Known values supported by the service

None: None Mode
AcceleratedConnections: AcceleratedConnections Mode
Floating: Floating Mode

NetworkInterfaceAuxiliarySku

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
KnownNetworkInterfaceAuxiliarySku can be used interchangeably with NetworkInterfaceAuxiliarySku, this enum contains the known values that the service supports.

Known values supported by the service

None: no sku
A1: A1 sku
A2: A2 sku
A4: A4 sku
A8: A8 sku

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.
KnownOperatingSystemTypes can be used interchangeably with OperatingSystemTypes, this enum contains the known values that the service supports.

Known values supported by the service

Windows: Windows OS type
Linux: Linux OS type

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ProtocolTypes

Specifies the protocol of WinRM listener. Possible values are: http, https.
KnownProtocolTypes can be used interchangeably with ProtocolTypes, this enum contains the known values that the service supports.

Known values supported by the service

Http: Http protocol
Https: Https protocol

ProvisioningState

The provisioning state of a resource type.
KnownProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
Creating
Updating
Deleting
Migrating

PublicIPAddressSkuName

Specify public IP sku name.
KnownPublicIPAddressSkuName can be used interchangeably with PublicIPAddressSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Basic: Basic sku name
Standard: Standard sku name

PublicIPAddressSkuTier

Specify public IP sku tier
KnownPublicIPAddressSkuTier can be used interchangeably with PublicIPAddressSkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Regional: Regional sku tier
Global: Global sku tier

RegularPriorityAllocationStrategy

Regular VM Allocation strategy types for Compute Fleet
KnownRegularPriorityAllocationStrategy can be used interchangeably with RegularPriorityAllocationStrategy, this enum contains the known values that the service supports.

Known values supported by the service

LowestPrice: Default. VM sizes distribution will be determined to optimize for price.
Prioritized: VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size.

SecurityEncryptionTypes

Specifies the EncryptionType of the managed disk. Note: It can be set for only Confidential VMs.
KnownSecurityEncryptionTypes can be used interchangeably with SecurityEncryptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

VMGuestStateOnly: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob.
DiskWithVMGuestState: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob.
NonPersistedTPM: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob.

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.
KnownSecurityTypes can be used interchangeably with SecurityTypes, this enum contains the known values that the service supports.

Known values supported by the service

TrustedLaunch: TrustedLaunch security type
ConfidentialVM: ConfidentialVM security type

SettingNames

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
KnownSettingNames can be used interchangeably with SettingNames, this enum contains the known values that the service supports.

Known values supported by the service

AutoLogon: AutoLogon setting
FirstLogonCommands: FirstLogonCommands setting

SpotAllocationStrategy

Spot allocation strategy types for Compute Fleet
KnownSpotAllocationStrategy can be used interchangeably with SpotAllocationStrategy, this enum contains the known values that the service supports.

Known values supported by the service

PriceCapacityOptimized: Default. VM sizes distribution will be determined to optimize for both price and capacity.
LowestPrice: VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight.
CapacityOptimized: VM sizes distribution will be determined to optimize for capacity.

StorageAccountTypes

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
KnownStorageAccountTypes can be used interchangeably with StorageAccountTypes, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS: Standard_LRS option.
Premium_LRS: Premium_LRS option.
StandardSSD_LRS: StandardSSD_LRS option.
UltraSSD_LRS: UltraSSD_LRS option.
Premium_ZRS: Premium_ZRS option.
StandardSSD_ZRS: StandardSSD_ZRS option.
PremiumV2_LRS: PremiumV2_LRS option.

VMAttributeSupport

VMSizes supported by Azure VMs. Included is a union of Excluded and Required.
KnownVMAttributeSupport can be used interchangeably with VMAttributeSupport, this enum contains the known values that the service supports.

Known values supported by the service

Excluded: All VMSizes having the feature support will be excluded.
Included: VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required.
Required: Only the VMSizes having the feature support will be used.

VMCategory

VMCategories defined for Azure VMs. See: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose
KnownVMCategory can be used interchangeably with VMCategory, this enum contains the known values that the service supports.

Known values supported by the service

GeneralPurpose: General purpose VM sizes provide balanced CPU-to-memory ratio. Ideal for testing and development, small to medium databases, and low to medium traffic web servers.
ComputeOptimized: Compute optimized VM sizes have a high CPU-to-memory ratio. These sizes are good for medium traffic web servers, network appliances, batch processes, and application servers.
MemoryOptimized: Memory optimized VM sizes offer a high memory-to-CPU ratio that is great for relational database servers, medium to large caches, and in-memory analytics.
StorageOptimized: Storage optimized virtual machine (VM) sizes offer high disk throughput and IO, and are ideal for Big Data, SQL, NoSQL databases, data warehousing, and large transactional databases. Examples include Cassandra, MongoDB, Cloudera, and Redis.
GpuAccelerated: GPU optimized VM sizes are specialized virtual machines available with single, multiple, or fractional GPUs. These sizes are designed for compute-intensive, graphics-intensive, and visualization workloads.
FpgaAccelerated: FPGA optimized VM sizes are specialized virtual machines available with single or multiple FPGA. These sizes are designed for compute-intensive workloads. This article provides information about the number and type of FPGA, vCPUs, data disks, and NICs. Storage throughput and network bandwidth are also included for each size in this grouping.
HighPerformanceCompute: Azure High Performance Compute VMs are optimized for various HPC workloads such as computational fluid dynamics, finite element analysis, frontend and backend EDA, rendering, molecular dynamics, computational geo science, weather simulation, and financial risk analysis.

WindowsPatchAssessmentMode

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
KnownWindowsPatchAssessmentMode can be used interchangeably with WindowsPatchAssessmentMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault: You control the timing of patch assessments on a virtual machine.
AutomaticByPlatform: The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting can be used interchangeably with WindowsVMGuestPatchAutomaticByPlatformRebootSetting, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown Reboot setting
IfRequired: IfRequired Reboot setting
Never: Never Reboot setting
Always: Always Reboot setting

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.
KnownWindowsVMGuestPatchMode can be used interchangeably with WindowsVMGuestPatchMode, this enum contains the known values that the service supports.

Known values supported by the service

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

Enums

KnownAcceleratorManufacturer

Accelerator manufacturers supported by Azure VMs.

KnownAcceleratorType

Accelerator types supported by Azure VMs.

KnownActionType

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

KnownArchitectureType

Architecture types supported by Azure VMs.

KnownCachingTypes

Specifies the caching requirements.

KnownCpuManufacturer

Cpu Manufacturers supported by Azure VMs.

KnownCreatedByType

The kind of entity that created the resource.

KnownDeleteOptions

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

KnownDiffDiskOptions

Specifies the ephemeral disk option for operating system disk.

KnownDiffDiskPlacement

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.

KnownDiskControllerTypes

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.

KnownDiskCreateOptionTypes

Specifies how the virtual machine should be created.

KnownDiskDeleteOptionTypes

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.

KnownDomainNameLabelScopeTypes

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

KnownEvictionPolicy

Different kind of eviction policies

KnownIPVersion

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

KnownLinuxPatchAssessmentMode

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

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

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

KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

KnownLinuxVMGuestPatchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

KnownLocalStorageDiskType

Different kind of Local storage disk types supported by Azure VMs.

KnownManagedServiceIdentityType

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

KnownMode

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.

KnownNetworkApiVersion

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'

KnownNetworkInterfaceAuxiliaryMode

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

KnownNetworkInterfaceAuxiliarySku

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

KnownOperatingSystemTypes

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.

KnownOrigin

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

KnownProtocolTypes

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

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicIPAddressSkuName

Specify public IP sku name.

KnownPublicIPAddressSkuTier

Specify public IP sku tier

KnownRegularPriorityAllocationStrategy

Regular VM Allocation strategy types for Compute Fleet

KnownSecurityEncryptionTypes

Specifies the EncryptionType of the managed disk. Note: It can be set for only Confidential VMs.

KnownSecurityTypes

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.

KnownSettingNames

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

KnownSpotAllocationStrategy

Spot allocation strategy types for Compute Fleet

KnownStorageAccountTypes

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

KnownVMAttributeSupport

VMSizes supported by Azure VMs. Included is a union of Excluded and Required.

KnownVMCategory

VMCategories defined for Azure VMs. See: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose

KnownWindowsPatchAssessmentMode

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

KnownWindowsVMGuestPatchMode

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Functions

restorePoller<TResponse, TResult>(AzureFleetClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(AzureFleetClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AzureFleetClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>