models Package
Classes
AdditionalCapabilities |
Enables or disables a capability on the virtual machine or virtual machine scale set. |
AdditionalUnattendContent |
Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. |
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. All required parameters must be populated in order to send to server. |
AutomaticRepairsPolicy |
Specifies the configuration parameters for automatic repairs on the virtual machine scale set. |
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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
AvailabilitySetListResult |
The List Availability Set operation response. All required parameters must be populated in order to send to server. |
AvailabilitySetUpdate |
Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated. Variables are only populated by the server, and will be ignored when sending a request. |
AvailablePatchSummary |
Describes the properties of an virtual machine instance view for available patch summary. Variables are only populated by the server, and will be ignored when sending a request. |
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. Variables are only populated by the server, and will be ignored when sending a request. |
CapacityReservation |
Specifies information about the capacity reservation. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
CapacityReservationGroupInstanceView |
CapacityReservationGroupInstanceView. Variables are only populated by the server, and will be ignored when sending a request. |
CapacityReservationGroupListResult |
The List capacity reservation group with resource group response. All required parameters must be populated in order to send to server. |
CapacityReservationGroupUpdate |
Specifies information about the capacity reservation group. Only tags can be updated. Variables are only populated by the server, and will be ignored when sending a request. |
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. Variables are only populated by the server, and will be ignored when sending a request. |
CapacityReservationListResult |
The list capacity reservation operation response. All required parameters must be populated in order to send to server. |
CapacityReservationProfile |
The parameters of a capacity reservation Profile. |
CapacityReservationUpdate |
Specifies information about the capacity reservation. Only tags and sku.capacity can be updated. Variables are only populated by the server, and will be ignored when sending a request. |
CapacityReservationUtilization |
Represents the capacity reservation utilization in terms of resources allocated. Variables are only populated by the server, and will be ignored when sending a request. |
ComputeOperationListResult |
The List Compute Operation operation response. Variables are only populated by the server, and will be ignored when sending a request. |
ComputeOperationValue |
Describes the properties of a Compute Operation value. Variables are only populated by the server, and will be ignored when sending a request. |
DataDisk |
Describes a data disk. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
DataDiskImage |
Contains the data disk images information. Variables are only populated by the server, and will be ignored when sending a request. |
DataDisksToAttach |
Describes the data disk to be attached. All required parameters must be populated in order to send to server. |
DataDisksToDetach |
Describes the data disk to be detached. All required parameters must be populated in order to send to server. |
DedicatedHost |
Specifies information about the Dedicated host. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
DedicatedHostGroupInstanceView |
DedicatedHostGroupInstanceView. |
DedicatedHostGroupListResult |
The List Dedicated Host Group with resource group response. All required parameters must be populated in order to send to server. |
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. Variables are only populated by the server, and will be ignored when sending a request. |
DedicatedHostInstanceView |
The instance view of a dedicated host. Variables are only populated by the server, and will be ignored when sending a request. |
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. Variables are only populated by the server, and will be ignored when sending a request. |
DedicatedHostListResult |
The list dedicated host operation response. All required parameters must be populated in order to send to server. |
DedicatedHostSizeListResult |
The List Dedicated Host sizes operation response. |
DedicatedHostUpdate |
Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
DisallowedConfiguration |
Specifies the disallowed configuration for a virtual machine image. |
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. |
DiskEncryptionSettings |
Describes a Encryption Settings for a Disk. |
DiskInstanceView |
The instance view of the disk. |
DiskRestorePointAttributes |
Disk Restore Point details. Variables are only populated by the server, and will be ignored when sending a request. |
DiskRestorePointInstanceView |
The instance view of a disk restore point. |
DiskRestorePointReplicationStatus |
The instance view of a disk restore point. |
EncryptionIdentity |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
EventGridAndResourceGraph |
Specifies eventGridAndResourceGraph related Scheduled Event related configurations. |
ExtendedLocation |
The complex type of the extended location. |
HardwareProfile |
Specifies the hardware settings for the virtual machine. |
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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ImageDataDisk |
Describes a data disk. All required parameters must be populated in order to send to server. |
ImageDeprecationStatus |
Describes image deprecation status properties on the image. |
ImageDisk |
Describes a image disk. |
ImageListResult |
The List Image operation response. All required parameters must be populated in order to send to server. |
ImageOSDisk |
Describes an Operating System disk. All required parameters must be populated in order to send to server. |
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. Variables are only populated by the server, and will be ignored when sending a request. |
ImageStorageProfile |
Describes a storage profile. |
ImageUpdate |
The source user image virtual hard disk. Only tags may be updated. Variables are only populated by the server, and will be ignored when sending a request. |
InnerError |
Inner error details. |
InstanceViewStatus |
Instance view status. |
KeyVaultKeyReference |
Describes a reference to Key Vault Key. All required parameters must be populated in order to send to server. |
KeyVaultSecretReference |
Describes a reference to Key Vault Secret. All required parameters must be populated in order to send to server. |
LastPatchInstallationSummary |
Describes the properties of the last installed patch summary. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
ListUsagesResult |
The List Usages operation response. All required parameters must be populated in order to send to server. |
LogAnalyticsInputBase |
Api input base class for LogAnalytics Api. All required parameters must be populated in order to send to server. |
LogAnalyticsOperationResult |
LogAnalytics operation status response. Variables are only populated by the server, and will be ignored when sending a request. |
LogAnalyticsOutput |
LogAnalytics output properties. Variables are only populated by the server, and will be ignored when sending a request. |
MaintenanceRedeployStatus |
Maintenance Operation Status. |
ManagedDiskParameters |
The parameters of a managed disk. |
NetworkInterfaceReference |
Describes a network interface reference. |
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. All required parameters must be populated in order to send to server. |
OSDiskImage |
Contains the os disk image information. All required parameters must be populated in order to send to server. |
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. |
OrchestrationServiceStateInput |
The input for OrchestrationServiceState. All required parameters must be populated in order to send to server. |
OrchestrationServiceSummary |
Summary for an orchestration service of a virtual machine scale set. Variables are only populated by the server, and will be ignored when sending a request. |
PatchInstallationDetail |
Information about a specific patch that was encountered during an installation action. Variables are only populated by the server, and will be ignored when sending a request. |
PatchSettings |
Specifies settings related to VM Guest Patching on Windows. |
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. |
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. |
ProximityPlacementGroup |
Specifies information about the proximity placement group. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ProximityPlacementGroupListResult |
The List Proximity Placement Group operation response. All required parameters must be populated in order to send to server. |
ProximityPlacementGroupPropertiesIntent |
Specifies the user intent of the proximity placement group. |
ProximityPlacementGroupUpdate |
Specifies information about the proximity placement group. |
ProxyAgentSettings |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2024-03-01. |
ProxyResource |
The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location. Variables are only populated by the server, and will be ignored when sending a request. |
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. All required parameters must be populated in order to send to server. |
RecoveryWalkResponse |
Response after calling a manual recovery walk. Variables are only populated by the server, and will be ignored when sending a request. |
RequestRateByIntervalInput |
Api request input for LogAnalytics getRequestRateByInterval Api. All required parameters must be populated in order to send to server. |
ResiliencyPolicy |
Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy. |
ResilientVMCreationPolicy |
The configuration parameters used while performing resilient VM creation. |
ResilientVMDeletionPolicy |
The configuration parameters used while performing resilient VM deletion. |
Resource |
The Resource model definition. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ResourceSharingProfile |
ResourceSharingProfile. |
ResourceWithOptionalLocation |
The Resource model definition with location property as optional. Variables are only populated by the server, and will be ignored when sending a request. |
RestorePoint |
Restore Point details. Variables are only populated by the server, and will be ignored when sending a request. |
RestorePointCollection |
Create or update Restore Point collection parameters. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
RestorePointCollectionListResult |
The List restore point collection operation response. |
RestorePointCollectionSourceProperties |
The properties of the source resource that this restore point collection is created from. Variables are only populated by the server, and will be ignored when sending a request. |
RestorePointCollectionUpdate |
Update Restore Point collection parameters. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
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. Variables are only populated by the server, and will be ignored when sending a request. |
RestorePointSourceVMDataDisk |
Describes a data disk. Variables are only populated by the server, and will be ignored when sending a request. |
RestorePointSourceVMOSDisk |
Describes an Operating System disk. Variables are only populated by the server, and will be ignored when sending a request. |
RestorePointSourceVMStorageProfile |
Describes the storage profile. Variables are only populated by the server, and will be ignored when sending a request. |
RetrieveBootDiagnosticsDataResult |
The SAS URIs of the console screenshot and serial log blobs. Variables are only populated by the server, and will be ignored when sending a request. |
RollbackStatusInfo |
Information about rollback on failed VM instances after a OS Upgrade operation. Variables are only populated by the server, and will be ignored when sending a request. |
RollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
RollingUpgradeProgressInfo |
Information about the number of virtual machine instances in each upgrade state. Variables are only populated by the server, and will be ignored when sending a request. |
RollingUpgradeRunningStatus |
Information about the current running state of the overall upgrade. Variables are only populated by the server, and will be ignored when sending a request. |
RollingUpgradeStatusInfo |
The status of the latest virtual machine scale set rolling upgrade. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
RunCommandDocument |
Describes the properties of a Run Command. All required parameters must be populated in order to send to server. |
RunCommandDocumentBase |
Describes the properties of a Run Command metadata. All required parameters must be populated in order to send to server. |
RunCommandInput |
Capture Virtual Machine parameters. All required parameters must be populated in order to send to server. |
RunCommandInputParameter |
Describes the properties of a run command parameter. All required parameters must be populated in order to send to server. |
RunCommandListResult |
The List Virtual Machine operation response. All required parameters must be populated in order to send to server. |
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. All required parameters must be populated in order to send to server. |
RunCommandResult |
RunCommandResult. |
ScaleInPolicy |
Describes a scale-in policy for a virtual machine scale set. |
ScheduledEventsAdditionalPublishingTargets |
ScheduledEventsAdditionalPublishingTargets. |
ScheduledEventsPolicy |
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. |
ScheduledEventsProfile |
ScheduledEventsProfile. |
SecurityPostureReference |
Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01. All required parameters must be populated in order to send to server. |
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. |
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. |
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. All required parameters must be populated in order to send to server. |
SshPublicKeyResource |
Specifies information about the SSH public key. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SshPublicKeyUpdateResource |
Specifies information about the SSH public key. |
SshPublicKeysGroupListResult |
The list SSH public keys operation response. All required parameters must be populated in order to send to server. |
StorageProfile |
Specifies the storage settings for the virtual machine disks. |
SubResource |
SubResource. |
SubResourceReadOnly |
SubResourceReadOnly. Variables are only populated by the server, and will be ignored when sending a request. |
SubResourceWithColocationStatus |
SubResourceWithColocationStatus. |
SystemData |
The system meta data relating to this resource. Variables are only populated by the server, and will be ignored when sending a request. |
TerminateNotificationProfile |
TerminateNotificationProfile. |
ThrottledRequestsInput |
Api request input for LogAnalytics getThrottledRequests Api. All required parameters must be populated in order to send to server. |
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. |
UpgradeOperationHistoricalStatusInfo |
Virtual Machine Scale Set OS Upgrade History operation response. Variables are only populated by the server, and will be ignored when sending a request. |
UpgradeOperationHistoricalStatusInfoProperties |
Describes each OS upgrade on the Virtual Machine Scale Set. Variables are only populated by the server, and will be ignored when sending a request. |
UpgradeOperationHistoryStatus |
Information about the current running state of the overall upgrade. Variables are only populated by the server, and will be ignored when sending a request. |
UpgradePolicy |
Describes an upgrade policy - automatic, manual, or rolling. |
Usage |
Describes Compute Resource Usage. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
UsageName |
The Usage Names. |
UserAssignedIdentitiesValue |
UserAssignedIdentitiesValue. Variables are only populated by the server, and will be ignored when sending a request. |
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. All required parameters must be populated in order to send to server. |
VMScaleSetConvertToSinglePlacementGroupInput |
VMScaleSetConvertToSinglePlacementGroupInput. |
VMSizeProperties |
Specifies VM Size Property settings on the virtual machine. |
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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
VirtualMachineAgentInstanceView |
The instance view of the VM Agent running on the virtual machine. |
VirtualMachineAssessPatchesResult |
Describes the properties of an AssessPatches result. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineCaptureParameters |
Capture Virtual Machine parameters. All required parameters must be populated in order to send to server. |
VirtualMachineCaptureResult |
Output of virtual machine capture operation. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineExtension |
Describes a Virtual Machine Extension. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineExtensionHandlerInstanceView |
The instance view of a virtual machine extension handler. |
VirtualMachineExtensionImage |
Describes a Virtual Machine Extension Image. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
VirtualMachineExtensionInstanceView |
The instance view of a virtual machine extension. |
VirtualMachineExtensionUpdate |
Describes a Virtual Machine Extension. |
VirtualMachineExtensionsListResult |
The List Extension operation response. |
VirtualMachineHealthStatus |
The health status of the VM. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineIdentity |
Identity for the virtual machine. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineImage |
Describes a Virtual Machine Image. All required parameters must be populated in order to send to server. |
VirtualMachineImageFeature |
Specifies additional capabilities supported by the image. |
VirtualMachineImageResource |
Virtual machine image resource information. All required parameters must be populated in order to send to server. |
VirtualMachineInstallPatchesParameters |
Input for InstallPatches as directly received by the API. All required parameters must be populated in order to send to server. |
VirtualMachineInstallPatchesResult |
The result summary of an installation operation. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineInstanceView |
The instance view of a virtual machine. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineIpTag |
Contains the IP tag associated with the public IP address. |
VirtualMachineListResult |
The List Virtual Machine operation response. All required parameters must be populated in order to send to server. |
VirtualMachineNetworkInterfaceConfiguration |
Describes a virtual machine network interface configurations. All required parameters must be populated in order to send to server. |
VirtualMachineNetworkInterfaceDnsSettingsConfiguration |
Describes a virtual machines network configuration's DNS settings. |
VirtualMachineNetworkInterfaceIPConfiguration |
Describes a virtual machine network profile's IP configuration. All required parameters must be populated in order to send to server. |
VirtualMachinePatchStatus |
The status of virtual machine patch operations. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachinePublicIPAddressConfiguration |
Describes a virtual machines IP Configuration's PublicIPAddress configuration. All required parameters must be populated in order to send to server. |
VirtualMachinePublicIPAddressDnsSettingsConfiguration |
Describes a virtual machines network configuration's DNS settings. All required parameters must be populated in order to send to server. |
VirtualMachineReimageParameters |
Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged. |
VirtualMachineRunCommand |
Describes a Virtual Machine run command. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
VirtualMachineRunCommandInstanceView |
The instance view of a virtual machine run command. |
VirtualMachineRunCommandScriptSource |
Describes the script sources for run command. Use only one of script, scriptUri, commandId. |
VirtualMachineRunCommandUpdate |
Describes a Virtual Machine run command. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineRunCommandsListResult |
The List run command operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSet |
Describes a Virtual Machine Scale Set. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetDataDisk |
Describes a virtual machine scale set data disk. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetExtension |
Describes a Virtual Machine Scale Set Extension. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetExtensionListResult |
The List VM scale set extension operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetExtensionProfile |
Describes a virtual machine scale set extension profile. |
VirtualMachineScaleSetExtensionUpdate |
Describes a Virtual Machine Scale Set Extension. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetHardwareProfile |
Specifies the hardware settings for the virtual machine scale set. |
VirtualMachineScaleSetIPConfiguration |
Describes a virtual machine scale set network profile's IP configuration. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetIdentity |
Identity for the virtual machine scale set. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetInstanceView |
The instance view of a virtual machine scale set. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetInstanceViewStatusesSummary |
Instance view statuses summary for virtual machines of a virtual machine scale set. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetIpTag |
Contains the IP tag associated with the public IP address. |
VirtualMachineScaleSetListOSUpgradeHistory |
List of Virtual Machine Scale Set OS Upgrade History operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetListResult |
The List Virtual Machine operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetListSkusResult |
The Virtual Machine Scale Set List Skus operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetListWithLinkResult |
The List Virtual Machine operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetManagedDiskParameters |
Describes the parameters of a ScaleSet managed disk. |
VirtualMachineScaleSetNetworkConfiguration |
Describes a virtual machine scale set network profile's network configurations. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetNetworkConfigurationDnsSettings |
Describes a virtual machines scale sets network configuration's DNS settings. |
VirtualMachineScaleSetNetworkProfile |
Describes a virtual machine scale set network profile. |
VirtualMachineScaleSetOSDisk |
Describes a virtual machine scale set operating system disk. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetOSProfile |
Describes a virtual machine scale set OS profile. |
VirtualMachineScaleSetPublicIPAddressConfiguration |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings |
Describes a virtual machines scale sets network configuration's DNS settings. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetReimageParameters |
Describes a Virtual Machine Scale Set VM Reimage Parameters. |
VirtualMachineScaleSetSku |
Describes an available virtual machine scale set sku. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetSkuCapacity |
Describes scaling information of a sku. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
VirtualMachineScaleSetUpdateNetworkConfiguration |
Describes a virtual machine scale set network profile's network configurations. |
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. |
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration |
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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetVMExtension |
Describes a VMSS VM Extension. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetVMExtensionUpdate |
Describes a VMSS VM Extension. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetVMExtensionsListResult |
The List VMSS VM Extension operation response. |
VirtualMachineScaleSetVMExtensionsSummary |
Extensions summary for virtual machines of a virtual machine scale set. Variables are only populated by the server, and will be ignored when sending a request. |
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. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetVMInstanceView |
The instance view of a virtual machine scale set VM. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineScaleSetVMListResult |
The List Virtual Machine Scale Set VMs operation response. All required parameters must be populated in order to send to server. |
VirtualMachineScaleSetVMNetworkProfileConfiguration |
Describes a virtual machine scale set VM network profile. |
VirtualMachineScaleSetVMProfile |
Describes a virtual machine scale set virtual machine profile. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
VirtualMachineSizeListResult |
The List Virtual Machine operation response. |
VirtualMachineSoftwarePatchProperties |
Describes the properties of a Virtual Machine software patch. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineStatusCodeCount |
The status code and count of the virtual machine scale set instance view status summary. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualMachineUpdate |
Describes a Virtual Machine Update. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
Enums
AlternativeType |
Describes the type of the alternative option. |
ArchitectureTypes |
Specifies the Architecture Type. |
AvailabilitySetSkuTypes |
Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. |
CachingTypes |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. |
CapacityReservationGroupInstanceViewTypes |
CapacityReservationGroupInstanceViewTypes. |
CapacityReservationInstanceViewTypes |
CapacityReservationInstanceViewTypes. |
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. |
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. |
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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. |
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. |
ExecutionState |
Script execution status. |
ExpandTypeForListVMs |
ExpandTypeForListVMs. |
ExpandTypesForGetCapacityReservationGroups |
ExpandTypesForGetCapacityReservationGroups. |
ExpandTypesForGetVMScaleSets |
ExpandTypesForGetVMScaleSets. |
ExpandTypesForListVMs |
ExpandTypesForListVMs. |
ExtendedLocationTypes |
The type of extendedLocation. |
HyperVGeneration |
The hypervisor generation of the Virtual Machine [V1, V2]. |
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 2019-07-01 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 |
InstanceViewTypes. |
IntervalInMins |
Interval value in minutes used to create LogAnalytics call rate logs. |
LinuxPatchAssessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.:code: |
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.:code: |
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. |
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. |
OrchestrationServiceState |
The current state of the service. |
OrchestrationServiceStateAction |
The action to be performed. |
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.". |
ProtocolTypes |
Specifies the protocol of WinRM listener. Possible values are: http, https.. |
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. |
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. |
ResourceIdOptionsForGetCapacityReservationGroups |
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. |
RestorePointCollectionExpandOptions |
RestorePointCollectionExpandOptions. |
RestorePointEncryptionType |
The type of key used to encrypt the data of the disk restore point. |
RestorePointExpandOptions |
RestorePointExpandOptions. |
RollingUpgradeActionType |
The last action performed on the rolling upgrade. |
RollingUpgradeStatusCode |
Code indicating the current status of the upgrade. |
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 SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. |
SettingNames |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
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. |
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. |
UpgradeMode |
Specifies the mode of an upgrade to virtual machines in the scale set.:code: |
UpgradeOperationInvoker |
Invoker of the Upgrade Operation. |
UpgradeState |
Code indicating the current status of the upgrade. |
VMGuestPatchClassificationLinux |
VMGuestPatchClassificationLinux. |
VMGuestPatchClassificationWindows |
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. |
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 |
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.:code: |
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.:code: |
Azure SDK for Python