@azure/arm-compute-bulkactions package
Classes
| ComputeClient |
Interfaces
| AcknowledgeBulkOperationErrorsRequest |
The request to acknowledge bulk operation errors |
| AcknowledgeBulkOperationErrorsResponse |
The response from acknowledging bulk operation errors |
| 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. |
| BulkActionVmExtensionProperties |
Describes the properties of a Virtual Machine Extension. |
| BulkCreateCustomCancelOptionalParams |
Optional parameters. |
| BulkCreateCustomCreateOrUpdateOptionalParams |
Optional parameters. |
| BulkCreateCustomDeleteOptionalParams |
Optional parameters. |
| BulkCreateCustomGetAsyncOperationStatusOptionalParams |
Optional parameters. |
| BulkCreateCustomGetOptionalParams |
Optional parameters. |
| BulkCreateCustomListByResourceGroupOptionalParams |
Optional parameters. |
| BulkCreateCustomListBySubscriptionOptionalParams |
Optional parameters. |
| BulkCreateCustomOperations |
Interface representing a BulkCreateCustom operations. |
| BulkCreateCustomOverride |
A single per-VM override. Extends the shared override fields with a per-VM name. |
| BulkCreateCustomOverrideBase |
Override fields shared by per-VM and per-VM-size overrides. Each set field takes precedence over the operation-level value. VM size, zone, priority, eviction policy, and billing are owned by the service and cannot be set here. |
| BulkCreateCustomOverridesProfile |
Groups the per-VM overrides with the name prefix that names any override that does not supply its own VM name. |
| BulkCreateCustomPriorityProfile |
Configuration options for Regular or Spot instances in BulkCreateCustom. |
| BulkCreateCustomProperties |
Details of the BulkCreateCustom. |
| BulkCreateCustomResource |
A virtual machine resource resolved for a BulkCreateCustom operation. |
| BulkCreateCustomVirtualMachineInfo |
Information about a virtual machine resolved for a BulkCreateCustom operation. |
| BulkCreateCustomVirtualMachinesGetOperationStatusOptionalParams |
Optional parameters. |
| BulkCreateCustomVmSizeProfile |
A VM size profile entry that may additionally carry an optional per-VM-size profile override. Every VM that the service assigns to this size inherits the override, layered on top of the operation-level base profile and beneath any per-VM override. Present only on the bulkCreateCustom endpoint; the uniform endpoint rejects a non-null override. |
| BulkCreateCustomZoneAllocationPolicy |
The zone allocation policy for distributing VMs across availability zones in BulkCreateCustom. |
| BulkInstancesInnerError |
Inner error details. |
| BulkactionVMExtension |
Defines a virtual machine extension. |
| BulkactionVMProperties |
Describes the properties of a Virtual Machine for bulk create. |
| CancelOccurrenceRequest |
Request body for canceling a scheduled action occurrence. |
| CancelOperationsContent |
This is the request to cancel running operations in scheduled actions using the operation ids |
| CancelOperationsResponse |
This is the response from a cancel operations request |
| CapacityRecommendation |
The capacity/placement recommendation computed for a resource operation |
| CapacityRecommendationDetails |
The details of a capacity recommendation |
| CapacityRecommendationParameters |
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. |
| CapacityRecommendationPlacementScore |
The placement score for a given SKU, region and optionally availability zone |
| CapacityRecommendationSize |
A desired VM size (SKU) considered for the capacity recommendation |
| CapacityReservationProfile |
The parameters of a capacity reservation Profile. |
| ComputeClientOptionalParams |
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 |
| DelayRequest |
Request body for delaying a scheduled action occurrence. |
| 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. |
| DiskEncryptionSetParametersContent |
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. |
| ExecuteCreateContent |
The ExecuteCreateRequest request for create operations |
| ExecuteDeallocateContent |
The ExecuteDeallocateRequest request for executeDeallocate operations |
| ExecuteDeleteContent |
The ExecuteDeleteRequest for delete VM operation |
| ExecuteHibernateContent |
The ExecuteHibernateRequest request for executeHibernate operations |
| ExecuteReimageRequest |
The ExecuteReimageRequest request for reimage operations |
| ExecuteStartContent |
The ExecuteStartRequest request for executeStart operations |
| ExecuteVdiCreateRequest |
The VdiCreateRequest request for create operations |
| ExecutionParameters |
Extra details needed to run the user's request |
| ExtensionResource |
The base extension resource. |
| FallbackOperationInfo |
Describes the fallback operation that was performed |
| FlexProperties |
The flex properties for flexible VM creation |
| GetOperationStatusContent |
This is the request to get operation status using operationids |
| GetOperationStatusResponse |
This is the response from a get operations status request |
| HardwareProfile |
Specifies the hardware profile for the virtual machine. |
| 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. |
| KeyVaultKeyReference |
Describes a reference to Key Vault Key |
| KeyVaultSecretReference |
Describes a reference to Key Vault Secret |
| LaunchBulkInstancesOperationCancelOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationCreateOrUpdateOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationDeleteOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationGetOperationStatusOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationGetOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationListByResourceGroupOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationListBySubscriptionOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationListVirtualMachinesOptionalParams |
Optional parameters. |
| LaunchBulkInstancesOperationOperations |
Interface representing a LaunchBulkInstancesOperation operations. |
| 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. |
| LocationBasedBulkCreateCustom |
Location based BulkCreateCustom resource. The location is part of the resource path. |
| LocationBasedLaunchBulkInstancesOperation |
Location based LaunchBulkInstancesOperation resource. The location is part of the resource path. |
| ManagedDiskParametersContent |
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. |
| NotificationProperties |
Settings for notifications about upcoming scheduled action operations. |
| 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. |
| OSProfileProvisioningData |
Additional parameters for Reimaging Non-Ephemeral Virtual Machine. |
| Occurrence |
One scheduled execution of a scheduled action. |
| OccurrenceExtensionListOccurrenceByVmsOptionalParams |
Optional parameters. |
| OccurrenceExtensionOperations |
Interface representing a OccurrenceExtension operations. |
| OccurrenceExtensionProperties |
An occurrence associated with a specific compute resource. |
| OccurrenceExtensionResource |
A scheduled action occurrence associated with a specific compute resource. |
| OccurrenceProperties |
Properties of a scheduled action occurrence. |
| OccurrenceResource |
Scheduling and status details for a resource included in a scheduled action occurrence. |
| OccurrenceResultSummary |
Summary of results for a scheduled action occurrence. |
| OccurrencesCancelOptionalParams |
Optional parameters. |
| OccurrencesDelayOptionalParams |
Optional parameters. |
| OccurrencesGetOptionalParams |
Optional parameters. |
| OccurrencesListByScheduledActionOptionalParams |
Optional parameters. |
| OccurrencesListResourcesOptionalParams |
Optional parameters. |
| OccurrencesOperations |
Interface representing a Occurrences operations. |
| 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. |
| PartialFulfillmentPolicy |
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. |
| PatchSettings |
Specifies settings related to VM Guest Patching on Windows. |
| Plan |
Plan for the resource. |
| PriorityProfile |
The priority profile for flex VM creation |
| 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. |
| ReimagePayload |
Reimage payload with common profile and per-resource overrides |
| ReimageResourceOperationResponse |
The response from a reimage request |
| ReimageResourceOverride |
Per-resource override entry for reimage requests |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceAttachRequest |
Resources to attach to a scheduled action. |
| ResourceDetachRequest |
Resources to remove from a scheduled action. |
| ResourceNotificationDetails |
Resource notification details containing notification metadata like the resource context |
| ResourceOperation |
High 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 |
| ResourceOperationResponse |
Results of a scheduled action operation for targeted resources. |
| ResourcePatchRequest |
Resource-specific settings to update in a scheduled action. |
| ResourceProvisionPayload |
Resource creation data model |
| ResourceProvisionVdiPayload |
Resource creation data model with Flex properties for VDI scenarios |
| ResourceResultSummary |
Summary of operation results across targeted resources. |
| ResourceStatus |
Current status for a targeted resource in a scheduled action occurrence. |
| ResourceWithContext |
The resources needed for the user request with the resourceContext |
| Resources |
The resources needed for the user request |
| ResourcesWithContext |
The resources needed for the user request with the context for tracking purposes |
| RestorePollerOptions | |
| RetryPolicy |
The retry policy for the user request |
| ScheduledAction |
A recurring action that operates on specified compute resources. |
| ScheduledActionExtensionListByVmsOptionalParams |
Optional parameters. |
| ScheduledActionExtensionOperations |
Interface representing a ScheduledActionExtension operations. |
| ScheduledActionOperationStatusGetOptionalParams |
Optional parameters. |
| ScheduledActionOperationStatusOperations |
Interface representing a ScheduledActionOperationStatus operations. |
| ScheduledActionProperties |
Configuration and status of a scheduled action. |
| ScheduledActionResource |
A compute resource associated with a scheduled action. |
| ScheduledActionResourceInput |
A compute resource to add to or update in a scheduled action. |
| ScheduledActionResources |
A scheduled action associated with a specific compute resource. |
| ScheduledActionUpdate |
The type used for update operations of the ScheduledAction. |
| ScheduledActionUpdateProperties |
The updatable properties of the ScheduledAction. |
| ScheduledActionsAttachResourcesOptionalParams |
Optional parameters. |
| ScheduledActionsCancelNextOccurrenceOptionalParams |
Optional parameters. |
| ScheduledActionsCreateOrUpdateOptionalParams |
Optional parameters. |
| ScheduledActionsDeleteOptionalParams |
Optional parameters. |
| ScheduledActionsDetachResourcesOptionalParams |
Optional parameters. |
| ScheduledActionsDisableOptionalParams |
Optional parameters. |
| ScheduledActionsEnableOptionalParams |
Optional parameters. |
| ScheduledActionsExecutionParameters |
Settings that control how the scheduled action operation is executed. |
| ScheduledActionsExtensionProperties |
A scheduled action associated with a specific compute resource. |
| ScheduledActionsGetOptionalParams |
Optional parameters. |
| ScheduledActionsListByResourceGroupOptionalParams |
Optional parameters. |
| ScheduledActionsListBySubscriptionOptionalParams |
Optional parameters. |
| ScheduledActionsListResourcesOptionalParams |
Optional parameters. |
| ScheduledActionsOperations |
Interface representing a ScheduledActions operations. |
| ScheduledActionsPatchResourcesOptionalParams |
Optional parameters. |
| ScheduledActionsRetryPolicy |
Retry settings for a scheduled action operation. |
| ScheduledActionsSchedule |
The recurring schedule for a scheduled action. |
| ScheduledActionsScheduleUpdate |
Schedule changes for a scheduled action. Omitted properties keep their current values. |
| ScheduledActionsTriggerManualOccurrenceOptionalParams |
Optional parameters. |
| ScheduledActionsUpdateOptionalParams |
Optional parameters. |
| 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. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. |
| UserAssignedIdentitiesValue |
model interface UserAssignedIdentitiesValue |
| 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 |
A virtual machine launched by a LaunchBulkInstancesOperation. |
| VirtualMachineBulkOperationsBulkAcknowledgeOperationErrorsOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkCancelOperationsOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkCreateOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkDeallocateOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkDeleteOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkGetOperationsStatusOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkHibernateOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkListOperationErrorsOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkReimageOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkStartOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsBulkVdiFlexCreateOperationOptionalParams |
Optional parameters. |
| VirtualMachineBulkOperationsOperations |
Interface representing a VirtualMachineBulkOperations operations. |
| 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. |
| 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. |
| 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. |
| VirtualMachineReimageParameters |
Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged |
| VmSizeProfile |
A VM size profile with a name and rank for flex VM creation |
| VmSizeProperties |
Specifies VM Size Property settings on the virtual machine. |
| 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 |
The zone allocation policy for distributing VMs across availability zones |
| ZonePreference |
A zone preference with a zone identifier and rank |
Type Aliases
| AcceleratorManufacturer |
Accelerator manufacturers supported by Azure VMs. Known values supported by the serviceAMD: AMD GpuType |
| AcceleratorType |
Accelerator types supported by Azure VMs. Known values supported by the serviceGPU: GPU Accelerator |
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AllocationStrategy |
The allocation strategy for VM size selection Known values supported by the serviceLowestPrice: Platform prioritizes VM sizes with the lowest hourly cost |
| ArchitectureType |
Architecture types supported by Azure VMs. Known values supported by the serviceARM64: ARM64 Architecture |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| BulkCreateCustomAllocationStrategy |
The allocation strategy for VM size selection in BulkCreateCustom. Known values supported by the serviceLowestPrice: Platform prioritizes VM sizes with the lowest hourly cost |
| BulkCreateCustomDistributionStrategy |
The distribution strategy for zone allocation in BulkCreateCustom. Known values supported by the serviceBestEffortSingleZone: Platform attempts to place as many VMs as possible in a single zone, falls back to multiple zones if needed |
| CachingTypes |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage Known values supported by the serviceNone: Caching type:None |
| CapacityRecommendationStatus |
The lifecycle status of the capacity recommendation for an operation Known values supported by the serviceNotInitiated: The capacity recommendation has not been initiated |
| CapacityType |
Capacity types for LaunchBulkInstancesOperation. Known values supported by the serviceVM: Default. VM is the default capacity type for LaunchBulkInstancesOperation where capacity is provisioned in terms of VMs. |
| ContinuablePage |
An interface that describes a page of results. |
| CpuManufacturer |
Cpu Manufacturers supported by Azure VMs. Known values supported by the serviceIntel: Intel CPU. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DeadlineType |
The types of deadlines supported by Bulkactions Known values supported by the serviceUnknown: Default value of Unknown. |
| DeleteOptions |
Specify what happens to the network interface when the VM is deleted Known values supported by the serviceDelete: Delete network interface when the VM is deleted |
| DiffDiskOptions |
Specifies the ephemeral disk option for operating system disk. Known values supported by the serviceLocal: 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. Known values supported by the serviceCacheDisk: CacheDisk 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. Known values supported by the serviceSCSI: SCSI 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. Known values supported by the serviceFromImage: Create disk FromImage |
| 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. Known values supported by the serviceDelete: Delete 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'. Known values supported by the serviceForceDetach: ForceDetach the disk |
| DistributionStrategy |
The distribution strategy for zone allocation Known values supported by the serviceBestEffortSingleZone: Platform attempts to place as many VMs as possible in a single zone, falls back to multiple zones if needed |
| 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 Known values supported by the serviceTenantReuse: TenantReuse scope type |
| EvictionPolicy |
Different kind of eviction policies Known values supported by the serviceDelete: When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this. |
| HyperVGeneration |
HyperVGenerations supported by Azure VMs. Known values supported by the serviceGen1: Gen1 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'. Known values supported by the serviceIPv4: IPv4 version |
| Language |
The language used for scheduled action notifications. Known values supported by the serviceen-us: English (United States). |
| LinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Known values supported by the serviceImageDefault: ImageDefault mode |
| LinuxVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values supported by the serviceUnknown: Unknown reboot setting |
| 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. Known values supported by the serviceImageDefault: ImageDefault linux VM guest patch mode |
| LocalStorageDiskType |
Local storage disk types supported by Azure VMs. Known values supported by the serviceHDD: HDD DiskType. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No 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. Known values supported by the serviceAudit: Audit 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. Known values supported by the serviceAudit: Audit mode |
| Month |
A month in which the scheduled action can run. Known values supported by the serviceJanuary: The scheduled action can run in January. |
| NetworkApiVersion |
Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations Known values supported by the service2020-11-01: 2020-11-01 version |
| NetworkInterfaceAuxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Known values supported by the serviceNone: None mode |
| NetworkInterfaceAuxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Known values supported by the serviceNone: None: None sku |
| NotificationType |
The delivery method for scheduled action notifications. Known values supported by the serviceEmail: Sends notifications by email. |
| OccurrenceResourceProvisioningState |
The provisioning state of a scheduled-action resource within an occurrence. Known values supported by the serviceSucceeded: Resource has been created. |
| OccurrenceState |
The current state of a scheduled action occurrence. Known values supported by the serviceCreated: The occurrence has been created. |
| OperatingSystemTypes |
This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux. Known values supported by the serviceWindows: Windows OS |
| OperationState |
Values that define the states of operations in Bulkactions Known values supported by the serviceUnknown: The default value for the operation state enum |
| OptimizationPreference |
The preferred optimization goal for scheduled action operations. Known values supported by the serviceCost: Prioritizes cost savings. |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| OsType |
The supported operating system types for flex VM creation Known values supported by the serviceWindows: Windows operating system |
| PartialFulfillmentMode |
Whether the service may launch fewer instances than requested when the full capacity cannot be satisfied. Known values supported by the serviceEnabled: Partial fulfillment is allowed. |
| PartialFulfillmentReason |
The reason the requested capacity could only be partially fulfilled. Known values supported by the serviceInsufficientCapacity: The requested capacity could not be fully satisfied due to insufficient capacity in the region. |
| PriorityType |
The priority type for VM allocation Known values supported by the serviceRegular: Regular priority VMs |
| ProtocolTypes |
Specifies the protocol of WinRM listener. Possible values are: http, https. Known values supported by the serviceHttp: Http protocol |
| ProvisioningState |
The status of the LaunchBulkInstancesOperation. Known values supported by the serviceCreating: Initial creation in progress. |
| PublicIPAddressSkuName |
Specify public IP sku name Known values supported by the serviceBasic: Basic IP sku name |
| PublicIPAddressSkuTier |
Specify public IP sku tier Known values supported by the serviceRegional: Regional IP address sku tier |
| PublicIPAllocationMethod |
Specify the public IP allocation type Known values supported by the serviceDynamic: Dynamic IP allocation |
| ResourceIdentityType |
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. |
| ResourceOperationStatus |
Current status of an operation for the specific occurrence and resource Known values supported by the serviceSucceeded: The operation completed successfully for the resource. |
| ResourceOperationType |
The kind of bulk operation that can be performed on resources using Bulkactions API Known values supported by the serviceUnknown: The default value for this enum type |
| ResourceType |
The type of compute resource targeted by the scheduled action. Known values supported by the serviceVirtualMachine: Azure virtual machines. |
| ScheduledActionType |
The operation performed by the scheduled action. Known values supported by the serviceStart: Starts the targeted resources. |
| ScheduledActionsDeadlineType |
How the scheduled time is interpreted for the resource operation. Known values supported by the serviceUnknown: The deadline type is not specified. |
| ScheduledActionsProvisioningState |
The provisioning state of the scheduled action. Known values supported by the serviceSucceeded: Resource has been created. |
| ScheduledActionsResourceOperationType |
The operation to retry when a scheduled action fails. Known values supported by the serviceUnknown: The operation is not specified. |
| 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. Known values supported by the serviceVMGuestStateOnly: VMGuestStateOnly 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. Known values supported by the serviceTrustedLaunch: TrustedLaunch security type |
| SettingNames |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Known values supported by the serviceAutoLogon: AutoLogon 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 Known values supported by the serviceStandard_LRS: Standard_LRS storage account type |
| VMAttributeSupport |
VMSizes supported by Azure VMs. Included is a union of Excluded and Required. Known values supported by the serviceExcluded: All VMSizes having the feature support will be excluded. |
| VMCategory |
VMCategories defined for Azure VMs. Known values supported by the serviceGeneralPurpose: 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. |
| VMOperationStatus |
Virtual Machine operation status values. Known values supported by the serviceCreating: Indicates that the virtual machine is either in the process of being created or is scheduled to be created. |
| WeekDay |
A day of the week on which the scheduled action can run. Known values supported by the serviceMonday: The scheduled action can run on Monday. |
| WindowsPatchAssessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Known values supported by the serviceImageDefault: ImageDefault patch assessment mode |
| WindowsVMGuestPatchAutomaticByPlatformRebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Known values supported by the serviceUnknown: Reboot setting for Unknown |
| 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. Known values supported by the serviceManual: Manual VM guest patch mode |
Enums
| 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 |
The allocation strategy for VM size selection |
| KnownArchitectureType |
Architecture types supported by Azure VMs. |
| KnownBulkCreateCustomAllocationStrategy |
The allocation strategy for VM size selection in BulkCreateCustom. |
| KnownBulkCreateCustomDistributionStrategy |
The distribution strategy for zone allocation in BulkCreateCustom. |
| KnownCachingTypes |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage |
| KnownCapacityRecommendationStatus |
The lifecycle status of the capacity recommendation for an operation |
| 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'. |
| KnownDistributionStrategy |
The distribution strategy for zone allocation |
| 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'. |
| KnownLanguage |
The language used for scheduled action notifications. |
| KnownLinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. |
| 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. |
| 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. |
| KnownMonth |
A month in which the scheduled action can run. |
| KnownNetworkApiVersion |
Specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations |
| 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. |
| KnownNotificationType |
The delivery method for scheduled action notifications. |
| KnownOccurrenceResourceProvisioningState |
The provisioning state of a scheduled-action resource within an occurrence. |
| KnownOccurrenceState |
The current state of a scheduled action occurrence. |
| 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 preferred optimization goal for scheduled action operations. |
| KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
| KnownOsType |
The supported operating system types for flex VM creation |
| KnownPartialFulfillmentMode |
Whether the service may launch fewer instances than requested when the full capacity cannot be satisfied. |
| KnownPartialFulfillmentReason |
The reason the requested capacity could only be partially fulfilled. |
| KnownPriorityType |
The priority type for VM allocation |
| 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 |
| KnownResourceOperationStatus |
Current status of an operation for the specific occurrence and resource |
| KnownResourceOperationType |
The kind of bulk operation that can be performed on resources using Bulkactions API |
| KnownResourceType |
The type of compute resource targeted by the scheduled action. |
| KnownScheduledActionType |
The operation performed by the scheduled action. |
| KnownScheduledActionsDeadlineType |
How the scheduled time is interpreted for the resource operation. |
| KnownScheduledActionsProvisioningState |
The provisioning state of the scheduled action. |
| KnownScheduledActionsResourceOperationType |
The operation to retry when a scheduled action fails. |
| 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. |
| KnownVMOperationStatus |
Virtual Machine operation status values. |
| KnownVersions |
ComputeSchedule API versions |
| KnownWeekDay |
A day of the week on which the scheduled action can run. |
| KnownWindowsPatchAssessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
| 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. |
Functions
| is |
Typeguard for RestError |
| restore |
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. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(ComputeClient, 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 restorePoller<TResponse, TResult>(client: ComputeClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- ComputeClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor