Azure.Provisioning.Compute Namespace

Classes

Name Description
AdditionalCapabilities

Enables or disables a capability on the virtual machine or virtual machine scale set.

AdditionalReplicaSet

Describes the additional replica set information.

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.

AutomaticOSUpgradePolicy

The configuration parameters used for performing automatic OS upgrade.

AutomaticRepairsPolicy

Specifies the configuration parameters for automatic repairs on the virtual machine scale set.

AutomaticZoneRebalancingPolicy

The configuration parameters used while performing automatic AZ balancing.

AvailabilitySet

AvailabilitySet.

AvailabilitySet.ResourceVersions

Supported AvailabilitySet resource versions.

AvailablePatchSummary

Describes the properties of an virtual machine instance view for available patch summary.

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.

BootDiagnosticsInstanceView

The instance view of a virtual machine boot diagnostics.

CapacityReservation

CapacityReservation.

CapacityReservation.ResourceVersions

Supported CapacityReservation resource versions.

CapacityReservationGroup

CapacityReservationGroup.

CapacityReservationGroup.ResourceVersions

Supported CapacityReservationGroup resource versions.

CapacityReservationGroupInstanceView

The CapacityReservationGroupInstanceView.

CapacityReservationInstanceView

The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.

CapacityReservationInstanceViewWithName

The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.

CapacityReservationUtilization

Represents the capacity reservation utilization in terms of resources allocated.

CommunityGalleryInfo

Information of community gallery if current gallery is shared to community.

ComputeApiError

Api error.

ComputeApiErrorBase

Api error base.

ComputeGallery

ComputeGallery.

ComputeGallery.ResourceVersions

Supported ComputeGallery resource versions.

ComputeGalleryPlatformAttribute

This is the platform attribute of the image version.

ComputePlan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

ComputePrivateEndpointConnection

ComputePrivateEndpointConnection.

ComputePrivateEndpointConnection.ResourceVersions

Supported ComputePrivateEndpointConnection resource versions.

ComputePrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ComputePublicIPAddressSku

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

ComputeScheduledEventsProfile

The ComputeScheduledEventsProfile.

ComputeSecurityPostureReference

Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01.

ComputeSku

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

ComputeSkuProfile

Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy.

ComputeSkuProfileVmSize

Specifies the VM Size.

ComputeSnapshot

ComputeSnapshot.

ComputeSnapshot.ResourceVersions

Supported ComputeSnapshot resource versions.

ComputeSubResourceDataWithColocationStatus

The ComputeSubResourceDataWithColocationStatus.

CopyCompletionError

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

DataDiskImageEncryption

Contains encryption settings for a data disk image.

DedicatedHost

DedicatedHost.

DedicatedHost.ResourceVersions

Supported DedicatedHost resource versions.

DedicatedHostAllocatableVm

Represents the dedicated host unutilized capacity in terms of a specific VM size.

DedicatedHostGroup

DedicatedHostGroup.

DedicatedHostGroup.ResourceVersions

Supported DedicatedHostGroup resource versions.

DedicatedHostInstanceView

The instance view of a dedicated host.

DedicatedHostInstanceViewWithName

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

DefaultVirtualMachineScaleSetInfo

Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.

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.

DiskAccess

DiskAccess.

DiskAccess.ResourceVersions

Supported DiskAccess resource versions.

DiskCreationData

Data used when creating a disk.

DiskEncryption

Encryption at rest settings for disk or snapshot.

DiskEncryptionSet

DiskEncryptionSet.

DiskEncryptionSet.ResourceVersions

Supported DiskEncryptionSet resource versions.

DiskEncryptionSettings

Describes a Encryption Settings for a Disk.

DiskImage

DiskImage.

DiskImage.ResourceVersions

Supported DiskImage resource versions.

DiskInstanceView

The instance view of the disk.

DiskPurchasePlan

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

DiskRestorePointAttributes

Disk Restore Point details.

DiskRestorePointInstanceView

The instance view of a disk restore point.

DiskRestorePointReplicationStatus

The instance view of a disk restore point.

DiskSecurityProfile

Contains the security related information for the resource.

DiskSku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

EncryptionImages

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

EncryptionSettingsElement

Encryption settings for one disk volume.

EncryptionSettingsGroup

Encryption settings for disk or snapshot.

EventGridAndResourceGraph

Specifies eventGridAndResourceGraph related Scheduled Event related configurations.

GalleryApplication

GalleryApplication.

GalleryApplication.ResourceVersions

Supported GalleryApplication resource versions.

GalleryApplicationCustomAction

