@azure/arm-compute-bulkactions package

The request to acknowledge bulk operation errors

The response from acknowledging bulk operation errors

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

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.

Specifies if Scheduled Events should be auto-approved when all instances are down.

The API entity reference.

ApiError for Fleet

API error base.

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

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.

Describes the properties of a Virtual Machine Extension.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BulkCreateCustom operations.

A single per-VM override. Extends the shared override fields with a per-VM name.

Override fields shared by per-VM and per-VM-size overrides. Each set field takes precedence over the operation-level value. VM size, zone, priority, eviction policy, and billing are owned by the service and cannot be set here.

Groups the per-VM overrides with the name prefix that names any override that does not supply its own VM name.

Configuration options for Regular or Spot instances in BulkCreateCustom.

Details of the BulkCreateCustom.

A VM size profile entry that may additionally carry an optional per-VM-size profile override. Every VM that the service assigns to this size inherits the override, layered on top of the operation-level base profile and beneath any per-VM override. Present only on the bulkCreateCustom endpoint; the uniform endpoint rejects a non-null override.

The zone allocation policy for distributing VMs across availability zones in BulkCreateCustom.

Inner error details.

Defines a virtual machine extension.

Describes the properties of a Virtual Machine for bulk create.

The request to cancel an occurrence.

This is the request to cancel running operations in scheduled actions using the operation ids

This is the response from a cancel operations request

The parameters of a capacity reservation Profile.

Optional parameters for the client.

Compute Profile to configure the Virtual Machines.

The response from a create request

Describes a data disk.

The response from a deallocate request

Request to ask for a delay in an occurrence, delay should be set to client local time eg (PST) 2025-05-30T06:35:00-07:00

The response from a delete request

Specifies the boot diagnostic settings state. Minimum compute 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.

Describes a Encryption Settings for a Disk

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.

Specifies eventGridAndResourceGraph related Scheduled Event related configurations.

The ExecuteCreateRequest request for create operations

The ExecuteDeallocateRequest request for executeDeallocate operations

The ExecuteDeleteRequest for delete VM operation

The ExecuteHibernateRequest request for executeHibernate operations

The ExecuteReimageRequest request for reimage operations

The ExecuteStartRequest request for executeStart operations

The VdiCreateRequest request for create operations

Extra details needed to run the user's request

The base extension resource.

Describes the fallback operation that was performed

The flex properties for flexible VM creation

This is the request to get operation status using operationids

This is the response from a get operations status request

Specifies the hardware profile for the virtual machine.

The response from a Hibernate request

Specifies particular host endpoint settings.

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.

Describes a reference to Key Vault Key

Describes a reference to Key Vault Secret

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a LaunchBulkInstancesOperation operations.

Details of the LaunchBulkInstancesOperation.

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.

Location based BulkCreateCustom resource. The location is part of the resource path.

Location based LaunchBulkInstancesOperation resource. The location is part of the resource path.

The parameters of a managed disk.

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

Describes a network interface reference.

Describes a network interface reference properties.

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

The information about notifications to be send to about upcoming operations.

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

Profile for the OS Image Scheduled event.

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

Additional parameters for Reimaging Non-Ephemeral Virtual Machine.

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Optional parameters.

Interface representing a OccurrenceExtension operations.

The properties of the occurrence extension

The scheduled action extension

Properties for an occurrence

Represents an scheduled action resource metadata.

The summarized provisioning result of an occurrence

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Occurrences operations.

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

Localized display information for an operation.

The current status of an async 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.

The priority profile for flex VM creation

Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.

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

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

The execution parameters the scheduled action is supposed to follow

Retry policy the scheduled action can pass

Reimage payload with common profile and per-resource overrides

The response from a reimage request

Per-resource override entry for reimage requests

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

Request model to attach a list of scheduled action resources.

Request model to detach a list of scheduled action resources.

Resource notification details containing notification metadata like the resource context

High level response from an operation on a resource

The details of a response from an operation on a resource

These describe errors that occur at the resource level

The response from scheduled action resource requests, which contains the status of each resource

Request model perform a resource operation in a list of resources

Resource creation data model

Resource creation data model with Flex properties for VDI scenarios

The status of the resources

The status of a resource after a resource level operation was performed

The resources needed for the user request with the resourceContext

The resources needed for the user request

