@azure/arm-compute-bulkactions package

The operations for which errors should be acknowledged.

The result of acknowledging errors for specified operations.

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.

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.

Optional parameters.

Optional parameters.

Interface representing a BulkCreateCustom operations.

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

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 virtual machine resource resolved for a BulkCreateCustom operation.

Information about a virtual machine resolved for a BulkCreateCustom operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BulkCreate operations.

Details of the BulkCreate.

Optional parameters.

Defines a virtual machine extension.

Describes the properties of a Virtual Machine for bulk create.

Request body for canceling a scheduled action occurrence.

The eligible operations to cancel.

The results of the cancellation requests.

The capacity/placement recommendation computed for a resource operation

The details of a capacity recommendation

The parameters used to request capacity/placement recommendations for a start operation. Placement recommendations are only computed if the VM fails to start due to an allocation failure.

The placement score for a given SKU, region and optionally availability zone

A desired VM size (SKU) considered for the capacity recommendation

The parameters of a capacity reservation Profile.

Optional parameters for the client.

Compute Profile to configure the Virtual Machines.

Describes a data disk.

The result of a bulk deallocate action.

Request body for delaying a scheduled action occurrence.

The result of a bulk delete action.

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 virtual machines and execution settings for a bulk deallocate action.

The virtual machines and execution settings for a bulk delete action.

The virtual machines and execution settings for a bulk hibernate action.

The virtual machines and configuration for a bulk reimage action.

The virtual machines and execution settings for a bulk start action.

The execution settings for a bulk action.

The base extension resource.

Information about the fallback operation attempted after the requested operation did not succeed.

The operation for which current status should be returned.

The current results for the requested operations.

Specifies the hardware profile for the virtual machine.

The result of a bulk hibernate action.

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

A reference to a secret stored in Azure Key Vault.

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 BulkCreate resource. The location is part of the resource path.

Location based BulkCreateCustom 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.

Settings for notifications about upcoming scheduled action 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 a virtual machine that does not use an ephemeral operating system disk.

One scheduled execution of a scheduled action.

Optional parameters.

Interface representing a OccurrenceExtension operations.

An occurrence associated with a specific compute resource.

A scheduled action occurrence associated with a specific compute resource.

Properties of a scheduled action occurrence.

Scheduling and status details for a resource included in a scheduled action occurrence.

Summary of results for a scheduled action 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.

Controls how partial fulfillment is handled for a BulkCreateCustom request. When enabled, Azure creates only the VMs or vCPUs it has high confidence can be successfully allocated, instead of attempting the entire request and potentially returning allocation failures.

Specifies settings related to VM Guest Patching on Windows.

Plan for the resource.

The priority and allocation preferences for virtual machines.

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 shared and per-virtual-machine configuration for a bulk reimage action.

The result of a bulk reimage action.

A reimage configuration override for one virtual machine.

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

Resources to attach to a scheduled action.

Resources to remove from a scheduled action.

Caller-provided context associated with a virtual machine operation.

The result of a bulk action for one virtual machine.

The status and settings for an operation on one virtual machine.

An error that occurred while processing one virtual machine.

Results of a scheduled action operation for targeted resources.

Resource-specific settings to update in a scheduled action.

Summary of operation results across targeted resources.

Current status for a targeted resource in a scheduled action occurrence.

The resources needed for the user request with the resourceContext

The virtual machines targeted by a bulk action.

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

The retry settings for a bulk action.

A recurring action that operates on specified compute resources.

Optional parameters.

Interface representing a ScheduledActionExtension operations.

Optional parameters.

Interface representing a ScheduledActionOperationStatus operations.

Configuration and status of a scheduled action.

A compute resource associated with a scheduled action.

A compute resource to add to or update in a scheduled action.

A scheduled action associated with a specific compute resource.

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.

Settings that control how the scheduled action operation is executed.

A scheduled action associated with a specific compute resource.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ScheduledActions operations.

Optional parameters.

Retry settings for a scheduled action operation.

The recurring schedule for a scheduled action.

Schedule changes for a scheduled action. Omitted properties keep their current values.

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 result of a bulk start action.

Specifies the storage settings for the virtual machine disks.

A reference to an Azure 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.

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.

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.

The parameters for reimaging a virtual machine. The operating system disk is always reimaged.

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.

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 supported values for cloud setting as a string literal type

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

The lifecycle status of the capacity recommendation for an operation
KnownCapacityRecommendationStatus can be used interchangeably with CapacityRecommendationStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotInitiated: The capacity recommendation has not been initiated
Succeeded: The capacity recommendation completed successfully
Failed: The capacity recommendation failed
Skipped: The capacity recommendation was skipped

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.

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 deadline behavior for a bulk action.
KnownDeadlineType can be used interchangeably with DeadlineType, this enum contains the known values that the service supports.

Known values supported by the service

InitiateAt: Bulk Actions attempts to start the operation at the specified deadline.
CompleteBy: Bulk Actions attempts to complete the operation by the specified 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 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

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 language used for scheduled action notifications.
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: English (United States).

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

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

A month in which the scheduled action can run.
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 scheduled action can run in January.
February: The scheduled action can run in February.
March: The scheduled action can run in March.
April: The scheduled action can run in April.
May: The scheduled action can run in May.
June: The scheduled action can run in June.
July: The scheduled action can run in July.
August: The scheduled action can run in August.
September: The scheduled action can run in September.
October: The scheduled action can run in October.
November: The scheduled action can run in November.
December: The scheduled action can run in December.
All: Every month.

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 delivery method for scheduled action notifications.
KnownNotificationType can be used interchangeably with NotificationType, this enum contains the known values that the service supports.