A custom action that can be performed with a Gallery Application Version.

GalleryApplicationCustomActionParameter

The definition of a parameter that can be passed to a custom action of a Gallery Application Version.

GalleryApplicationVersion

GalleryApplicationVersion.

GalleryApplicationVersion.ResourceVersions

Supported GalleryApplicationVersion resource versions.

GalleryApplicationVersionPublishingProfile

The publishing profile of a gallery image version.

GalleryArtifactVersionFullSource

The source of the gallery artifact version.

GalleryArtifactVersionSource

The gallery artifact version source.

GalleryDataDiskImage

This is the data disk image.

GalleryDiskImageSource

The source for the disk image.

GalleryExtendedLocation

The name of the extended location.

GalleryImage

GalleryImage.

GalleryImage.ResourceVersions

Supported GalleryImage resource versions.

GalleryImageExecutedValidation

This is the executed Validation.

GalleryImageFeature

A feature for gallery image.

GalleryImageIdentifier

This is the gallery image definition identifier.

GalleryImageValidationsProfile

This is the validations profile of a Gallery Image Version.

GalleryImageVersion

GalleryImageVersion.

GalleryImageVersion.ResourceVersions

Supported GalleryImageVersion resource versions.

GalleryImageVersionPolicyViolation

A policy violation reported against a gallery artifact.

GalleryImageVersionPublishingProfile

The publishing profile of a gallery image Version.

GalleryImageVersionSafetyProfile

This is the safety profile of the Gallery Image Version.

GalleryImageVersionStorageProfile

This is the storage profile of a Gallery Image Version.

GalleryImageVersionUefiSettings

Contains UEFI settings for the image version.

GalleryInVmAccessControlProfile

GalleryInVmAccessControlProfile.

GalleryInVmAccessControlProfile.ResourceVersions

Supported GalleryInVmAccessControlProfile resource versions.

GalleryInVmAccessControlProfileProperties

Describes the properties of a gallery inVMAccessControlProfile.

GalleryInVmAccessControlProfileVersion

GalleryInVmAccessControlProfileVersion.

GalleryInVmAccessControlProfileVersion.ResourceVersions

Supported GalleryInVmAccessControlProfileVersion resource versions.

GalleryInVmAccessControlRules

This is the Access Control Rules specification for an inVMAccessControlProfile version.

GalleryInVmAccessControlRulesIdentity

The properties of an Access Control Rule Identity.

GalleryInVmAccessControlRulesPrivilege

The properties of an Access Control Rule Privilege.

GalleryInVmAccessControlRulesRole

The properties of an Access Control Rule Role.

GalleryInVmAccessControlRulesRoleAssignment

The properties of an Access Control Rule RoleAssignment.

GalleryOSDiskImage

This is the OS disk image.

GalleryScript

GalleryScript.

GalleryScript.ResourceVersions

Supported GalleryScript resource versions.

GalleryScriptParameter

The definition of a parameter that can be passed to a script of a Gallery Script Version.

GalleryScriptProperties

Describes the properties of a gallery script definition.

GalleryScriptVersion

GalleryScriptVersion.

GalleryScriptVersion.ResourceVersions

Supported GalleryScriptVersion resource versions.

GalleryScriptVersionProperties

Describes the properties of a gallery script version.

GalleryScriptVersionPublishingProfile

The publishing profile of a gallery image version.

GalleryTargetExtendedLocation

The GalleryTargetExtendedLocation.

HostEndpointSettings

Specifies particular host endpoint settings.

ImageDataDisk

Describes a data disk.

ImageDiskReference

The source image used for creating the disk.

ImageOSDisk

Describes an Operating System disk.

ImagePurchasePlan

Describes the gallery image definition purchase plan. This is used by marketplace images.

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.

ImageStorageProfile

Describes a storage profile.

InnerError

Inner error details.

InstanceViewStatus

Instance view status.

KeyForDiskEncryptionSet

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots.

KeyVaultAndKeyReference

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey.

KeyVaultAndSecretReference

Key Vault Secret Url and vault id of the encryption key.

KeyVaultKeyReference

Describes a reference to Key Vault Key.

KeyVaultSecretReference

Describes a reference to Key Vault Secret.

LastPatchInstallationSummary

Describes the properties of the last installed patch summary.

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.

LoadBalancerFrontendIPConfiguration

Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.

MaintenanceRedeployStatus

Maintenance Operation Status.

ManagedDisk

ManagedDisk.

ManagedDisk.ResourceVersions

Supported ManagedDisk resource versions.

