models Package
Classes
| AccessControlRules |
This is the Access Control Rules specification for an inVMAccessControlProfile version. |
| AccessControlRulesIdentity |
The properties of an Access Control Rule Identity. |
| AccessControlRulesPrivilege |
The properties of an Access Control Rule Privilege. |
| AccessControlRulesRole |
The properties of an Access Control Rule Role. |
| AccessControlRulesRoleAssignment |
The properties of an Access Control Rule RoleAssignment. |
| AccessUri |
A disk access SAS uri. |
| 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. |
| AlternativeOption |
Describes the alternative option specified by the Publisher for this image when this image is deprecated. |
| ApiEntityReference |
The API entity reference. |
| ApiError |
Api error. |
| ApiErrorBase |
Api error base. |
| ApplicationProfile |
Contains the list of gallery applications that should be made available to the VM/VMSS. |
| AttachDetachDataDisksRequest |
Specifies the input for attaching and detaching a list of managed data disks. |
| AutomaticOSUpgradePolicy |
The configuration parameters used for performing automatic OS upgrade. |
| AutomaticOSUpgradeProperties |
Describes automatic OS upgrade properties on the image. |
| AutomaticRepairsPolicy |
Specifies the configuration parameters for automatic repairs on the virtual machine scale set. |
| AutomaticZoneRebalancingPolicy |
The configuration parameters used while performing automatic AZ balancing. |
| AvailabilityPolicy |
In the case of an availability or connectivity issue with the data disk, specify the behavior of your VM. |
| AvailabilitySet |
Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set. |
| AvailabilitySetProperties |
The instance view of a resource. |
| AvailabilitySetUpdate |
Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated. |
| AvailablePatchSummary |
Describes the properties of an virtual machine instance view for available patch summary. |
| BillingProfile |
Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01. |
| 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 |
Specifies information about the capacity reservation. |
| CapacityReservationGroup |
Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group. |
| CapacityReservationGroupInstanceView |
CapacityReservationGroupInstanceView. |
| CapacityReservationGroupProperties |
capacity reservation group Properties. |
| CapacityReservationGroupUpdate |
Specifies information about the capacity reservation group. Only tags can be updated. |
| 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. |
| CapacityReservationProfile |
The parameters of a capacity reservation Profile. |
| CapacityReservationProperties |
Properties of the Capacity reservation. |
| CapacityReservationUpdate |
Specifies information about the capacity reservation. sku.capacity cannot be updated for Block Capacity Reservation. Tags can be update for all Capacity Reservation Types. |
| CapacityReservationUtilization |
Represents the capacity reservation utilization in terms of resources allocated. |
| CloudError |
An error response from the Compute service. |
| CommunityGallery |
Specifies information about the Community Gallery that you want to create or update. |
| CommunityGalleryIdentifier |
The identifier information of community gallery. |
| CommunityGalleryImage |
Specifies information about the gallery image definition that you want to create or update. |
| CommunityGalleryImageIdentifier |
This is the community gallery image definition identifier. |
| CommunityGalleryImageProperties |
Describes the properties of a gallery image definition. |
| CommunityGalleryImageVersion |
Specifies information about the gallery image version that you want to create or update. |
| CommunityGalleryImageVersionProperties |
Describes the properties of a gallery image version. |
| CommunityGalleryInfo |
Information of community gallery if current gallery is shared to community. |
| CommunityGalleryMetadata |
The metadata of community gallery. |
| CommunityGalleryProperties |
Describes the properties of a community gallery. |
| ConvertToVirtualMachineScaleSetInput |
Describes the Virtual Machine Scale Set to convert from Availability Set. |
| CopyCompletionError |
Indicates the error details if the background copy of a resource created via the CopyStart operation fails. |
| CreationData |
Data used when creating a disk. |
| DataDisk |
Describes a data disk. |
| DataDiskImage |
Contains the data disk images information. |
| DataDiskImageEncryption |
Contains encryption settings for a data disk image. |
| DataDisksToAttach |
Describes the data disk to be attached. |
| DataDisksToDetach |
Describes the data disk to be detached. |
| DedicatedHost |
Specifies information about the Dedicated host. |
| DedicatedHostAllocatableVM |
Represents the dedicated host unutilized capacity in terms of a specific VM size. |
| DedicatedHostAvailableCapacity |
Dedicated host unutilized capacity. |
| DedicatedHostGroup |
Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group. |
| DedicatedHostGroupInstanceView |
DedicatedHostGroupInstanceView. |
| DedicatedHostGroupProperties |
Dedicated Host Group Properties. |
| DedicatedHostGroupPropertiesAdditionalCapabilities |
Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. |
| DedicatedHostGroupUpdate |
Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated. |
| 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. |
| DedicatedHostProperties |
Properties of the dedicated host. |
| DedicatedHostUpdate |
Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated. |
| DefaultVirtualMachineScaleSetInfo |
Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. |
| DiagnosticsProfile |
Specifies the boot diagnostic settings state. Minimum 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. |
| Disallowed |
Describes the disallowed disk types. |
| DisallowedConfiguration |
Specifies the disallowed configuration for a virtual machine image. |
| Disk |
Disk resource. |
| DiskAccess |
disk access resource. |
| DiskAccessProperties |
DiskAccessProperties. |
| DiskAccessUpdate |
Used for updating a disk access resource. |
| DiskEncryptionSet |
disk encryption set resource. |
| DiskEncryptionSetParameters |
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. |
| DiskEncryptionSetUpdate |
disk encryption set update resource. |
| DiskEncryptionSetUpdateProperties |
disk encryption set resource update properties. |
| DiskEncryptionSettings |
Describes a Encryption Settings for a Disk. |
| DiskImageEncryption |
This is the disk image encryption base class. |
| DiskInstanceView |
The instance view of the disk. |
| DiskProperties |
Disk resource properties. |
| DiskPurchasePlan |
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. |
| DiskRestorePoint |
Properties of disk restore point. |
| DiskRestorePointAttributes |
Disk Restore Point details. |
| DiskRestorePointInstanceView |
The instance view of a disk restore point. |
| DiskRestorePointProperties |
Properties of an incremental 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. |
| DiskUpdate |
Disk update resource. |
| DiskUpdateProperties |
Disk resource update properties. |
| Encryption |
Encryption at rest settings for disk or snapshot. |
| EncryptionIdentity |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
| EncryptionImages |
Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. |
| EncryptionSetIdentity |
The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. |
| EncryptionSetProperties |
EncryptionSetProperties. |
| EncryptionSettingsCollection |
Encryption settings for disk or snapshot. |
| EncryptionSettingsElement |
Encryption settings for one disk volume. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Error response. |
| EventGridAndResourceGraph |
Specifies eventGridAndResourceGraph related Scheduled Event related configurations. |
| ExecutedValidation |
This is the executed Validation. |
| ExtendedLocation |
The complex type of the extended location. |
| ExternalHealthPolicy |
Specifies the external health policy for the virtual machine scale set. |
| Gallery |
Specifies information about the Shared Image Gallery that you want to create or update. |
| GalleryApplication |
Specifies information about the gallery Application Definition that you want to create or update. |
| 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. |
| GalleryApplicationProperties |
Describes the properties of a gallery Application Definition. |
| GalleryApplicationUpdate |
Specifies information about the gallery Application Definition that you want to update. |
| GalleryApplicationVersion |
Specifies information about the gallery Application Version that you want to create or update. |
| GalleryApplicationVersionProperties |
Describes the properties of a gallery image version. |
| GalleryApplicationVersionPublishingProfile |
The publishing profile of a gallery image version. |
| GalleryApplicationVersionSafetyProfile |
The safety profile of the Gallery Application Version. |
| GalleryApplicationVersionUpdate |
Specifies information about the gallery Application Version that you want to update. |
| GalleryArtifactPublishingProfileBase |
Describes the basic gallery artifact publishing profile. |
| GalleryArtifactSafetyProfileBase |
This is the safety profile of the Gallery Artifact Version. |
| GalleryArtifactVersionFullSource |
The source of the gallery artifact version. |
| GalleryArtifactVersionSource |
The gallery artifact version source. |
| GalleryDataDiskImage |
This is the data disk image. |
| GalleryDiskImage |
This is the disk image base class. |
| GalleryDiskImageSource |
The source for the disk image. |
| GalleryExtendedLocation |
The name of the extended location. |
| GalleryIdentifier |
Describes the gallery unique name. |
| GalleryIdentity |
Identity for the virtual machine. |
| GalleryImage |
Specifies information about the gallery image definition that you want to create or update. |
| GalleryImageFeature |
A feature for gallery image. |
| GalleryImageIdentifier |
This is the gallery image definition identifier. |
| GalleryImageProperties |
Describes the properties of a gallery image definition. |
| GalleryImageUpdate |
Specifies information about the gallery image definition that you want to update. |
| GalleryImageVersion |
Specifies information about the gallery image version that you want to create or update. |
| GalleryImageVersionProperties |
Describes the properties of a gallery image version. |
| 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. |
| GalleryImageVersionUpdate |
Specifies information about the gallery image version that you want to update. |
| GalleryInVMAccessControlProfile |
Specifies information about the gallery inVMAccessControlProfile that you want to create or update. |
| GalleryInVMAccessControlProfileProperties |
Describes the properties of a gallery inVMAccessControlProfile. |
| GalleryInVMAccessControlProfileUpdate |
Specifies information about the gallery inVMAccessControlProfile that you want to update. |
| GalleryInVMAccessControlProfileVersion |
Specifies information about the gallery inVMAccessControlProfile version that you want to create or update. |
| GalleryInVMAccessControlProfileVersionProperties |
Describes the properties of an inVMAccessControlProfile version. |
| GalleryInVMAccessControlProfileVersionUpdate |
Specifies information about the gallery inVMAccessControlProfile version that you want to update. |
| GalleryOSDiskImage |
This is the OS disk image. |
| GalleryProperties |
Describes the properties of a Shared Image Gallery. |
| GalleryResourceProfilePropertiesBase |
The properties of a gallery ResourceProfile. |
| GalleryResourceProfileVersionPropertiesBase |
The properties of a gallery ResourceProfile version. |
| GalleryScript |
Specifies information about the gallery Script Definition that you want to create or update. |
| 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. |
| GalleryScriptUpdate |
Specifies information about the gallery Script Definition that you want to update. |
| GalleryScriptVersion |
Concrete tracked resource types can be created by aliasing this type using a specific property type. |
| GalleryScriptVersionProperties |
Describes the properties of a gallery script version. |
| GalleryScriptVersionPublishingProfile |
The publishing profile of a gallery image version. |
| GalleryScriptVersionSafetyProfile |
The safety profile of the Gallery Script Version. |
| GalleryScriptVersionUpdate |
Specifies information about the gallery Script Version that you want to update. |
| GallerySoftDeletedResource |
The details information of soft-deleted resource. |
| GallerySoftDeletedResourceProperties |
Describes the properties of a soft-deleted resource. |
| GalleryTargetExtendedLocation |
GalleryTargetExtendedLocation. |
| GalleryUpdate |
Specifies information about the Shared Image Gallery that you want to update. |
| GenericGalleryParameter |
The definition of a generic gallery parameter. |
| GrantAccessData |
Data used for requesting a SAS. |
| HardwareProfile |
Specifies the hardware settings for the virtual machine. |
| HostEndpointSettings |
Specifies particular host endpoint settings. |
| Image |
The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. |
| ImageDataDisk |
Describes a data disk. |
| ImageDeprecationStatus |
Describes image deprecation status properties on the image. |
| ImageDisk |
Describes a image disk. |
| ImageDiskReference |
The source image used for creating the disk. |
| ImageOSDisk |
Describes an Operating System disk. |
| ImageProperties |
Describes the properties of an Image. |
| 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. |
| ImageUpdate |
The source user image virtual hard disk. Only tags may be updated. |
| ImageVersionSecurityProfile |
The security profile of a gallery image version. |
| 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. |
| LifecycleHook |
Describes a lifecycle hook. |
| LifecycleHooksProfile |
Specifies the lifecycle hooks profile for the virtual machine scale set. |
| LinuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
| LinuxParameters |
Input for InstallPatches on a Linux VM, as directly received by the API. |
| 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. |
| LogAnalyticsInputBase |
Api input base class for LogAnalytics Api. |
| LogAnalyticsOperationResult |
LogAnalytics operation status response. |
| LogAnalyticsOutput |
LogAnalytics output properties. |
| MaintenanceRedeployStatus |
Maintenance Operation Status. |
| ManagedDiskParameters |
The parameters of a managed disk. |
| MaxInstancePercentPerZonePolicy |
The configuration parameters used to limit the number of virtual machines per availability zone in the virtual machine scale set. |
| MigrateToVirtualMachineScaleSetInput |
Describes the Virtual Machine Scale Set to migrate from Availability Set. |
| MigrateVMToVirtualMachineScaleSetInput |
The input of virtual machine migration from Availability Set to Flexible Virtual Machine Scale Set. |
| 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. |
| 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. |
| OSDiskImage |
Contains the os disk image information. |
| OSDiskImageEncryption |
Contains encryption settings for an OS disk image. |
| OSDiskImageSecurityProfile |
Contains security profile for an OS disk image. |
| OSImageNotificationProfile |
OSImageNotificationProfile. |
| 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. |
| Operation |
REST API Operation. |
| OperationDisplay |
Localized display information for an operation. |
| OperationRecoverySettings |
The configuration parameters used for operation recovery settings on a virtual machine scale set. |
| OrchestrationServiceStateInput |
The input for OrchestrationServiceState. |
| OrchestrationServiceSummary |
Summary for an orchestration service of a virtual machine scale set. |
| PatchInstallationDetail |
Information about a specific patch that was encountered during an installation action. |
| PatchSettings |
Specifies settings related to VM Guest Patching on Windows. |
| PirCommunityGalleryResource |
Base information about the community gallery resource in azure compute gallery. |
| PirResource |
The Resource model definition. |
| PirSharedGalleryResource |
Base information about the shared gallery resource in pir. |
| Placement |
Describes the user-defined constraints for resource hardware placement. |
| Plan |
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. |
| PlatformAttribute |
This is the platform attribute of the image version. |
| PolicyViolation |
A policy violation reported against a gallery artifact. |
| PriorityMixPolicy |
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. |
| PrivateEndpoint |
The Private Endpoint resource. |
| PrivateEndpointConnection |
The Private Endpoint Connection resource. |
| PrivateEndpointConnectionProperties |
Properties of the PrivateEndpointConnectProperties. |
| PrivateLinkResource |
A private link resource. |
| PrivateLinkResourceListResult |
A list of private link resources. |
| PrivateLinkResourceProperties |
Properties of a private link resource. |
| PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
| PropertyUpdatesInProgress |
Properties of the disk for which update is pending. |
| ProximityPlacementGroup |
Specifies information about the proximity placement group. |
| ProximityPlacementGroupProperties |
Describes the properties of a Proximity Placement Group. |
| ProximityPlacementGroupPropertiesIntent |
Specifies the user intent of the proximity placement group. |
| ProximityPlacementGroupUpdate |
Specifies information about the proximity placement group. |
| ProxyAgentSettings |
Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. |
| ProxyResource |
Proxy Resource. |
| PublicIPAddressSku |
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. |
| PurchasePlan |
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. |
| RecommendedMachineConfiguration |
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. |
| RecoveryWalkResponse |
Response after calling a manual recovery walk. |
| RegionalReplicationStatus |
This is the regional replication status. |
| RegionalSharingStatus |
Gallery regional sharing status. |
| ReimageRecoveryPolicy |
The configuration parameters used while performing reimage recovery. |
| ReplicationStatus |
This is the replication status of the gallery image version. |
| RequestRateByIntervalInput |
Api request input for LogAnalytics getRequestRateByInterval Api. |
| ResiliencyPolicy |
Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy, ResilientVMDeletionPolicy and OperationRecoverySettings (version > 2025-11-01). |
| ResiliencyProfile |
Gets resiliency solutions enabled on the VM. This includes backup or disaster recovery solutions. |
| ResilientVMCreationPolicy |
The configuration parameters used while performing resilient VM creation. |
| ResilientVMDeletionPolicy |
The configuration parameters used while performing resilient VM deletion. |
| Resource |
Resource. |
| ResourceRange |
Describes the resource range. |
| ResourceSharingProfile |
ResourceSharingProfile. |
| ResourceSku |
Describes an available Compute SKU. |
| ResourceSkuCapabilities |
Describes The SKU capabilities object. |
| ResourceSkuCapacity |
Describes scaling information of a SKU. |
| ResourceSkuCosts |
Describes metadata for retrieving price info. |
| ResourceSkuLocationInfo |
Describes an available Compute SKU Location Information. |
| ResourceSkuRestrictionInfo |
Describes an available Compute SKU Restriction Information. |
| ResourceSkuRestrictions |
Describes scaling information of a SKU. |
| ResourceSkuZoneDetails |
Describes The zonal capabilities of a SKU. |
| RestartRecoveryPolicy |
The configuration parameters used while performing restart recovery. |
| RestorePoint |
Restore Point details. |
| RestorePointCollection |
Create or update Restore Point collection parameters. |
| RestorePointCollectionProperties |
The restore point collection properties. |
| RestorePointCollectionSourceProperties |
The properties of the source resource that this restore point collection is created from. |
| RestorePointCollectionUpdate |
Update Restore Point collection parameters. |
| 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. |
| RestorePointInstanceView |
The instance view of a restore point. |
| RestorePointProperties |
The restore point properties. |
| 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. |
| RetrieveBootDiagnosticsDataResult |
The SAS URIs of the console screenshot and serial log blobs. |
| RollbackStatusInfo |
Information about rollback on failed VM instances after a OS Upgrade operation. |
| RollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
| RollingUpgradeProgressInfo |
Information about the number of virtual machine instances in each upgrade state. |
| RollingUpgradeRunningStatus |
Information about the current running state of the overall upgrade. |
| RollingUpgradeStatusInfo |
The status of the latest virtual machine scale set rolling upgrade. |
| RollingUpgradeStatusInfoProperties |
The status of the latest virtual machine scale set rolling upgrade. |
| RunCommandDocument |
Describes the properties of a Run Command. |
| RunCommandDocumentBase |
Describes the properties of a Run Command metadata. |
| RunCommandInput |
Capture Virtual Machine parameters. |
| 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. |
| RunCommandParameterDefinition |
Describes the properties of a run command parameter. |
| RunCommandResult |
RunCommandResult. |
| ScaleInPolicy |
Describes a scale-in policy for a virtual machine scale set. |
| 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. |
| ScheduledEventsAdditionalPublishingTargets |
ScheduledEventsAdditionalPublishingTargets. |
| ScheduledEventsPolicy |
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. |
| ScheduledEventsProfile |
ScheduledEventsProfile. |
| ScriptSource |
The source script from which the Script Version is going to be created. |
| SecurityPostureReference |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01. |
| SecurityPostureReferenceUpdate |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01. |
| SecurityProfile |
Specifies the Security profile settings for the virtual machine or virtual machine scale set. |
| ServiceArtifactReference |
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01. |
| ShareInfoElement |
ShareInfoElement. |
| SharedGallery |
Specifies information about the Shared Gallery that you want to create or update. |
| SharedGalleryDataDiskImage |
This is the data disk image. |
| SharedGalleryDiskImage |
This is the disk image base class. |
| SharedGalleryIdentifier |
The identifier information of shared gallery. |
| SharedGalleryImage |
Specifies information about the gallery image definition that you want to create or update. |
| SharedGalleryImageProperties |
Describes the properties of a gallery image definition. |
| SharedGalleryImageVersion |
Specifies information about the gallery image version that you want to create or update. |
| SharedGalleryImageVersionProperties |
Describes the properties of a gallery image version. |
| SharedGalleryImageVersionStorageProfile |
This is the storage profile of a Gallery Image Version. |
| SharedGalleryOSDiskImage |
This is the OS disk image. |
| SharedGalleryProperties |
Specifies the properties of a shared gallery. |
| SharingProfile |
Profile for gallery sharing to subscription or tenant. |
| SharingProfileGroup |
Group of the gallery sharing profile. |
| SharingStatus |
Sharing status of current gallery. |
| SharingUpdate |
Specifies information about the gallery sharing profile update. |
| Sku |
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. |
| SkuProfile |
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. |
| SkuProfileVMSize |
Specifies the VM Size. |
| Snapshot |
Snapshot resource. |
| SnapshotProperties |
Snapshot resource properties. |
| 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. |
| SnapshotUpdate |
Snapshot update resource. |
| SnapshotUpdateProperties |
Snapshot resource update properties. |
| SoftDeletePolicy |
Contains information about the soft deletion policy of the gallery. |
| SourceVault |
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}. |
| 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. |
| SshConfiguration |
SSH configuration for Linux based VMs running on Azure. |
| SshGenerateKeyPairInputParameters |
Parameters for GenerateSshKeyPair. |
| SshPublicKey |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. |
| SshPublicKeyGenerateKeyPairResult |
Response from generation of an SSH key pair. |
| SshPublicKeyResource |
Specifies information about the SSH public key. |
| SshPublicKeyResourceProperties |
Properties of the SSH public key. |
| SshPublicKeyUpdateResource |
Specifies information about the SSH public key. |
| StartRecoveryPolicy |
The configuration parameters used while performing start recovery. |
| StorageProfile |
Specifies the storage settings for the virtual machine disks. |
| SubResource |
SubResource. |
| SubResourceReadOnly |
SubResourceReadOnly. |
| SubResourceWithColocationStatus |
SubResourceWithColocationStatus. |
| SupportedCapabilities |
List of supported capabilities persisted on the disk resource for VM use. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TargetRegion |
Describes the target region information. |
| TerminateNotificationProfile |
TerminateNotificationProfile. |
| ThrottledRequestsInput |
Api request input for LogAnalytics getThrottledRequests Api. |
| TrackedResource |
Tracked Resource. |
| 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. |
| UpdateResource |
The Update Resource model definition. |
| UpdateResourceDefinition |
The Update Resource model definition. |
| UpgradeOperationHistoricalStatusInfo |
Virtual Machine Scale Set OS Upgrade History operation response. |
| UpgradeOperationHistoricalStatusInfoProperties |
Describes each OS upgrade on the Virtual Machine Scale Set. |
| UpgradeOperationHistoryStatus |
Information about the current running state of the overall upgrade. |
| UpgradePolicy |
Describes an upgrade policy - automatic, manual, or rolling. |
| Usage |
Describes Compute Resource Usage. |
| UsageName |
The Usage Names. |
| UserArtifactManage |
UserArtifactManage. |
| 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. |
| UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue. |
| UserInitiatedReboot |
Specifies Reboot related Scheduled Event related configurations. |
| UserInitiatedRedeploy |
Specifies Redeploy related Scheduled Event related configurations. |
| 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. |
| VMScaleSetConvertToSinglePlacementGroupInput |
VMScaleSetConvertToSinglePlacementGroupInput. |
| VMScaleSetLifecycleHookEvent |
Defines a virtual machine scale set lifecycle hook event. |
| VMScaleSetLifecycleHookEventAdditionalContext |
Additional key-value pairs set on the lifecycle hook event that gives customer some useful context/data. The keys in this dictionary are specific to the lifecycle hook type. Different lifecycle hook events can have different sets of keys in the additional context depending on the lifecycle hook type. For example, for a lifecycle hook event with UpgradeAutoOSScheduling type, the additional context can contain the key "priority" that helps customer identify the priority of the Auto OS Upgrade operation triggered on the virtual machine scale set. |
| VMScaleSetLifecycleHookEventProperties |
Defines the virtual machine scale set lifecycle hook event properties. |
| VMScaleSetLifecycleHookEventTargetResource |
Define a single target ARM resource in a virtual machine scale set lifecycle hook event. Currently, this can be a virtual machine scale set resource or an individual virtual machine resource within a VMScaleSet. |
| VMScaleSetLifecycleHookEventUpdate |
Specifies information about the virtual machine scale set lifecycle hook event. |
| VMScaleSetScaleOutInput |
The input for ScaleOut. |
| VMScaleSetScaleOutInputProperties |
The input properties for ScaleOut. |
| VMSizeProperties |
Specifies VM Size Property settings on the virtual machine. |
| ValidationsProfile |
This is the validations profile of a Gallery Image 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 |
Describes a Virtual Machine. |
| VirtualMachineAgentInstanceView |
The instance view of the VM Agent running on the virtual machine. |
| VirtualMachineAssessPatchesResult |
Describes the properties of an AssessPatches result. |
| VirtualMachineCaptureParameters |
Capture Virtual Machine parameters. |
| VirtualMachineCaptureResult |
Output of virtual machine capture operation. |
| VirtualMachineExtension |
Describes a Virtual Machine Extension. |
| VirtualMachineExtensionHandlerInstanceView |
The instance view of a virtual machine extension handler. |
| VirtualMachineExtensionImage |
Describes a Virtual Machine Extension Image. |
| VirtualMachineExtensionImageProperties |
Describes the properties of a Virtual Machine Extension Image. |
| VirtualMachineExtensionInstanceView |
The instance view of a virtual machine extension. |
| VirtualMachineExtensionProperties |
Describes the properties of a Virtual Machine Extension. |
| VirtualMachineExtensionUpdate |
Describes a Virtual Machine Extension. |
| VirtualMachineExtensionUpdateProperties |
Describes the properties of a Virtual Machine Extension. |
| VirtualMachineExtensionsListResult |
The List Extension operation response. |
| VirtualMachineHealthStatus |
The health status of the VM. |
| VirtualMachineIdentity |
Identity for the virtual machine. |
| VirtualMachineImage |
Describes a Virtual Machine Image. |
| VirtualMachineImageFeature |
Specifies additional capabilities supported by the image. |
| VirtualMachineImageProperties |
Describes the properties of a Virtual Machine Image. |
| VirtualMachineImageResource |
Virtual machine image resource information. |
| VirtualMachineInstallPatchesParameters |
Input for InstallPatches as directly received by the API. |
| VirtualMachineInstallPatchesResult |
The result summary of an installation operation. |
| VirtualMachineInstanceView |
The instance view of 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. |
| VirtualMachinePatchStatus |
The status of virtual machine patch operations. |
| VirtualMachineProperties |
Describes the properties of a Virtual Machine. |
| 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. |
| VirtualMachineRunCommand |
Describes a Virtual Machine run command. |
| VirtualMachineRunCommandInstanceView |
The instance view of a virtual machine run command. |
| VirtualMachineRunCommandProperties |
Describes the properties 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. |
| VirtualMachineRunCommandUpdate |
Describes a Virtual Machine run command. |
| VirtualMachineScaleSet |
Describes a Virtual Machine Scale Set. |
| VirtualMachineScaleSetDataDisk |
Describes a virtual machine scale set data disk. |
| VirtualMachineScaleSetExtension |
Describes a Virtual Machine Scale Set Extension. |
| VirtualMachineScaleSetExtensionProfile |
Describes a virtual machine scale set extension profile. |
| VirtualMachineScaleSetExtensionProperties |
Describes the properties of a Virtual Machine Scale Set Extension. |
| VirtualMachineScaleSetExtensionUpdate |
Describes a Virtual Machine Scale Set Extension. |
| VirtualMachineScaleSetHardwareProfile |
Specifies the hardware settings for the virtual machine scale set. |
| VirtualMachineScaleSetIPConfiguration |
Describes a virtual machine scale set network profile's IP configuration. |
| VirtualMachineScaleSetIPConfigurationProperties |
Describes a virtual machine scale set network profile's IP configuration properties. |
| VirtualMachineScaleSetIdentity |
Identity for the virtual machine scale set. |
| VirtualMachineScaleSetInstanceView |
The instance view of a virtual machine scale set. |
| VirtualMachineScaleSetInstanceViewStatusesSummary |
Instance view statuses summary for virtual machines of a virtual machine scale set. |
| VirtualMachineScaleSetIpTag |
Contains the IP tag associated with the public IP address. |
| VirtualMachineScaleSetManagedDiskParameters |
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. |
| VirtualMachineScaleSetNetworkConfigurationDnsSettings |
Describes a virtual machines scale sets network configuration's DNS settings. |
| VirtualMachineScaleSetNetworkConfigurationProperties |
Describes a virtual machine scale set network profile's IP configuration. |
| 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. |
| 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. |
| VirtualMachineScaleSetPublicIPAddressConfigurationProperties |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration. |
| VirtualMachineScaleSetReimageParameters |
Describes a Virtual Machine Scale Set VM Reimage Parameters. |
| VirtualMachineScaleSetSku |
Describes an available virtual machine scale set sku. |
| VirtualMachineScaleSetSkuCapacity |
Describes scaling information of a sku. |
| VirtualMachineScaleSetStorageProfile |
Describes a virtual machine scale set storage profile. |
| VirtualMachineScaleSetUpdate |
Describes a Virtual Machine Scale Set. |
| VirtualMachineScaleSetUpdateIPConfiguration |
Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network. |
| VirtualMachineScaleSetUpdateIPConfigurationProperties |
Describes a virtual machine scale set network profile's IP configuration properties. |
| VirtualMachineScaleSetUpdateNetworkConfiguration |
Describes a virtual machine scale set network profile's network configurations. |
| VirtualMachineScaleSetUpdateNetworkConfigurationProperties |
Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. |
| VirtualMachineScaleSetUpdateNetworkProfile |
Describes a virtual machine scale set network profile. |
| VirtualMachineScaleSetUpdateOSDisk |
Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk. |
| VirtualMachineScaleSetUpdateOSProfile |
Describes a virtual machine scale set OS profile. |
| VirtualMachineScaleSetUpdateProperties |
Describes the properties of a Virtual Machine Scale Set. |
| VirtualMachineScaleSetUpdatePublicIPAddressConfiguration |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration. |
| VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration. |
| VirtualMachineScaleSetUpdateStorageProfile |
Describes a virtual machine scale set storage profile. |
| VirtualMachineScaleSetUpdateVMProfile |
Describes a virtual machine scale set virtual machine profile. |
| VirtualMachineScaleSetVM |
Describes a virtual machine scale set virtual machine. |
| VirtualMachineScaleSetVMExtension |
Describes a VMSS VM Extension. |
| VirtualMachineScaleSetVMExtensionUpdate |
Describes a VMSS VM Extension. |
| VirtualMachineScaleSetVMExtensionsListResult |
The List VMSS VM Extension operation response. |
| VirtualMachineScaleSetVMExtensionsSummary |
Extensions summary for virtual machines of a virtual machine scale set. |
| VirtualMachineScaleSetVMInstanceIDs |
Specifies a list of virtual machine instance IDs from the VM scale set. |
| VirtualMachineScaleSetVMInstanceRequiredIDs |
Specifies a list of virtual machine instance IDs from the VM scale set. |
| VirtualMachineScaleSetVMInstanceView |
The instance view of a virtual machine scale set VM. |
| VirtualMachineScaleSetVMNetworkProfileConfiguration |
Describes a virtual machine scale set VM network profile. |
| 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. |
| VirtualMachineScaleSetVMReimageParameters |
Describes a Virtual Machine Scale Set VM Reimage Parameters. |
| VirtualMachineSize |
Describes the properties of a VM size. |
| VirtualMachineSoftwarePatchProperties |
Describes the properties of a Virtual Machine software patch. |
| VirtualMachineStatusCodeCount |
The status code and count of the virtual machine scale set instance view status summary. |
| VirtualMachineUpdate |
Describes a Virtual Machine Update. |
| VmImagesInEdgeZoneListResult |
The List VmImages in EdgeZone operation response. |
| 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. |
| WindowsParameters |
Input for InstallPatches on a Windows VM, as directly received by the API. |
| WindowsVMGuestPatchAutomaticByPlatformSettings |
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. |
| ZoneAllocationPolicy |
The configuration parameters for zone allocation of a virtual machine scale set. |
| ZoneMovement |
Describes zone movement configuration. This allows VM to be moved across availability zones during an outage. |
Enums
| AccessControlRulesMode |
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'. |
| AccessLevel |
The Access Level, accepted values include None, Read, Write. |
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| AggregatedReplicationState |
This is the aggregated replication status based on all the regional replication status flags. |
| AllocationStrategy |
Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. |
| AlternativeType |
Describes the type of the alternative option. |
| Architecture |
CPU architecture supported by an OS disk. |
| ArchitectureTypes |
Specifies the Architecture Type. |
| AvailabilityPolicyDiskDelay |
Determines on how to handle disks with slow I/O. |
| CachingTypes |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
| CapacityReservationGroupInstanceViewTypes |
Type of CapacityReservationGroupInstanceViewTypes. |
| CapacityReservationInstanceViewTypes |
Type of CapacityReservationInstanceViewTypes. |
| ComponentNames |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
| ConfidentialVMEncryptionType |
confidential VM encryption types. |
| ConsistencyModeTypes |
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. |
| CreatedByType |
The kind of entity that created the resource. |
| DataAccessAuthMode |
Additional authentication requirements when exporting or uploading to a disk or snapshot. |
| DedicatedHostLicenseTypes |
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.. |
| DeleteOptions |
Specify what happens to the network interface when the VM is deleted. |
| DiffDiskOptions |
Specifies the ephemeral disk option for operating system disk. |
| DiffDiskPlacement |
Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for NvmeDisk: 2024-03-01. |
| DiskControllerTypes |
Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes. |
| DiskCreateOption |
This enumerates the possible sources of a disk's creation. |
| DiskCreateOptionTypes |
Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. |
| DiskDeleteOptionTypes |
Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01. |
| DiskDetachOptionTypes |
Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. |
| DiskEncryptionSetIdentityType |
The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. |
| DiskEncryptionSetType |
The type of key used to encrypt the data of the disk. |
| DiskSecurityTypes |
Specifies the SecurityType of the VM. Applicable for OS disks only. |
| DiskState |
This enumerates the possible state of the disk. |
| DiskStorageAccountTypes |
The sku name. |
| 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. |
| EdgeZoneStorageAccountType |
Specifies the storage account type to be used to store the image. This property is not updatable. |
| EncryptionType |
The type of key used to encrypt the data of the disk. |
| EndpointAccess |
This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. |
| EndpointTypes |
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'. |
| ExecutionState |
Script execution status. |
| ExpandTypeForListVMs |
Type of ExpandTypeForListVMs. |
| ExpandTypesForGetCapacityReservationGroups |
Type of ExpandTypesForGetCapacityReservationGroups. |
| ExpandTypesForGetVMScaleSets |
Type of ExpandTypesForGetVMScaleSets. |
| ExpandTypesForListVMs |
Type of ExpandTypesForListVMs. |
| ExtendedLocationType |
The type of the extended location. |
| ExtendedLocationTypes |
The type of extendedLocation. |
| FileFormat |
Used to specify the file format when making request for SAS on a VHDX file format snapshot. |
| 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. |
| GalleryExpandParams |
Type of GalleryExpandParams. |
| GalleryExtendedLocationType |
It is type of the extended location. |
| GalleryProvisioningState |
The provisioning state, which only appears in the response. |
| GalleryScriptParameterType |
Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum. |
| GallerySharingPermissionTypes |
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'. |
| HyperVGeneration |
The hypervisor generation of the Virtual Machine. |
| HyperVGenerationType |
Specifies the HyperVGeneration Type associated with a resource. |
| HyperVGenerationTypes |
Specifies the HyperVGeneration Type. |
| 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'. |
| IPVersions |
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'. |
| ImageState |
Describes the state of the image. |
| InstanceViewTypes |
Type of InstanceViewTypes. |
| IntervalInMins |
Interval value in minutes used to create LogAnalytics call rate logs. |
| LifecycleHookAction |
The action that will be applied to a target resource in the virtual machine scale set lifecycle hook event if the platform does not receive a response from the customer for the target resource before waitUntil. |
| LifecycleHookActionState |
Approval status of a target resource in a virtual machine scale set lifecycle hook event. |
| LinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. |
| 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. |
| MaintenanceOperationResultCodeTypes |
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. |
| 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. |
| 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. |
| NetworkInterfaceAuxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
| NetworkInterfaceAuxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
| OperatingSystemStateTypes |
The OS State. For managed images, use Generalized. |
| OperatingSystemType |
Gets the Operating System type. |
| OperatingSystemTypes |
This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.. |
| OrchestrationMode |
Specifies the orchestration mode for the virtual machine scale set. |
| OrchestrationServiceNames |
The name of the service. |
| OrchestrationServiceOperationStatus |
The latest operation status of the service. |
| OrchestrationServiceState |
The current state of the service. |
| OrchestrationServiceStateAction |
The action to be performed. |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system". |
| PassNames |
Type of PassNames. |
| PatchAssessmentState |
Describes the availability of a given patch. |
| PatchInstallationState |
The state of the patch after the installation operation completed. |
| 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.". |
| PolicyViolationCategory |
Describes the nature of the policy violation. |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| ProtocolTypes |
Specifies the protocol of WinRM listener. Possible values are: http, https.. |
| 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. |
| PublicIPAddressSkuName |
Specify public IP sku name. |
| PublicIPAddressSkuTier |
Specify public IP sku tier. |
| PublicIPAllocationMethod |
Specify the public IP allocation type. |
| PublicNetworkAccess |
Policy for controlling export on the disk. |
| RebalanceBehavior |
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. |
| RebalanceStrategy |
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. |
| 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. |
| ReplicationMode |
Optional parameter which specifies the mode to be used for replication. This property is not updatable. |
| ReplicationState |
This is the regional replication state. |
| ReplicationStatusTypes |
Type of ReplicationStatusTypes. |
| ReservationType |
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. |
| ResilientVMDeletionStatus |
Specifies the resilient VM deletion status for the virtual machine. |
| ResourceIdOptionsForGetCapacityReservationGroups |
Type of ResourceIdOptionsForGetCapacityReservationGroups. |
| 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. |
| ResourceSkuCapacityScaleType |
The scale type applicable to the sku. |
| ResourceSkuRestrictionsReasonCode |
The reason for restriction. |
| ResourceSkuRestrictionsType |
The type of restrictions. |
| RestorePointCollectionExpandOptions |
Type of RestorePointCollectionExpandOptions. |
| RestorePointEncryptionType |
The type of key used to encrypt the data of the disk restore point. |
| RestorePointExpandOptions |
Type of RestorePointExpandOptions. |
| RollingUpgradeActionType |
The last action performed on the rolling upgrade. |
| RollingUpgradeStatusCode |
Code indicating the current status of the upgrade. |
| ScriptShellTypes |
Script shell types. |
| SecurityEncryptionTypes |
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. |
| SecurityTypes |
Specifies the VM securityType; UefiSettings are enabled only when set to TrustedLaunch or ConfidentialVM, and returns a Standard value starting API version 2025-11-01. |
| SelectPermissions |
Type of SelectPermissions. |
| SettingNames |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
| SharedGalleryHostCaching |
The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. |
| SharedToValues |
Type of SharedToValues. |
| SharingProfileGroupTypes |
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. |
| SharingUpdateOperationTypes |
This property allows you to specify the operation type of gallery sharing update. Possible values are: Add, Remove, Reset.. |
| SnapshotAccessState |
The state of snapshot which determines the access availability of the snapshot. |
| SnapshotStorageAccountTypes |
The sku name. |
| SoftDeletedArtifactTypes |
artifact type of the soft-deleted resource. |
| SshEncryptionTypes |
The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA. |
| StatusLevelTypes |
The level code. |
| 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 to be used to store the image. This property is not updatable. |
| 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. |
| StorageAlignmentStatus |
Specifies the storage alignment status for the disk. |
| StorageFaultDomainAlignmentType |
Specifies the storage fault domain alignment type for the disk. |
| 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. |
| UpgradeMode |
Specifies the mode of an upgrade to virtual machines in the scale set. |
| UpgradeOperationInvoker |
Invoker of the Upgrade Operation. |
| UpgradeState |
Code indicating the current status of the upgrade. |
| VMGuestPatchClassificationLinux |
Type of VMGuestPatchClassificationLinux. |
| VMGuestPatchClassificationWindows |
Type of VMGuestPatchClassificationWindows. |
| VMGuestPatchRebootBehavior |
Describes the reboot requirements of the patch. |
| VMGuestPatchRebootSetting |
Defines when it is acceptable to reboot a VM during a software update operation. |
| VMGuestPatchRebootStatus |
The reboot state of the VM following completion of the operation. |
| VMScaleSetLifecycleHookEventState |
The states that a virtual machine scale set lifecycle hook event can be in. This is not settable by the customer. It is set only by the platform. |
| VMScaleSetLifecycleHookEventType |
Specifies the scenario for which the customer is interested in receiving virtual machine scale set lifecycle hook events. |
| ValidationStatus |
This property specifies the status of the validationProfile of the image version. |
| VirtualMachineEvictionPolicyTypes |
Specifies the eviction policy for the Azure Spot VM/VMSS. |
| VirtualMachinePriorityTypes |
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. |
| VirtualMachineScaleSetScaleInRules |
Type of VirtualMachineScaleSetScaleInRules. |
| VirtualMachineScaleSetSkuScaleType |
The scale type applicable to the sku. |
| VirtualMachineSizeTypes |
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. |
| VmDiskTypes |
VM disk types which are disallowed. |
| WindowsPatchAssessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
| 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.
|
| ZonalPlatformFaultDomainAlignMode |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
| ZonePlacementPolicyType |
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. |
