Package-level declarations
Types
This is the Access Control Rules specification for an inVMAccessControlProfile version.
The properties of an Access Control Rule RoleAssignment.
The properties of an Access Control Rule Role.
Enables or disables a capability on the virtual machine or virtual machine scale set.
Describes the additional replica set information.
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.
The API entity reference.
Api error base.
Api error.
Contains the list of gallery applications that should be made available to the VM/VMSS
The configuration parameters used for performing automatic OS upgrade.
Specifies the configuration parameters for automatic repairs on the virtual machine scale set.
The configuration parameters used while performing automatic AZ balancing.
Describes the properties of an virtual machine instance view for available patch summary.
Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01.
The instance view of a virtual machine boot diagnostics.
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.
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.
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.
The parameters of a capacity reservation Profile.
Represents the capacity reservation utilization in terms of resources allocated.
Describes a cloud service extension profile.
Extension Properties.
Network Profile for the cloud service.
Describes the OS profile for the cloud service.
Cloud service properties
Describes the role properties.
Describes the role profile for the cloud service.
Describes the cloud service role sku.
Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance.
Describes a set of certificates which are all in the same Key Vault.
Information of community gallery if current gallery is shared to community
Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
Data used when creating a disk.
Contains encryption settings for a data disk image.
Describes a data disk.
Represents the dedicated host unutilized capacity in terms of a specific VM size.
Dedicated host unutilized capacity.
Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
The instance view of a dedicated host.
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.
Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
Describes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral disk settings can only be specified for managed disk.
Describes the disallowed disk types.
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.
Describes a Encryption Settings for a Disk
The instance view of the disk.
Disk Restore Point details.
The instance view of a disk restore point.
The instance view of a disk restore point.
Contains the security related information for the resource.
The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
Specifies the Managed Identity used by ADE to get access token for keyvault operations.
Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.
Encryption at rest settings for disk or snapshot
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.
Encryption settings for disk or snapshot
Encryption settings for one disk volume.
Specifies eventGridAndResourceGraph related Scheduled Event related configurations.
This is the executed Validation.
The complex type of the extended location.
Describes a cloud service Extension.
The definition of a parameter that can be passed to a custom action of a Gallery Application Version.
A custom action that can be performed with a Gallery Application Version.
The publishing profile of a gallery image version.
The safety profile of the Gallery Application Version.
The source of the gallery artifact version.
This is the data disk image.
The source for the disk image.
The name of the extended location.
Describes the gallery unique name.
Identity for the virtual machine.
A feature for gallery image.
This is the gallery image definition identifier.
The publishing profile of a gallery image Version.
This is the safety profile of the Gallery Image Version.
This is the storage profile of a Gallery Image Version.
Contains UEFI settings for the image version.
Describes the properties of a gallery inVMAccessControlProfile.
This is the OS disk image.
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.
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.
Specifies information about the capacity reservation.
Describes the cloud service.
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.
Specifies information about the Dedicated host.
The Private Endpoint Connection resource.
disk access resource.
disk encryption set resource.
Disk resource.
Specifies information about the gallery Application Definition that you want to create or update.
Specifies information about the gallery Application Version that you want to create or update.
Specifies information about the gallery image definition that you want to create or update.
Specifies information about the gallery image version that you want to create or update.
Specifies information about the gallery inVMAccessControlProfile that you want to create or update.
Specifies information about the gallery inVMAccessControlProfile version that you want to create or update.
Specifies information about the Shared Image Gallery that you want to create or update.
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.
LogAnalytics operation status response
LogAnalytics operation status response
Specifies information about the proximity placement group.
Create or update Restore Point collection parameters.
Restore Point details.
Snapshot resource.
Describes a Virtual Machine Extension.
Describes a Virtual Machine.
Describes a Virtual Machine run command.
Describes a Virtual Machine Scale Set Extension.
Describes a Virtual Machine Scale Set.
Describes a VMSS VM Extension.
Describes a virtual machine scale set virtual machine.
Describes a Virtual Machine run command.
Specifies the hardware settings for the virtual machine.
Specifies particular host endpoint settings.
Describes a data disk.
The source image used for creating the disk.
Describes an Operating System disk.
Describes the gallery image definition purchase plan. This is used by marketplace images.
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
Describes a storage profile.
The security profile of a gallery image version
Inner error details.
Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots
Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
Key Vault Secret Url and vault id of the encryption key
Describes a reference to Key Vault Key
Describes a reference to Key Vault Secret
Describes the properties of the last installed patch summary.
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
Specifies settings related to VM Guest Patching on Linux.
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.
Describes the properties of the load balancer configuration.
Describes the load balancer configuration.
Describes a cloud service IP Configuration
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.
LogAnalytics output properties
Maintenance Operation Status.
The parameters of a managed disk.
Describes a network interface reference.
Specifies the network interfaces or the networking configuration of the virtual machine.
Contains encryption settings for an OS disk image.
Contains security profile for an OS disk image.
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.
Specifies settings related to VM Guest Patching on Windows.
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.
This is the platform attribute of the image version.
A policy violation reported against a gallery artifact.
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.
The Private Endpoint Connection resource.
The Private Endpoint resource.
A collection of information about the state of the connection between service consumer and provider.
Properties of the disk for which update is pending.
Specifies the user intent of the proximity placement group.
Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.
This is the regional replication status.
Gallery regional sharing status
This is the replication status of the gallery image version.
Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy and/or ResilientVMDeletionPolicy.
The configuration parameters used while performing resilient VM creation.
The configuration parameters used while performing resilient VM deletion.
Describes the resource range.
The properties of the source resource that this restore point collection is created from.
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.
The instance view of a restore point.
Restore Point details.
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.
Describes a data disk.
Describes an Operating System disk.
Describes the storage profile.
The configuration parameters used while performing a rolling upgrade.
Describes the properties of a run command parameter.
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.
Describes a scale-in policy for a virtual machine scale set.
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01
Specifies the Security profile settings for the virtual machine or virtual machine scale set.
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
Group of the gallery sharing profile
Profile for gallery sharing to subscription or tenant
Sharing status of current gallery.
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.
Specifies the VM Size.
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.
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
Contains information about the soft deletion policy of the gallery.
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
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.
SSH configuration for Linux based VMs running on Azure
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
Specifies the storage settings for the virtual machine disks.
List of supported capabilities persisted on the disk resource for VM use.
The system meta data relating to this resource.
Describes the target region information.
A UEFI key signature.
Additional UEFI key signatures that will be added to the image in addition to the signature templates
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
Describes an upgrade policy - automatic, manual, or rolling.
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.
The source image from which the Image Version is going to be created.
Specifies Reboot related Scheduled Event related configurations.
Specifies Redeploy related Scheduled Event related configurations.
This is the validations profile of a Gallery Image Version.
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
Describes a set of certificates which are all in the same Key Vault.
Describes the uri of a disk.
The instance view of the VM Agent running on the virtual machine.
The instance view of a virtual machine extension handler.
The instance view of a virtual machine extension.
Describes a Virtual Machine Extension.
The health status of the VM.
Identity for the virtual machine.
The instance view of a virtual machine.
Contains the IP tag associated with the public IP address.
Describes a virtual machine network interface configurations.
Describes a virtual machines network configuration's DNS settings.
Describes a virtual machine network profile's IP configuration.
The status of virtual machine patch operations.
Describes a virtual machines IP Configuration's PublicIPAddress configuration
Describes a virtual machines network configuration's DNS settings.
The instance view of a virtual machine run command.
Describes the script sources for run command. Use only one of script, scriptUri, commandId.
Describes a virtual machine scale set data disk.
Describes a virtual machine scale set extension profile.
Describes a Virtual Machine Scale Set Extension.
Specifies the hardware settings for the virtual machine scale set.
Identity for the virtual machine scale set.
Describes a virtual machine scale set network profile's IP configuration.
Contains the IP tag associated with the public IP address.
Describes the parameters of a ScaleSet managed disk.
Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set.
Describes a virtual machines scale sets network configuration's DNS settings.
Describes a virtual machine scale set network profile's network configurations.
Describes a virtual machine scale set network profile.
Describes a virtual machine scale set operating system disk.
Describes a virtual machine scale set OS profile.
Describes a virtual machines scale sets network configuration's DNS settings.
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
Describes a virtual machine scale set storage profile.
The instance view of a virtual machine scale set VM.
Describes a virtual machine scale set VM network profile.
Describes a virtual machine scale set virtual machine profile.
The protection policy of a virtual machine scale set VM.
Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.
Specifies the required information to reference a compute gallery application version
Specifies VM Size Property settings on the virtual machine.
Specifies Windows operating system settings on the virtual machine.
Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.
Describes Windows Remote Management configuration of the VM
Describes Protocol and thumbprint of Windows Remote Management listener