The resources needed for the user request with the context for tracking purposes

The retry policy for the user request

The scheduled action resource

Optional parameters.

Interface representing a ScheduledActionExtension operations.

Optional parameters.

Interface representing a ScheduledActionOperationStatus operations.

Scheduled action properties

Represents an scheduled action resource metadata.

Represents the writable fields of a scheduled action resource used in attach and patch requests.

The scheduled action extension

The type used for update operations of the ScheduledAction.

The updatable properties of the ScheduledAction.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Scheduled action extension properties

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ScheduledActions operations.

Optional parameters.

Specify the schedule in which the scheduled action is supposed to follow

Schedule properties for update (PATCH). All properties are optional so individual fields can be patched (merge semantics); omitting a property preserves the current value.

Optional parameters.

Optional parameters.

Specifies additional publishing targets for scheduled events.

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.

Profile for the scheduled events.

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

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.

The response from a start request

Specifies the storage settings for the virtual machine disks.

Describes a reference to a sub-resource.

Metadata pertaining to creation and last modification of the resource.

Profile properties for the Terminate Scheduled event.

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.

model interface UserAssignedIdentitiesValue

User assigned identity properties

Specifies Reboot related Scheduled Event related configurations.

Specifies Redeploy related Scheduled Event related configurations.

VMAttributes using double values.

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 that will be used to filter VMSizes which will be used to launch instances.

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

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.

A virtual machine launched by a LaunchBulkInstancesOperation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineBulkOperations operations.

Identity for the virtual machine.

Information about a virtual machine.

Contains the IP tag associated with the public IP address.

Describes a virtual machine network interface configurations.

Describes a virtual machine network profile's IP configuration.

Describes a virtual machines network configuration's DNS settings.

Describes a virtual machine network profile's IP configuration.

Describes a virtual machine network interface IP configuration properties.

Describes a virtual machines IP Configuration's PublicIPAddress configuration

Describes a virtual machines IP Configuration's PublicIPAddress configuration

Describes a virtual machines network configuration's DNS settings.

Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged

A VM size profile with a name and rank for flex VM creation

Specifies VM Size Property settings on the virtual machine.

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.

The zone allocation policy for distributing VMs across availability zones

A zone preference with a zone identifier and rank

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

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

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.

The allocation strategy for VM size selection
KnownAllocationStrategy can be used interchangeably with AllocationStrategy, this enum contains the known values that the service supports.

Known values supported by the service

LowestPrice: Platform prioritizes VM sizes with the lowest hourly cost
Prioritized: Customer specifies a rank for each VM size, platform uses VM sizes in rank order
CapacityOptimized: Platform prioritizes VM sizes with the highest available capacity first

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

The supported values for cloud setting as a string literal type

The allocation strategy for VM size selection in BulkCreateCustom.
KnownBulkCreateCustomAllocationStrategy can be used interchangeably with BulkCreateCustomAllocationStrategy, this enum contains the known values that the service supports.

Known values supported by the service

LowestPrice: Platform prioritizes VM sizes with the lowest hourly cost
Prioritized: Customer specifies a rank for each VM size, platform uses VM sizes in rank order

The distribution strategy for zone allocation in BulkCreateCustom.
KnownBulkCreateCustomDistributionStrategy can be used interchangeably with BulkCreateCustomDistributionStrategy, this enum contains the known values that the service supports.

Known values supported by the service

BestEffortSingleZone: Platform attempts to place as many VMs as possible in a single zone, falls back to multiple zones if needed
Prioritized: Platform uses customer-provided zone rankings to allocate VMs
BestEffortBalanced: Platform attempts to evenly distribute VMs across all available zones with best effort

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage
KnownCachingTypes can be used interchangeably with CachingTypes, this enum contains the known values that the service supports.

Known values supported by the service

None: Caching type:None
ReadOnly: Caching type:ReadOnly
ReadWrite: Caching type:ReadWrite

Capacity types for LaunchBulkInstancesOperation.
KnownCapacityType can be used interchangeably with CapacityType, this enum contains the known values that the service supports.

Known values supported by the service

VM: Default. VM is the default capacity type for LaunchBulkInstancesOperation where capacity is provisioned in terms of VMs.
VCpu: VCpu is the capacity type for LaunchBulkInstancesOperation where capacity is provisioned in terms of VCpus. If VCpu capacity is not exactly divisible by VCpu count in VMSizes, capacity in VCpus will be overprovisioned by default.

