@azure/arm-computebulkactions package

Classes

Interfaces

AdditionalCapabilities	Enables or disables a capability on the virtual machine or virtual machine scale set.
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.
AllInstancesDown	Specifies if Scheduled Events should be auto-approved when all instances are down.
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
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.
BulkActionsCancelOptionalParams	Optional parameters.
BulkActionsCreateOrUpdateOptionalParams	Optional parameters.
BulkActionsDeleteOptionalParams	Optional parameters.
BulkActionsGetOperationStatusOptionalParams	Optional parameters.
BulkActionsGetOptionalParams	Optional parameters.
BulkActionsListByResourceGroupOptionalParams	Optional parameters.
BulkActionsListBySubscriptionOptionalParams	Optional parameters.
BulkActionsListVirtualMachinesOptionalParams	Optional parameters.
BulkActionsOperations	Interface representing a BulkActions operations.
BulkActionsVirtualMachinesCancelOperationsOptionalParams	Optional parameters.
BulkActionsVirtualMachinesExecuteCreateOptionalParams	Optional parameters.
BulkActionsVirtualMachinesExecuteDeallocateOptionalParams	Optional parameters.
BulkActionsVirtualMachinesExecuteDeleteOptionalParams	Optional parameters.
BulkActionsVirtualMachinesExecuteHibernateOptionalParams	Optional parameters.
BulkActionsVirtualMachinesExecuteStartOptionalParams	Optional parameters.
BulkActionsVirtualMachinesGetOperationStatusOptionalParams	Optional parameters.
CancelOperationsRequest	This is the request to cancel running operations in bulkactions using the operation ids
CancelOperationsResponse	This is the response from a cancel operations request
CapacityReservationProfile	The parameters of a capacity reservation Profile.
ComputeBulkActionsClientOptionalParams	Optional parameters for the client.
ComputeProfile	Compute Profile to configure the Virtual Machines.
CreateResourceOperationResponse	The response from a create request
DataDisk	Describes a data disk.
DeallocateResourceOperationResponse	The response from a deallocate request
DeleteResourceOperationResponse	The response from a delete request
DiagnosticsProfile	Specifies the boot diagnostic settings state. Minimum compute 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.
DiskEncryptionSettings	Describes a Encryption Settings for a Disk
EncryptionIdentity	Specifies the Managed Identity used by ADE to get access token for keyvault operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
EventGridAndResourceGraph	Specifies eventGridAndResourceGraph related Scheduled Event related configurations.
ExecuteCreateRequest	The ExecuteCreateRequest request for create operations
ExecuteDeallocateRequest	The ExecuteDeallocateRequest request for executeDeallocate operations
ExecuteDeleteRequest	The ExecuteDeleteRequest for delete VM operation
ExecuteHibernateRequest	The ExecuteHibernateRequest request for executeHibernate operations
ExecuteStartRequest	The ExecuteStartRequest request for executeStart operations
ExecutionParameters	Extra details needed to run the user's request
GetOperationStatusRequest	This is the request to get operation status using operationids
GetOperationStatusResponse	This is the response from a get operations status request
HibernateResourceOperationResponse	The response from a Hibernate request
HostEndpointSettings	Specifies particular host endpoint settings.
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.
KeyVaultKeyReference	Describes a reference to Key Vault Key
KeyVaultSecretReference	Describes a reference to Key Vault Secret
LaunchBulkInstancesOperationProperties	Details of the LaunchBulkInstancesOperation.
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.
LocationBasedLaunchBulkInstancesOperation	Location based type.
ManagedDiskParameters	The parameters of a managed disk.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NetworkInterfaceReference	Describes a network interface reference.
NetworkInterfaceReferenceProperties	Describes a network interface reference properties.
NetworkProfile	Specifies the network interfaces or the networking configuration of the virtual machine.
OSDisk	Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
OSImageNotificationProfile	Profile for the OS Image Scheduled event.
OSProfile	Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationStatusResult	The current status of an async 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.
PriorityProfile	Contains properties that are applicable to both Spot and Regular.
ProxyAgentSettings	Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PublicIPAddressSku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceOperation	Top level response from an operation on a resource
ResourceOperationDetails	The details of a response from an operation on a resource
ResourceOperationError	These describe errors that occur at the resource level
ResourceProvisionPayload	Resource creation data model
Resources	The resources needed for the user request
RestorePollerOptions
RetryPolicy	The retry policy for the user request
ScheduledEventsAdditionalPublishingTargets	Specifies additional publishing targets for scheduled events.
ScheduledEventsPolicy	Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.
ScheduledEventsProfile	Profile for the scheduled events.
SecurityProfile	Specifies the Security profile settings for the virtual machine or virtual machine scale set.
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.
StartResourceOperationResponse	The response from a start request
StorageProfile	Specifies the storage settings for the virtual machine disks.
SubResource	Describes a reference to a sub-resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TerminateNotificationProfile	Profile properties for the Terminate Scheduled event.
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
UserInitiatedReboot	Specifies Reboot related Scheduled Event related configurations.
UserInitiatedRedeploy	Specifies Redeploy related Scheduled Event related configurations.
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 launch instances.
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
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.
VirtualMachine	An instant Fleet's virtual machine.
VirtualMachineExtension	Defines a virtual machine extension.
VirtualMachineExtensionProperties	Describes the properties of a Virtual Machine Extension.
VirtualMachineIpTag	Contains the IP tag associated with the public IP address.
VirtualMachineNetworkInterfaceConfiguration	Describes a virtual machine network interface configurations.
VirtualMachineNetworkInterfaceConfigurationProperties	Describes a virtual machine network profile's IP configuration.
VirtualMachineNetworkInterfaceDnsSettingsConfiguration	Describes a virtual machines network configuration's DNS settings.
VirtualMachineNetworkInterfaceIPConfiguration	Describes a virtual machine network profile's IP configuration.
VirtualMachineNetworkInterfaceIPConfigurationProperties	Describes a virtual machine network interface IP configuration properties.
VirtualMachineProfile	Describes the properties of a Virtual Machine.
VirtualMachinePublicIPAddressConfiguration	Describes a virtual machines IP Configuration's PublicIPAddress configuration
VirtualMachinePublicIPAddressConfigurationProperties	Describes a virtual machines IP Configuration's PublicIPAddress configuration
VirtualMachinePublicIPAddressDnsSettingsConfiguration	Describes a virtual machines network configuration's DNS settings.
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.
ZoneAllocationPolicy	ZoneAllocationPolicy for LaunchBulkInstancesOperation.
ZonePreference	Zone preferences for LaunchBulkInstancesOperation zone allocation policy.

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.
AllocationStrategy	Allocation strategy types for LaunchBulkInstancesOperation KnownAllocationStrategy can be used interchangeably with AllocationStrategy, 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. 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. Prioritized: VM sizes distribution will be determined to optimize for the 'rank' specified for each vm size.
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
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CachingTypes	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
CapacityType	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.
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. 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.
DeadlineType	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.
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 network interface when the VM is deleted Detach: Detach network interface when the VM is deleted
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 Ephemeral disk option: Local
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, 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
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 controller type NVMe: NVMe disk controller type
DiskCreateOptionTypes	Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. 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
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: Delete the disk upon VM deletion Detach: Detach the disk upon VM deletion
DiskDetachOptionTypes	Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values 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
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 scope type SubscriptionReuse: SubscriptionReuse scope type ResourceGroupReuse: ResourceGroupReuse scope type NoReuse: NoReuse scope 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
HyperVGeneration	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.
IPVersions	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
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: ImageDefault mode AutomaticByPlatform: AutomaticByPlatform mode
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: Reboot if required Never: Never reboot Always: Always reboot
LinuxVMGuestPatchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true 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
LocalStorageDiskType	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.
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
Modes	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
NetworkApiVersion	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
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: None: None sku A1: A1 sku A2: A2 sku A4: A4 sku A8: A8 sku
OperatingSystemTypes	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
OperationState	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
OptimizationPreference	The preferences customers can select to optimize their requests to Bulkactions 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
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 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.
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 IP sku name Standard: Standard IP 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 IP address sku tier Global: Global IP address sku tier
PublicIPAllocationMethod	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
ResourceOperationType	The kind of operation types that can be performed on resources eg Virtual Machines, using BulkActions 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
SecurityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. 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
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 mode FirstLogonCommands: FirstLogonCommands mode
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 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
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.
VMOperationStatus	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.
VirtualMachineType	Specifies the priority type of virtual machines to launch. KnownVirtualMachineType can be used interchangeably with VirtualMachineType, this enum contains the known values that the service supports. Known values supported by the service Regular: Default. Regular/On-demand VMs will be launched Spot: Spot VMs will be launched.
WindowsPatchAssessmentMode	Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. 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
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: Reboot setting for Unknown IfRequired: Reboot setting for IfRequired Never: Reboot setting for Never Always: Reboot setting for Always
WindowsVMGuestPatchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true 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
ZoneDistributionStrategy	Distribution strategies for LaunchBulkInstancesOperation zone allocation policy. KnownZoneDistributionStrategy can be used interchangeably with ZoneDistributionStrategy, this enum contains the known values that the service supports. Known values supported by the service BestEffortSingleZone: Default. Launch instances in a single zone based on best effort. If capacity is not available, LaunchBulkInstancesOperation can allocate capacity in different zones. Prioritized: Launch instances based on zone preferences. Higher priority zones are filled first before allocating to lower priority zones. BestEffortBalanced: Balance launching instances across zones specified based on best effort. If capacity is not available, LaunchBulkInstancesOperation can deviate balancing across all zones. StrictBalanced: Launch instances across all provided zones, ensuring the difference between any two zones is no more than one instance.

