@azure/arm-computefleet package

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.

The API entity reference.

ApiError for Fleet

API error base.

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

Optional parameters for the client.

Describes the base virtual machine profile for fleet

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.

The parameters of a capacity reservation Profile.

Compute Profile to use for running user's workloads.

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

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.

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.

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

The resource management error additional info.

The error detail.

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

An Compute Fleet resource

Details of the Compute Fleet.

Fleet Update Model

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Fleets operations.

Optional parameters.

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.

Inner error details.

Describes a reference to Key Vault Secret

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

Specifies settings related to VM Guest Patching on Linux.

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

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

The template for adding optional properties.

Specifies OS Image Scheduled Event related configurations.

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

Localized display information for and operation.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

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

Specifies settings related to VM Guest Patching on Windows.

Plan for the resource.

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

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

Configuration Options for Regular instances in Compute Fleet.

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

The template for adding optional properties.

Specifies Scheduled Event related configurations.

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

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

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

Configuration Options for Spot instances in Compute Fleet.

SSH configuration for Linux based VMs running on Azure

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

Describes SubResource

Metadata pertaining to creation and last modification of the resource.

Specifies Terminate Scheduled Event related configurations.

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

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

User assigned identity properties

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

Specifies the required information to reference a compute gallery application version

Specifies VM Size Property settings on the virtual machine.

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

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

Describes the uri of a disk.

An AzureFleet's virtualMachineScaleSet

Describes a virtual machine scale set data disk.

Describes a Virtual Machine Scale Set Extension.

Describes a virtual machine scale set extension profile.

Describes the properties of a Virtual Machine Scale Set Extension.

Specifies the hardware settings for the virtual machine scale set.

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

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

Contains the IP tag associated with the public IP address.

Describes the parameters of a ScaleSet managed disk.

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

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

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

Describes a virtual machine scale set network profile.

Describes a virtual machine scale set operating system disk.

Describes a virtual machine scale set OS profile.

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

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

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

Describes a virtual machine scale set storage profile.

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

Describes Windows Remote Management configuration of the VM

Describes Protocol and thumbprint of Windows Remote Management listener

Specifies Windows operating system settings on the virtual machine.

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

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

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

An interface that describes a page of results.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

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
Detach

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

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

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
NVMe

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
Empty
Attach
Copy
Restore

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
Detach

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
SubscriptionReuse
ResourceGroupReuse
NoReuse

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
Deallocate

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
IPv6

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
AutomaticByPlatform

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
IfRequired
Never
Always

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
AutomaticByPlatform

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
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

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
Enforce

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

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

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
A1
A2
A4
A8

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
Linux

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
system
user,system

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
Https

Alias for ProvisioningState

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
Standard

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
Global

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
Prioritized

The provisioning state of a resource type.
KnownResourceProvisioningState 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

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

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
ConfidentialVM

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
FirstLogonCommands

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

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
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

Api versions

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
AutomaticByPlatform

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
IfRequired
Never
Always

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

Known values of ActionType that the service accepts.

Known values of CachingTypes that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of DeleteOptions that the service accepts.

Known values of DiffDiskOptions that the service accepts.

Known values of DiffDiskPlacement that the service accepts.

Known values of DiskControllerTypes that the service accepts.

Known values of DiskCreateOptionTypes that the service accepts.

Known values of DiskDeleteOptionTypes that the service accepts.

Known values of DomainNameLabelScopeTypes that the service accepts.

Known values of EvictionPolicy that the service accepts.

Known values of IPVersion that the service accepts.

Known values of LinuxPatchAssessmentMode that the service accepts.

Known values of LinuxVMGuestPatchAutomaticByPlatformRebootSetting that the service accepts.

Known values of LinuxVMGuestPatchMode that the service accepts.

Known values of ManagedServiceIdentityType that the service accepts.

Known values of Mode that the service accepts.

Known values of NetworkApiVersion that the service accepts.

Known values of NetworkInterfaceAuxiliaryMode that the service accepts.

Known values of NetworkInterfaceAuxiliarySku that the service accepts.

Known values of OperatingSystemTypes that the service accepts.

Known values of Origin that the service accepts.

Known values of ProtocolTypes that the service accepts.

Known values of PublicIPAddressSkuName that the service accepts.

Known values of PublicIPAddressSkuTier that the service accepts.

Known values of RegularPriorityAllocationStrategy that the service accepts.

Known values of ResourceProvisioningState that the service accepts.

Known values of SecurityEncryptionTypes that the service accepts.

Known values of SecurityTypes that the service accepts.

Known values of SettingNames that the service accepts.

Known values of SpotAllocationStrategy that the service accepts.

Known values of StorageAccountTypes that the service accepts.

Known values of WindowsPatchAssessmentMode that the service accepts.

Known values of WindowsVMGuestPatchAutomaticByPlatformRebootSetting that the service accepts.

Known values of WindowsVMGuestPatchMode that the service accepts.

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.