MaxInstancePercentPerZonePolicy

The configuration parameters used to limit the number of virtual machines per availability zone in the virtual machine scale set.

OSDiskImageEncryption

Contains encryption settings for an OS disk image.

OSDiskImageSecurityProfile

Contains security profile for an OS disk image.

OSImageNotificationProfile

The OSImageNotificationProfile.

PatchSettings

Specifies settings related to VM Guest Patching on Windows.

ProximityPlacementGroup

ProximityPlacementGroup.

ProximityPlacementGroup.ResourceVersions

Supported ProximityPlacementGroup resource versions.

ProxyAgentSettings

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

RecommendedMachineConfiguration

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

RegionalReplicationStatus

This is the regional replication status.

RegionalSharingStatus

Gallery regional sharing status.

ReplicationStatus

This is the replication status of the gallery image version.

ResiliencyPolicy

Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy and/or ResilientVMDeletionPolicy.

ResourceRange

Describes the resource range.

RestorePoint

RestorePoint.

RestorePoint.ResourceVersions

Supported RestorePoint resource versions.

RestorePointEncryption

Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.

RestorePointGroup

RestorePointGroup.

RestorePointGroup.ResourceVersions

Supported RestorePointGroup resource versions.

RestorePointGroupSource

The properties of the source resource that this restore point collection is created from.

RestorePointInstanceView

The instance view of a restore point.

RestorePointSourceMetadata

Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.

RestorePointSourceVmDataDisk

Describes a data disk.

RestorePointSourceVmOSDisk

Describes an Operating System disk.

RestorePointSourceVmStorageProfile

Describes the storage profile.

RollingUpgradePolicy

The configuration parameters used while performing a rolling upgrade.

RunCommandInputParameter

Describes the properties of a run command parameter.

RunCommandManagedIdentity

Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

ScaleInPolicy

Describes a scale-in policy for a virtual machine scale set.

ScheduledEventsPolicy

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.

ScheduleProfile

Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.

ScriptSource

The source script from which the Script Version is going to be created.

SecurityProfile

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

ShareInfoElement

The ShareInfoElement.

SharingProfile

Profile for gallery sharing to subscription or tenant.

SharingProfileGroup

Group of the gallery sharing profile.

SharingStatus

Sharing status of current gallery.

SnapshotSku

The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot.

SpotRestorePolicy

Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint.

SshPublicKey

SshPublicKey.

SshPublicKey.ResourceVersions

Supported SshPublicKey resource versions.

SshPublicKeyConfiguration

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

SupportedCapabilities

List of supported capabilities persisted on the disk resource for VM use.

TargetRegion

Describes the target region information.

TerminateNotificationProfile

The TerminateNotificationProfile.

UefiKey

A UEFI key signature.

UefiKeySignatures

Additional UEFI key signatures that will be added to the image in addition to the signature templates.

UefiSettings

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

UserArtifactManagement

The UserArtifactManagement.

UserArtifactSettings

Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.

UserArtifactSource

The source image from which the Image Version is going to be created.

UserInitiatedRedeploy

Specifies Redeploy related Scheduled Event related configurations.

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.

VirtualMachine

VirtualMachine.

VirtualMachine.ResourceVersions

Supported VirtualMachine resource versions.

VirtualMachineAgentInstanceView

The instance view of the VM Agent running on the virtual machine.

VirtualMachineDataDisk

Describes a data disk.

VirtualMachineDiskSecurityProfile

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

VirtualMachineExtension

VirtualMachineExtension.

VirtualMachineExtension.ResourceVersions

Supported VirtualMachineExtension resource versions.

VirtualMachineExtensionHandlerInstanceView

The instance view of a virtual machine extension handler.

VirtualMachineExtensionInstanceView

The instance view of a virtual machine extension.

VirtualMachineGalleryApplication

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

VirtualMachineHardwareProfile

Specifies the hardware settings for the virtual machine.

VirtualMachineInstanceView

The instance view of a virtual machine.

VirtualMachineIPTag

Contains the IP tag associated with the public IP address.

VirtualMachineManagedDisk

The parameters of a managed disk.

VirtualMachineNetworkInterfaceConfiguration

Describes a virtual machine network interface configurations.

VirtualMachineNetworkInterfaceIPConfiguration

Describes a virtual machine network profile's IP configuration.

VirtualMachineNetworkInterfaceReference

Describes a network interface reference.

VirtualMachineNetworkProfile

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

VirtualMachineOSDisk

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.

VirtualMachineOSProfile

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

VirtualMachinePatchStatus

