Azure.ResourceManager.Compute.BulkActions.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AcknowledgeBulkOperationErrorsRequestContent |
The operations for which errors should be acknowledged. |
| AcknowledgeBulkOperationErrorsResponseResult |
The result of acknowledging errors for specified operations. |
| 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. |
| ArmComputeBulkActionsModelFactory |
A factory class for creating instances of the models for mocking. |
| 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. |
| BulkActionExecutionParameterDetail |
The execution settings for a bulk action. |
| BulkActionsCapacityRecommendationParametersContent |
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. |
| BulkActionsExecuteReimageRequestContent |
The virtual machines and configuration for a bulk reimage action. |
| BulkActionsOSProfileProvisioningContent |
Additional parameters for reimaging a virtual machine that does not use an ephemeral operating system disk. |
| BulkActionsReimageResourceOperationResponseResult |
The result of a bulk reimage action. |
| BulkActionsVirtualMachinePlacement |
The customer-defined constraints for virtual machine placement. |
| BulkActionsVirtualMachineReimageParametersContent |
The parameters for reimaging a virtual machine. The operating system disk is always reimaged. |
| BulkActionVMExtension |
Defines a virtual machine extension. |
| BulkActionVMExtensionProperties |
Describes the properties of a Virtual Machine Extension. |
| BulkActionVMProperties |
Describes the properties of a Virtual Machine for bulk create. |
| BulkCreateCustomOverride |
A single per-VM override. Extends the shared override fields with a per-VM name. |
| BulkCreateCustomOverridesProfile |
Groups the per-VM overrides with the name prefix that names any override that does not supply its own VM name. |
| BulkCreateCustomProperties |
Details of the BulkCreateCustom. |
| BulkCreateCustomResolvedItem |
A virtual machine resource resolved for a BulkCreateCustom operation. |
| BulkCreateCustomVirtualMachineInfo |
Information about a virtual machine resolved for a BulkCreateCustom operation. |
| BulkCreateProperties |
Details of the BulkCreate. |
| BulkOperationRetryPolicy |
The retry settings for a bulk action. |
| CancelBulkOperationsContent |
The eligible operations to cancel. |
| CancelBulkOperationsResult |
The results of the cancellation requests. |
| CancelOccurrenceRequestContent |
Request body for canceling a recurring bulk action occurrence. |
| CapacityRecommendation |
The capacity/placement recommendation computed for a resource operation. |
| CapacityRecommendationDetails |
The details of a capacity recommendation. |
| CapacityRecommendationPlacementScore |
The placement score for a given SKU, region and optionally availability zone. |
| CapacityRecommendationSize |
A desired VM size (SKU) considered for the capacity recommendation. |
| ComputeBulkActionsSubResourceInfo |
A reference to an Azure resource. |
| ComputeBulkFallbackOperationInfo |
Information about the fallback operation attempted after the requested operation did not succeed. |
| ComputeBulkOperationDetails |
The details of a response from an operation on a resource. |
| ComputeBulkOperationError |
An error that occurred while processing one virtual machine. |
| ComputeBulkOperationResult |
The result of a bulk action for one virtual machine. |
| ComputeProfile |
Compute Profile to configure the Virtual Machines. |
| DataDisk |
Describes a data disk. |
| DeallocateResourceOperationResult |
The result of a bulk deallocate action. |
| DelayRequestContent |
Request body for delaying a recurring bulk action occurrence. |
| DeleteResourceOperationResult |
The result of a bulk delete action. |
| 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. |
| DiskEncryptionSettings |
Describes a Encryption Settings for a Disk. |
| EventGridAndResourceGraph |
Specifies eventGridAndResourceGraph related Scheduled Event related configurations. |
| ExecuteDeallocateContent |
The virtual machines and execution settings for a bulk deallocate action. |
| ExecuteDeleteContent |
The virtual machines and execution settings for a bulk delete action. |
| ExecuteHibernateContent |
The virtual machines and execution settings for a bulk hibernate action. |
| ExecuteStartContent |
The virtual machines and execution settings for a bulk start action. |
| GetBulkOperationStatusContent |
The operation for which current status should be returned. |
| GetBulkOperationStatusResult |
The current results for the requested operations. |
| HardwareProfile |
Specifies the hardware profile for the virtual machine. |
| HibernateResourceOperationResult |
The result of a bulk hibernate action. |
| 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. |
| KeyVaultKeyReference |
Describes a reference to Key Vault Key. |
| KeyVaultSecretReference |
A reference to a secret stored in Azure Key Vault. |
| 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. |
| ManagedDiskParametersContent |
The parameters of a managed disk. |
| 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. |
| NotificationProperties |
Settings for notifications about upcoming recurring bulk action operations. |
| OccurrenceExtension |
A recurring bulk action occurrence associated with a specific compute resource. |
| OccurrenceExtensionProperties |
An occurrence associated with a specific compute resource. |
| OccurrenceProperties |
Properties of a recurring bulk action occurrence. |
| OccurrenceResourceMetadata |
Scheduling and status details for a resource included in a recurring bulk action occurrence. |
| OccurrenceResultSummary |
Summary of results for a recurring bulk action occurrence. |
| 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. |
| PatchSettings |
Specifies settings related to VM Guest Patching on Windows. |
| ProxyAgentSettings |
Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. |
| PublicIPAddressSku |
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. |
| ReimagePayload |
The shared and per-virtual-machine configuration for a bulk reimage action. |
| ReimageResourceOverride |
A reimage configuration override for one virtual machine. |
| ResourceAttachRequestContent |
Resources to attach to a recurring bulk action. |
| ResourceDetachRequestContent |
Resources to remove from a recurring bulk action. |
| ResourceOperationResponseResult |
Results of a recurring bulk action operation for targeted resources. |
| ResourcePatchRequestContent |
Resource-specific settings to update in a recurring bulk action. |
| ResourceResultSummary |
Summary of operation results across targeted resources. |
| ResourceStatus |
Current status for a targeted resource in a recurring bulk action occurrence. |
| ResourcesWithContext |
The resources needed for the user request with the context for tracking purposes. |
| ResourceWithContext |
The resources needed for the user request with the resourceContext. |
| ScheduledActionPatch |
The type used for update operations of the ScheduledAction. |
| ScheduledActionProperties |
Configuration and status of a recurring bulk action. |
| ScheduledActionResourceInput |
A compute resource to add to or update in a recurring bulk action. |
| ScheduledActionResourceMetadata |
A compute resource associated with a recurring bulk action. |
| ScheduledActionResources |
A recurring bulk action associated with a specific compute resource. |
| ScheduledActionsExtensionProperties |
A recurring bulk action associated with a specific compute resource. |
| ScheduledActionsRetryPolicy |
Retry settings for a recurring bulk action operation. |
| ScheduledActionsSchedule |
The recurring schedule for a recurring bulk action. |
| ScheduledActionsSchedulePatch |
Schedule changes for a recurring bulk action. Omitted properties keep their current values. |
| ScheduledActionUpdateProperties |
The updatable properties of the ScheduledAction. |
| 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. |
| SshPublicKey |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. |
| StartResourceOperationResult |
The result of a bulk start action. |
| StorageProfile |
Specifies the storage settings for the virtual machine disks. |
| 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. |
| UserAssignedIdentitiesValue |
The UserAssignedIdentitiesValue. |
| UserRequestResources |
The virtual machines targeted by a bulk action. |
| 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. |
| VirtualMachineIdentity |
Identity for the virtual machine. |
| VirtualMachineInfo |
Information about a virtual machine. |
| 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. |
| VirtualMachineNetworkInterfaceIPConfiguration |
Describes a virtual machine network profile's IP configuration. |
| VirtualMachineNetworkInterfaceIPConfigurationProperties |
Describes a virtual machine network interface IP configuration properties. |
| 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. |
| VMDiskSecurityProfile |
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. |
| VMGalleryApplication |
Specifies the required information to reference a compute gallery application version. |
| VmSizeProperties |
Specifies VM Size Property settings on the virtual machine. |
| 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. |
| WinRMListener |
Describes Protocol and thumbprint of Windows Remote Management listener. |
Structs
| Name | Description |
|---|---|
| AdditionalUnattendContentComponentName | |
| AdditionalUnattendContentPassName | |
| BulkActionDeadlineKind |
The deadline behavior for a bulk action. |
| BulkActionOperationState |
The current state of a bulk action. |
| BulkInstancesOperationProvisioningState |
The status of the LaunchBulkInstancesOperation. |
| CachingTypes |
Specifies the caching requirements. Possible values are: None,ReadOnly,ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
| CapacityRecommendationStatus |
The lifecycle status of the capacity recommendation for an operation. |
| CapacityType |
Capacity types for LaunchBulkInstancesOperation. |
| ComputeBulkOperationKind |
The type of operation performed by Bulk Actions. |
| DeleteConfig |
Specify what happens to the network interface when the VM is deleted. |
| DiffDiskConfig |
Specifies the ephemeral disk option for operating system disk. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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'. |
| 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. |
| EvictionPolicy |
Different kind of eviction policies. |
| ImdsAccessControlMode |
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. |
| 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'. |
| LinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine. <br /><br /> AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
| LinuxVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
| 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.<br /><br /> Possible values are:<br /><br /> ImageDefault - The virtual machine's default patching configuration is used. <br /><br /> AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true. |
| Month |
A month in which the recurring bulk action can run. |
| NetworkApiVersion |
Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations. |
| NetworkInterfaceAuxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
| NetworkInterfaceAuxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
| NotificationType |
The delivery method for recurring bulk action notifications. |
| OccurrenceResourceProvisioningState |
The provisioning state of a recurring bulk action resource within an occurrence. |
| OccurrenceState |
The current state of a recurring bulk action occurrence. |
| OperatingSystemTypes |
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows,Linux.. |
| PriorityType |
The priority type for virtual machine allocation. |
| ProtocolTypes |
Specifies the protocol of WinRM listener. Possible values are: http,https.. |
| ProxyAgentMode |
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. |
| PublicIPAddressSkuName |
Specify public IP sku name. |
| PublicIPAddressSkuTier |
Specify public IP sku tier. |
| PublicIPAllocationMethod |
Specify the public IP allocation type. |
| ResourceOperationStatus |
Current status of an operation for the specific occurrence and resource. |
| ScheduledActionLanguage |
The language used for recurring bulk action notifications. |
| ScheduledActionsDeadlineType |
How the scheduled time is interpreted for the resource operation. |
| ScheduledActionsProvisioningState |
The provisioning state of the recurring bulk action. |
| ScheduledActionsResourceOperationType |
The operation to retry when a recurring bulk action fails. |
| ScheduledActionsResourceType |
The type of compute resource targeted by the recurring bulk action. |
| ScheduledActionType |
The operation performed by the recurring bulk action. |
| 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. |
| 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. |
| SettingNames |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
| 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. |
| WeekDay |
A day of the week on which the recurring bulk action can run. |
| WindowsPatchAssessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> ImageDefault - You control the timing of patch assessments on a virtual machine.<br /><br /> AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. |
| WindowsVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
| 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.<br /><br /> Possible values are:<br /><br /> 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<br /><br /> AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true. |
| ZonePlacementPolicyType |
The policy used to select an availability zone for the virtual machine. |
Enums
| Name | Description |
|---|---|
| ComputeBulkActionsIdentityType |
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. |