Azure.ResourceManager.ComputeSchedule.Models Namespace

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.

A factory class for creating instances of the models for mocking.

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.

Describes the properties of a Virtual Machine for create.

Defines a virtual machine extension.

Specifies the configuration for a virtual machine operation.

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

This is the response from a cancel operations request.

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.

The flex properties for flexible VM creation.

The parameters of a managed disk.

The priority profile for flex VM creation.

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

The zone allocation policy for distributing VMs across availability zones.

A zone preference with a zone identifier and rank.

The response from a create request.

The response from a deallocate request.

The response from a delete request.

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 a Encryption Settings for a Disk.

Specifies eventGridAndResourceGraph related Scheduled Event related configurations.

The ExecuteCreateRequest request for create operations.

The ExecuteCreateFlexRequest request for executeCreateFlex operations.

The ExecuteDeallocateRequest request for executeDeallocate operations.

The ExecuteDeleteRequest for delete VM operation.

The ExecuteHibernateRequest request for executeHibernate operations.

The ExecuteStartRequest request for executeStart operations.

This is the request to get errors per vm operations.

This is the response from a get operations errors request.

This is the request to get operation status using operationids.

This is the response from a get operations status request.

The response from a Hibernate request.

Specifies particular host endpoint settings.

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Describes a reference to Key Vault Key.

Describes a reference to Key Vault Secret.

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.

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

The request to cancel an occurrence.

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

Represents an scheduled action resource metadata.

The scheduled action extension.

The summarized provisioning result of an occurrence.

This defines a list of operation errors associated with a unique operationId.

This is the first level of operation errors from the request when clients get errors per vm operation.

Profile for the OS Image Scheduled event.

Specifies settings related to VM Guest Patching on Windows.

Describes the user-defined constraints for resource hardware placement.

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

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

The details of a response from an operation on a resource.

These describe errors that occur at the resource level.

High level response from an operation on a resource.

Resource creation data model for flex VM provisioning.

Resource creation data model.

The status of the resources.

The response from a create flex request.

Extra details needed to run the user's request.

Describes the fallback operation that was performed.

The properties of the occurrence extension.

Properties for an occurrence.

The type used for update operations of the ScheduledAction.

The updatable properties of the ScheduledAction.

Scheduled action properties.

Request model to attach a list of scheduled action resources.

Request model to detach a list of scheduled action resources.

Represents an scheduled action resource metadata.

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

Request model perform a resource operation in a list of resources.

The scheduled action extension.

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

Scheduled action extension properties.

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

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.

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

The response from a start request.

The deallocate request for resources.

This is the request for hibernate.

This is the request for start.

Describes a reference to a sub-resource.

Profile properties for the Terminate Scheduled event.

Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

The resources needed for the user request.

The retry policy for the user request.

The schedule details for the user request.

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 a data disk.

Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.

Specifies the hardware profile for the 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 machine network profile's IP configuration.

Describes a virtual machine network interface IP configuration properties.

Describes a network interface reference.

Describes a network interface reference properties.

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

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.

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

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.

Specifies VM Size Property settings on the virtual machine.

Specifies the storage settings for the virtual machine disks.

Specifies the required information to reference a compute gallery application version.

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.

Describes Protocol and thumbprint of Windows Remote Management listener.

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

The allocation strategy for VM size selection.

The distribution strategy for zone allocation.

The supported operating system types for flex VM creation.

The priority type for VM allocation.

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.

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.

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

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.

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

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 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 notification languages currently supported.

The type of notification supported.

The provisioning state of a resource type.

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

Specify public IP sku name.

Specify public IP sku tier.

Specify the public IP allocation type.

The kind of operation types that can be performed on resources using ScheduledActions.

The types of deadlines supported by ScheduledActions.

The state the occurrence is at a given time.

Values that define the states of operations in Scheduled Actions.

The preferences customers can select to optimize their requests to ScheduledActions.

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

Provisioning state.

The type of resource being targeted.

Representation of the months available selection in a gregorian calendar.

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

Specify which action user wants to be performed on the resources.

Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.

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

Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types.

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.

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

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

Specifies the policy for resource's placement in availability zone. Possible values are: Any (used for Virtual Machines), Auto (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.