Known values supported by the service

Email: Sends notifications by email.

The provisioning state of a scheduled-action resource within an occurrence.
KnownOccurrenceResourceProvisioningState can be used interchangeably with OccurrenceResourceProvisioningState, 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.
Created: The resource has been created
Scheduled: The resource has been scheduled
Cancelling: The resource is going through cancellation
Rescheduling: The resource is being rescheduled
InvalidState: The resource is in an invalid state

The current state of a scheduled action occurrence.
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 has been created.
Rescheduling: The scheduled time for the occurrence is being updated.
Scheduled: The occurrence has been scheduled.
Succeeded: The occurrence operations completed successfully.
Failed: One or more of the occurrence operations failed.
Cancelling: Cancellation of the occurrence is in progress.
Canceled: The occurrence was 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

The current state of a bulk action.
KnownOperationState can be used interchangeably with OperationState, this enum contains the known values that the service supports.

Known values supported by the service

Scheduled: The operation has been scheduled.
Executing: The operation is in progress.
Succeeded: The operation completed successfully.
Failed: The operation failed.
Cancelled: The operation was canceled by the caller.
Blocked: The operation cannot currently make progress.

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.

Whether the service may launch fewer instances than requested when the full capacity cannot be satisfied.
KnownPartialFulfillmentMode can be used interchangeably with PartialFulfillmentMode, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Partial fulfillment is allowed.
Disabled: Partial fulfillment is not allowed.

The reason the requested capacity could only be partially fulfilled.
KnownPartialFulfillmentReason can be used interchangeably with PartialFulfillmentReason, this enum contains the known values that the service supports.

Known values supported by the service

InsufficientCapacity: The requested capacity could not be fully satisfied due to insufficient capacity in the region.
InsufficientQuota: The requested capacity could not be fully satisfied due to insufficient quota in the subscription.
None: The requested capacity was successfully satisfied without any partial fulfillment.

The priority type for virtual machine 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, non-Spot virtual machines.
Spot: Azure Spot Virtual Machines.

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

Current status of an operation for the specific occurrence and resource
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 operation completed successfully for the resource.
Failed: The operation failed for the resource.

The type of operation performed by Bulk Actions.
KnownResourceOperationType can be used interchangeably with ResourceOperationType, this enum contains the known values that the service supports.

Known values supported by the service

Start: Starts the specified virtual machines.
Deallocate: Deallocates the specified virtual machines.
Hibernate: Hibernates the specified virtual machines.
Create: Creates the specified virtual machines.
Delete: Deletes the specified virtual machines.

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

Known values supported by the service

VirtualMachine: Azure virtual machines.
VirtualMachineScaleSet: Azure Virtual Machine Scale Sets.

The operation performed by the scheduled action.
KnownScheduledActionType can be used interchangeably with ScheduledActionType, this enum contains the known values that the service supports.

Known values supported by the service

Start: Starts the targeted resources.
Deallocate: Deallocates the targeted resources.
Hibernate: Hibernates the targeted resources.

How the scheduled time is interpreted for the resource operation.
KnownScheduledActionsDeadlineType can be used interchangeably with ScheduledActionsDeadlineType, this enum contains the known values that the service supports.

Known values supported by the service

InitiateAt: Starts the operation at the scheduled time.
CompleteBy: Completes the operation by the scheduled time.

The provisioning state of the scheduled action.
KnownScheduledActionsProvisioningState can be used interchangeably with ScheduledActionsProvisioningState, 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: The scheduled action is being deleted.
Updating: The scheduled action is being updated.

The operation to retry when a scheduled action fails.
KnownScheduledActionsResourceOperationType can be used interchangeably with ScheduledActionsResourceOperationType, this enum contains the known values that the service supports.

Known values supported by the service

Start: Starts the resources.
Deallocate: Deallocates the resources.
Hibernate: Hibernates the resources.
Create: Creates the resources.
Delete: Deletes 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.
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

A day of the week on which the scheduled action can run.
KnownWeekDay can be used interchangeably with WeekDay, this enum contains the known values that the service supports.

Known values supported by the service

Monday: The scheduled action can run on Monday.
Tuesday: The scheduled action can run on Tuesday.
Wednesday: The scheduled action can run on Wednesday.
Thursday: The scheduled action can run on Thursday.
Friday: The scheduled action can run on Friday.
Saturday: The scheduled action can run on Saturday.
Sunday: The scheduled action can run on Sunday.
All: Every day of the week.

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.

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

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

The lifecycle status of the capacity recommendation for an operation

Capacity types for LaunchBulkInstancesOperation.

The kind of entity that created the resource.

The deadline behavior for a bulk action.

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

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 language used for scheduled action notifications.

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

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.

A month in which the scheduled action can run.

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 delivery method for scheduled action notifications.

The provisioning state of a scheduled-action resource within an occurrence.

The current state of a scheduled action occurrence.

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

The current state of a bulk action.

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

Whether the service may launch fewer instances than requested when the full capacity cannot be satisfied.

The reason the requested capacity could only be partially fulfilled.

The priority type for virtual machine 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

Current status of an operation for the specific occurrence and resource

The type of operation performed by Bulk Actions.

The type of compute resource targeted by the scheduled action.

How the scheduled time is interpreted for the resource operation.

The provisioning state of the scheduled action.

The operation to retry when a scheduled action fails.

The operation performed by the scheduled action.

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

Bulk Actions API versions.

A day of the week on which the scheduled action can run.

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.