Enums

@azure/arm-computebulkactions.KnownNetworkApiVersion @azure/arm-computebulkactions.KnownVersions

AzureClouds	An enum to describe Azure Cloud environments.
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.
KnownAllocationStrategy	Allocation strategy types for LaunchBulkInstancesOperation
KnownArchitectureType	Architecture types supported by Azure VMs.
KnownCachingTypes	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage
KnownCapacityType	Capacity types for LaunchBulkInstancesOperation.
KnownCpuManufacturer	Cpu Manufacturers supported by Azure VMs.
KnownCreatedByType	The kind of entity that created the resource.
KnownDeadlineType	The types of deadlines supported by Bulkactions
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, 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.
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 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.
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.
KnownDiskDetachOptionTypes	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'.
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
KnownHyperVGeneration	HyperVGenerations supported by Azure VMs.
KnownIPVersions	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'.
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. 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
KnownLocalStorageDiskType	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.
KnownModes	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.
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 supported type of the OS that application is built for. Possible values are: Windows, Linux.
KnownOperationState	Values that define the states of operations in BulkActions
KnownOptimizationPreference	The preferences customers can select to optimize their requests to Bulkactions
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	The status of the LaunchBulkInstancesOperation.
KnownPublicIPAddressSkuName	Specify public IP sku name
KnownPublicIPAddressSkuTier	Specify public IP sku tier
KnownPublicIPAllocationMethod	Specify the public IP allocation type
KnownResourceOperationType	The kind of operation types that can be performed on resources eg Virtual Machines, using BulkActions
KnownSecurityEncryptionTypes	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.
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.
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
KnownVMOperationStatus	Virtual Machine operation status values.
KnownVirtualMachineType	Specifies the priority type of virtual machines to launch.
KnownWindowsPatchAssessmentMode	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.
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. 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
KnownZoneDistributionStrategy	Distribution strategies for LaunchBulkInstancesOperation zone allocation policy.

Functions

restorePoller<TResponse, TResult>(ComputeBulkActionsClient, 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>(ComputeBulkActionsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

Parameters

client: ComputeBulkActionsClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Feedback

Was this page helpful?

Share via

@azure/arm-computebulkactions package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns

Feedback