The status of virtual machine patch operations.

VirtualMachinePlacement

Describes the user-defined constraints for resource hardware placement.

VirtualMachinePublicIPAddressConfiguration

Describes a virtual machines IP Configuration's PublicIPAddress configuration.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

Describes a virtual machines network configuration's DNS settings.

VirtualMachineRunCommand

VirtualMachineRunCommand.

VirtualMachineRunCommand.ResourceVersions

Supported VirtualMachineRunCommand resource versions.

VirtualMachineRunCommandInstanceView

The instance view of a virtual machine run command.

VirtualMachineRunCommandScriptSource

Describes the script sources for run command. Use only one of these script sources: script, scriptUri, commandId, galleryScriptReferenceId.

VirtualMachineScaleSet

VirtualMachineScaleSet.

VirtualMachineScaleSet.ResourceVersions

Supported VirtualMachineScaleSet resource versions.

VirtualMachineScaleSetDataDisk

Describes a virtual machine scale set data disk.

VirtualMachineScaleSetExtension

VirtualMachineScaleSetExtension.

VirtualMachineScaleSetExtension.ResourceVersions

Supported VirtualMachineScaleSetExtension resource versions.

VirtualMachineScaleSetExtensionProfile

Describes a virtual machine scale set extension profile.

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile's IP configuration.

VirtualMachineScaleSetIPTag

Contains the IP tag associated with the public IP address.

VirtualMachineScaleSetManagedDisk

Describes the parameters of a ScaleSet managed disk.

VirtualMachineScaleSetMigrationInfo

Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set.

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile's network configurations.

VirtualMachineScaleSetNetworkProfile

Describes a virtual machine scale set network profile.

VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

VirtualMachineScaleSetOSProfile

Describes a virtual machine scale set OS profile.

VirtualMachineScaleSetPriorityMixPolicy

Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached.

VirtualMachineScaleSetProperties

Describes the properties of a Virtual Machine Scale Set.

VirtualMachineScaleSetPublicIPAddressConfiguration

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Describes a virtual machines scale sets network configuration's DNS settings.

VirtualMachineScaleSetStorageProfile

Describes a virtual machine scale set storage profile.

VirtualMachineScaleSetUpgradePolicy

Describes an upgrade policy - automatic, manual, or rolling.

VirtualMachineScaleSetVm

VirtualMachineScaleSetVm.

VirtualMachineScaleSetVm.ResourceVersions

Supported VirtualMachineScaleSetVm resource versions.

VirtualMachineScaleSetVmExtension

VirtualMachineScaleSetVmExtension.

VirtualMachineScaleSetVmExtension.ResourceVersions

Supported VirtualMachineScaleSetVmExtension resource versions.

VirtualMachineScaleSetVmInstanceView

The instance view of a virtual machine scale set VM.

VirtualMachineScaleSetVmProfile

Describes a virtual machine scale set virtual machine profile.

VirtualMachineScaleSetVmProperties

Describes the properties of a virtual machine scale set virtual machine.

VirtualMachineScaleSetVmProtectionPolicy

The protection policy of a virtual machine scale set VM.

VirtualMachineScaleSetVmRunCommand

VirtualMachineScaleSetVmRunCommand.

VirtualMachineScaleSetVmRunCommand.ResourceVersions

Supported VirtualMachineScaleSetVmRunCommand resource versions.

VirtualMachineSizeProperties

Specifies VM Size Property settings on the virtual machine.

VirtualMachineStorageProfile

Specifies the storage settings for the virtual machine disks.

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.

ZoneAllocationPolicy

The configuration parameters for zone allocation of a virtual machine scale set.

Enums

Name Description
AggregatedReplicationState

This is the aggregated replication status based on all the regional replication status flags.

ArchitectureType

Specifies the Architecture Type.

AvailabilityPolicyDiskDelay

Determines on how to handle disks with slow I/O.

CachingType

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

CapacityReservationType

Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.

ComponentName

The ComponentName.

ComputeAllocationStrategy

Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.

ComputeDeleteOption

Specify what happens to the network interface when the VM is deleted.

ComputeEncryptionType

The type of key used to encrypt the data of the disk.

ComputeGalleryEndpointAccess

This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'.

ComputeGalleryEndpointType

This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS'.

ComputeGalleryValidationStatus

This property specifies the status of the validationProfile of the image version.

ComputeNetworkInterfaceAuxiliaryMode

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.

ComputeNetworkInterfaceAuxiliarySku

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.

ComputePrivateEndpointConnectionProvisioningState