An interface that describes a page of results.

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.

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

The types of deadlines supported by Bulkactions
KnownDeadlineType can be used interchangeably with DeadlineType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Default value of Unknown.
InitiateAt: Initiate the operation at the given deadline.
CompleteBy: Complete the operation by the given deadline.

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 network interface when the VM is deleted
Detach: Detach network interface when the VM is deleted

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

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 controller type
NVMe: NVMe disk controller type

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

Known values supported by the service

FromImage: Create disk FromImage
Empty: Empty value
Attach: Create disk by Attach
Copy: Create disk by Copy
Restore: Create disk by 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: Delete the disk upon VM deletion
Detach: Detach the disk upon VM deletion

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.
KnownDiskDetachOptionTypes can be used interchangeably with DiskDetachOptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

ForceDetach: ForceDetach the disk

The distribution strategy for zone allocation
KnownDistributionStrategy can be used interchangeably with DistributionStrategy, this enum contains the known values that the service supports.

Known values supported by the service

BestEffortSingleZone: Platform attempts to place as many VMs as possible in a single zone, falls back to multiple zones if needed
Prioritized: Platform uses customer-provided zone rankings to allocate VMs
BestEffortBalanced: Platform attempts to evenly distribute VMs across all available zones with best effort
StrictBalanced: Platform must evenly distribute VMs across zones, request is rejected if exact balance cannot be achieved

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 scope type
SubscriptionReuse: SubscriptionReuse scope type
ResourceGroupReuse: ResourceGroupReuse scope type
NoReuse: NoReuse scope type

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

HyperVGenerations supported by Azure VMs.
KnownHyperVGeneration can be used interchangeably with HyperVGeneration, this enum contains the known values that the service supports.

Known values supported by the service

Gen1: Gen1 hyperV.
Gen2: Gen2 hyperV.

Available from compute 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'.
KnownIPVersions can be used interchangeably with IPVersions, this enum contains the known values that the service supports.

Known values supported by the service

IPv4: IPv4 version
IPv6: IPv6 version

The notification languages currently supported
KnownLanguage can be used interchangeably with Language, this enum contains the known values that the service supports.

Known values supported by the service

en-us: American english language

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: ImageDefault mode
AutomaticByPlatform: AutomaticByPlatform mode

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: Reboot if required
Never: Never reboot
Always: Always reboot

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

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
KnownLinuxVMGuestPatchMode can be used interchangeably with LinuxVMGuestPatchMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault: ImageDefault linux VM guest patch mode
AutomaticByPlatform: AutomaticByPlatform linux VM guest patch mode

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: SSD DiskType.

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.

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

Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation.
KnownModes can be used interchangeably with Modes, this enum contains the known values that the service supports.

Known values supported by the service

Audit: Audit mode
Enforce: Enforce mode
Disabled: Disabled mode

Representation of the months available selection in a gregorian calendar
KnownMonth can be used interchangeably with Month, this enum contains the known values that the service supports.

Known values supported by the service

January: The January month.
February: The February month.
March: The March month.
April: The April month.
May: The May month.
June: The June month.
July: The July month.
August: The August month.
September: The September month.
October: The October month.
November: The November month.
December: The December month.
All: All months

Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations
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: 2020-11-01 version
2022-11-01: 2022-11-01 version

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

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

The type of notification supported
KnownNotificationType can be used interchangeably with NotificationType, this enum contains the known values that the service supports.

Known values supported by the service

Email: Notify through e-mail

The state the occurrence is at a given time
KnownOccurrenceState can be used interchangeably with OccurrenceState, this enum contains the known values that the service supports.

Known values supported by the service

Created: The occurrence was created
Rescheduling: The occurrence is being rescheduled
Scheduled: The occurrence has been scheduled
Succeeded: The occurrence has successfully ran
Failed: The occurrence has failed during its scheduling
Cancelling: The occurrence is going through cancellation
Canceled: The occurrence has been canceled

This property allows you to specify the supported type of the OS that application is built for. 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
Linux: Linux OS

Values that define the states of operations in Bulkactions
KnownOperationState can be used interchangeably with OperationState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: The default value for the operation state enum
PendingScheduling: Operations that are pending scheduling
Scheduled: Operations that have been scheduled
PendingExecution: Operations that are waiting to be executed
Executing: Operations that are in the process of being executed
Succeeded: Operations that succeeded
Failed: Operations that have failed
Cancelled: Operations that have been Cancelled by the user
Blocked: Operations that are blocked

The preferences customers can select to optimize their requests to ScheduledActions
KnownOptimizationPreference can be used interchangeably with OptimizationPreference, this enum contains the known values that the service supports.

Known values supported by the service

Cost: Optimize while considering cost savings
Availability: Optimize while considering availability of resources
CostAvailabilityBalanced: Optimize while considering a balance of cost and availability

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.

The supported operating system types for flex VM creation
KnownOsType can be used interchangeably with OsType, this enum contains the known values that the service supports.

Known values supported by the service

Windows: Windows operating system
Linux: Linux operating system

The priority type for VM allocation
KnownPriorityType can be used interchangeably with PriorityType, this enum contains the known values that the service supports.

Known values supported by the service

Regular: Regular priority VMs
Spot: Spot priority VMs

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

The status of the LaunchBulkInstancesOperation.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Initial creation in progress.
Succeeded: The operation has completed successfully.
Failed: The operation has failed.
Deleting: Deletion in progress.
Canceled: The operation has been canceled.

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 IP sku name
Standard: Standard IP sku name

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 IP address sku tier
Global: Global IP address sku tier

Specify the public IP allocation type
KnownPublicIPAllocationMethod can be used interchangeably with PublicIPAllocationMethod, this enum contains the known values that the service supports.

Known values supported by the service

Dynamic: Dynamic IP allocation
Static: Static IP allocation

The type of deadline the scheduled action follows for its schedule.
KnownRecurringScheduledActionsDeadlineType can be used interchangeably with RecurringScheduledActionsDeadlineType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Default value of Unknown.
InitiateAt: Initiate the operation at the given deadline.
CompleteBy: Complete the operation by the given deadline.

Provisioning state of the scheduled action resource.
KnownRecurringScheduledActionsProvisioningState can be used interchangeably with RecurringScheduledActionsProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Deleting: Resource is being deleted.

The resource operation to take on a scheduled-action failure.
KnownRecurringScheduledActionsResourceOperationType can be used interchangeably with RecurringScheduledActionsResourceOperationType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: The default value for this enum type
Start: Start operations on the resources
Deallocate: Deallocate operations on the resources
Hibernate: Hibernate operations on the resources
Create: Create operations on the resources
Delete: Delete operations on the resources

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

The state the resource is on after the resource operation is applied
KnownResourceOperationStatus can be used interchangeably with ResourceOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The resource operation was successful
Failed: The resource operation has failed.

The kind of bulk operation that can be performed on resources using Bulkactions API
KnownResourceOperationType can be used interchangeably with ResourceOperationType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: The default value for this enum type
Start: Start operations on the resources
Deallocate: Deallocate operations on the resources
Hibernate: Hibernate operations on the resources
Create: Create operations on the resources
Delete: Delete operations on the resources
GetInstanceView: Post-Start VM agent health-check sub-operation; surfaced when the customer opts into verifyVmAgentHealth on a Start request

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: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.

The type of resource being targeted
KnownResourceType can be used interchangeably with ResourceType, this enum contains the known values that the service supports.

Known values supported by the service

VirtualMachine: Resources defined are Virtual Machines
VirtualMachineScaleSet: Resources defined are Virtual Machines Scale Sets

Specify which action user wants to be performed on the resources
KnownScheduledActionType can be used interchangeably with ScheduledActionType, this enum contains the known values that the service supports.

Known values supported by the service

Start: Perform a start action on the specified resources
Deallocate: Perform a deallocate action on the specified resources
Hibernate: Perform hibernate and deallocate on the specified resources

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

Known values supported by the service

VMGuestStateOnly: VMGuestStateOnly encryption
DiskWithVMGuestState: DiskWithVMGuestState encryption
NonPersistedTPM: NonPersistedTPM encryption

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

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

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 storage account type
Premium_LRS: Premium_LRS storage account type
StandardSSD_LRS: StandardSSD_LRS storage account type
UltraSSD_LRS: UltraSSD_LRS storage account type
Premium_ZRS: Premium_ZRS storage account type
StandardSSD_ZRS: StandardSSD_ZRS storage account type
PremiumV2_LRS: PremiumV2_LRS storage account type

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.