The current provisioning state.

ComputePrivateEndpointServiceConnectionStatus

The private endpoint connection status.

ComputePublicIPAddressSkuName

Specify public IP sku name.

ComputePublicIPAddressSkuTier

Specify public IP sku tier.

ComputeStatusLevelType

The level code.

ConfidentialVmEncryptionType

confidential VM encryption types.

ConsistencyModeType

ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.

CopyCompletionErrorReason

Indicates the error code if the background copy of a resource created via the CopyStart operation fails.

DataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot.

DedicatedHostLicenseType

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None..

DiffDiskOption

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.

DiskControllerType

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.

DiskCreateOption

This enumerates the possible sources of a disk's creation.

DiskCreateOptionType

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.

DiskDeleteOptionType

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.

DiskDetachOptionType

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

DiskEncryptionSetType

The type of key used to encrypt the data of the disk.

DiskPublicNetworkAccess

Policy for controlling export on the disk.

DiskSecurityType

Specifies the SecurityType of the VM. Applicable for OS disks only.

DiskState

This enumerates the possible state of the disk.

DiskStorageAccountType

The sku name.

DomainNameLabelScopeType

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.

EdgeZoneStorageAccountType

Specifies the storage account type to be used to store the image. This property is not updatable.

ExecutionState

Script execution status.

GalleryApplicationCustomActionParameterType

Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob.

GalleryApplicationScriptRebootBehavior

Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot.

GalleryExtendedLocationType

It is type of the extended location.

GalleryImageVersionPolicyViolationCategory

Describes the nature of the policy violation.

GalleryInVmAccessControlRulesMode

This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'.

GalleryProvisioningState

The provisioning state, which only appears in the response.

GalleryReplicationMode

Optional parameter which specifies the mode to be used for replication. This property is not updatable.

GalleryScriptParameterType

Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum.

GallerySharingPermissionType

This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community..

HighSpeedInterconnectPlacement

Specifies the high speed interconnect placement for the virtual machine scale set.

HostCaching

The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'.

HostEndpointSettingsMode

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.

HyperVGeneration

Specifies the HyperVGeneration Type.

ImageStorageAccountType

Specifies the storage account type to be used to store the image. This property is not updatable.

IPVersion

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

MaintenanceOperationResultCodeType

The Last Maintenance Operation Result Code.

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.

NetworkAccessPolicy

Policy for accessing the disk via network.

NetworkApiVersion

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations.

OperatingSystemStateType

This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.

OperatingSystemType

Gets the Operating System type.

OrchestrationMode

Specifies the orchestration mode for the virtual machine scale set.

PassName

The PassName.

PatchOperationStatus

The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings.".

ProvisionedBandwidthCopyOption

If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.

ProximityPlacementGroupType

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.

PublicIPAllocationMethod

Specify the public IP allocation type.

RegionalReplicationState

This is the regional replication state.

RepairAction

Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

ResilientVmDeletionStatus

Specifies the resilient VM deletion status for the virtual machine.

RestorePointEncryptionType

The type of key used to encrypt the data of the disk restore point.

ScriptShellType

Script shell types.

SecurityEncryptionType

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.

SecurityType

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.

SettingName

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

SharingProfileGroupType

This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants..

SharingState

The sharing state of the gallery, which only appears in the response.

SnapshotAccessState

The state of snapshot which determines the access availability of the snapshot.

SnapshotStorageAccountType

The sku name.

StorageAccountStrategy

Specifies the strategy to be used when selecting the storage account type. Cannot be specified along with storageAccountType, but can be overridden per region by specifying targetRegions[].storageAccountType. This property is not updatable.

StorageAccountType

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.

SupportedOperatingSystemType

The Operating System type.

SupportedSecurityOption

Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM.

UefiKeyType

The type of key signature.

UefiSignatureTemplateName

The name of the signature template that contains default UEFI keys.

VirtualMachineEvictionPolicyType

Specifies the eviction policy for the Azure Spot VM/VMSS.

VirtualMachinePriorityType

Specifies the priority for a standalone virtual machine or the virtual machines in the scale set. 'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.

VirtualMachineScaleSetScaleInRule

The VirtualMachineScaleSetScaleInRule.

VirtualMachineScaleSetUpgradeMode

Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> Automatic - All virtual machines in the scale set are automatically updated at the same time.

VirtualMachineSizeType

Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.

VmssRebalanceBehavior

Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete.

VmssRebalanceStrategy

Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate.

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.

WinRMListenerProtocolType

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

ZonalPlatformFaultDomainAlignMode

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.