VMCategories defined for Azure VMs.
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.
GpuAccelerated: GPU optimized VM sizes are specialized virtual machines available with single, multiple, or fractional GPUs.
FpgaAccelerated: FPGA optimized VM sizes are specialized virtual machines available with single or multiple FPGA.
HighPerformanceCompute: Azure High Performance Compute VMs are optimized for various HPC workloads such as CFD, FEA, EDA, rendering, molecular dynamics, weather simulation, and financial risk analysis.

Virtual Machine operation status values.
KnownVMOperationStatus can be used interchangeably with VMOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Indicates that the virtual machine is either in the process of being created or is scheduled to be created.
Canceled: Indicates that the cancellation request was successful because the virtual machine had not been created yet.
CancelFailedStatusUnknown: Indicates that the cancellation request could not be applied because the virtual machine had already been created.
Failed: Indicates that the virtual machine operation failed.
Succeeded: Indicates that the virtual machine operation completed successfully.
Deleting: Indicates that the virtual machine is being deleted.
Cancelling: Indicates that the virtual machine operation is being cancelled.

Representation of the possible selection of days in a week in a gregorian calendar
KnownWeekDay can be used interchangeably with WeekDay, this enum contains the known values that the service supports.

Known values supported by the service

Monday: Monday weekday.
Tuesday: Tuesday weekday.
Wednesday: Wednesday weekday.
Thursday: Thursday weekday.
Friday: Friday weekday.
Saturday: Saturday weekday.
Sunday: Sunday weekday.
All: All week days

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

Known values supported by the service

ImageDefault: ImageDefault patch assessment mode
AutomaticByPlatform: AutomaticByPlatform patch assessment mode

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: Reboot setting for Unknown
IfRequired: Reboot setting for IfRequired
Never: Reboot setting for Never
Always: Reboot setting for 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.

Possible values are:

Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

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

AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
KnownWindowsVMGuestPatchMode can be used interchangeably with WindowsVMGuestPatchMode, this enum contains the known values that the service supports.

Known values supported by the service

Manual: Manual VM guest patch mode
AutomaticByOS: AutomaticByOS VM guest patch mode
AutomaticByPlatform: AutomaticByPlatform VM guest patch mode

An enum to describe Azure Cloud environments.

Accelerator manufacturers supported by Azure VMs.

Accelerator types supported by Azure VMs.

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

The allocation strategy for VM size selection

Architecture types supported by Azure VMs.

The allocation strategy for VM size selection in BulkCreateCustom.

The distribution strategy for zone allocation in BulkCreateCustom.

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

Capacity types for LaunchBulkInstancesOperation.

Cpu Manufacturers supported by Azure VMs.

The kind of entity that created the resource.

The types of deadlines supported by Bulkactions

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

Specifies the ephemeral disk option for operating system disk.

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

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.

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

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.

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

The distribution strategy for zone allocation

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

Different kind of eviction policies

HyperVGenerations supported by Azure VMs.

Available from compute 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'.

The notification languages currently supported

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.

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

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

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

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

Local storage disk types supported by Azure VMs.

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

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.

Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation.

Representation of the months available selection in a gregorian calendar

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

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

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

The type of notification supported

The state the occurrence is at a given time

This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.

Values that define the states of operations in Bulkactions

The preferences customers can select to optimize their requests to ScheduledActions

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

The supported operating system types for flex VM creation

The priority type for VM allocation

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

The status of the LaunchBulkInstancesOperation.

Specify public IP sku name

Specify public IP sku tier

Specify the public IP allocation type

The type of deadline the scheduled action follows for its schedule.

Provisioning state of the scheduled action resource.

The resource operation to take on a scheduled-action failure.

The state the resource is on after the resource operation is applied

The kind of bulk operation that can be performed on resources using Bulkactions API

The provisioning state of a resource type.

The type of resource being targeted

Specify which action user wants to be performed on the resources

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.

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.

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

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

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

VMCategories defined for Azure VMs.

Virtual Machine operation status values.

ComputeSchedule API versions

Representation of the possible selection of days in a week in a gregorian calendar

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.

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

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

Possible values are:

Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

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

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

Typeguard for RestError

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.

A custom error type for failed pipeline requests.