@azure-rest/arm-compute 1.0.0-alpha.20251128.1 → 1.0.0-alpha.20251201.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Api error. */\nexport interface ApiError {\n /** The Api error details */\n details?: Array<ApiErrorBase>;\n /** The Api inner error */\n innererror?: InnerError;\n /** The error code. */\n code?: string;\n /** The target of the particular error. */\n target?: string;\n /** The error message. */\n message?: string;\n}\n\n/** Api error base. */\nexport interface ApiErrorBase {\n /** The error code. */\n code?: string;\n /** The target of the particular error. */\n target?: string;\n /** The error message. */\n message?: string;\n}\n\n/** Inner error details. */\nexport interface InnerError {\n /** The exception type. */\n exceptiontype?: string;\n /** The internal error message or exception dump. */\n errordetail?: string;\n}\n\n/** Describes a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSet extends Resource {\n /** The virtual machine scale set sku. */\n sku?: Sku;\n /** 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**. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine Scale Set. */\n properties?: VirtualMachineScaleSetProperties;\n /** The identity of the virtual machine scale set, if configured. */\n identity?: VirtualMachineScaleSetIdentity;\n /** The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set */\n zones?: Array<string>;\n /** The extended location of the Virtual Machine Scale Set. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** 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. */\nexport interface Sku {\n /** The sku name. */\n name?: string;\n /** Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic** */\n tier?: string;\n /** Specifies the number of virtual machines in the scale set. */\n capacity?: number;\n}\n\n/** 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**. */\nexport interface Plan {\n /** The plan ID. */\n name?: string;\n /** The publisher ID. */\n publisher?: string;\n /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */\n product?: string;\n /** The promotion code. */\n promotionCode?: string;\n}\n\n/** Describes the properties of a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSetProperties {\n /** The upgrade policy. */\n upgradePolicy?: UpgradePolicy;\n /** Policy for automatic repairs. */\n automaticRepairsPolicy?: AutomaticRepairsPolicy;\n /** The virtual machine profile. */\n virtualMachineProfile?: VirtualMachineScaleSetVMProfile;\n /** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */\n overprovision?: boolean;\n /** When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. */\n doNotRunExtensionsOnOverprovisionedVMs?: boolean;\n /** When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. */\n singlePlacementGroup?: boolean;\n /** Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. */\n zoneBalance?: boolean;\n /** Fault Domain count for each placement group. */\n platformFaultDomainCount?: number;\n /** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n /** Specifies information about the dedicated host group that the virtual machine scale set resides in. <br><br>Minimum api-version: 2020-06-01. */\n hostGroup?: SubResource;\n /** Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */\n scaleInPolicy?: ScaleInPolicy;\n /** Specifies the orchestration mode for the virtual machine scale set. */\n orchestrationMode?: \"Uniform\" | \"Flexible\";\n /** Specifies the Spot Restore properties for the virtual machine scale set. */\n spotRestorePolicy?: SpotRestorePolicy;\n /** Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. */\n priorityMixPolicy?: PriorityMixPolicy;\n}\n\n/** Describes an upgrade policy - automatic, manual, or rolling. */\nexport interface UpgradePolicy {\n /** Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time. */\n mode?: \"Automatic\" | \"Manual\" | \"Rolling\";\n /** The configuration parameters used while performing a rolling upgrade. */\n rollingUpgradePolicy?: RollingUpgradePolicy;\n /** Configuration parameters used for performing automatic OS Upgrade. */\n automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy;\n}\n\n/** The configuration parameters used while performing a rolling upgrade. */\nexport interface RollingUpgradePolicy {\n /** The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. */\n maxBatchInstancePercent?: number;\n /** The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. */\n maxUnhealthyInstancePercent?: number;\n /** The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. */\n maxUnhealthyUpgradedInstancePercent?: number;\n /** The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). */\n pauseTimeBetweenBatches?: string;\n /** Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. */\n enableCrossZoneUpgrade?: boolean;\n /** Upgrade all unhealthy instances in a scale set before any healthy instances. */\n prioritizeUnhealthyInstances?: boolean;\n}\n\n/** The configuration parameters used for performing automatic OS upgrade. */\nexport interface AutomaticOSUpgradePolicy {\n /** Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. <br><br> If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. */\n enableAutomaticOSUpgrade?: boolean;\n /** Whether OS image rollback feature should be disabled. Default value is false. */\n disableAutomaticRollback?: boolean;\n /** Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */\n useRollingUpgradePolicy?: boolean;\n}\n\n/** Specifies the configuration parameters for automatic repairs on the virtual machine scale set. */\nexport interface AutomaticRepairsPolicy {\n /** Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. */\n enabled?: boolean;\n /** The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). */\n gracePeriod?: string;\n /** Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. */\n repairAction?: \"Replace\" | \"Restart\" | \"Reimage\";\n}\n\n/** Describes a virtual machine scale set virtual machine profile. */\nexport interface VirtualMachineScaleSetVMProfile {\n /** Specifies the operating system settings for the virtual machines in the scale set. */\n osProfile?: VirtualMachineScaleSetOSProfile;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: VirtualMachineScaleSetStorageProfile;\n /** Specifies properties of the network interfaces of the virtual machines in the scale set. */\n networkProfile?: VirtualMachineScaleSetNetworkProfile;\n /** Specifies the Security related profile settings for the virtual machines in the scale set. */\n securityProfile?: SecurityProfile;\n /** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** Specifies a collection of settings for extensions installed on virtual machines in the scale set. */\n extensionProfile?: VirtualMachineScaleSetExtensionProfile;\n /** Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15 */\n licenseType?: string;\n /** Specifies the priority for the virtual machines in the scale set. <br><br>Minimum api-version: 2017-10-30-preview */\n priority?: \"Regular\" | \"Low\" | \"Spot\";\n /** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */\n evictionPolicy?: \"Deallocate\" | \"Delete\";\n /** Specifies the billing related details of a Azure Spot VMSS. <br><br>Minimum api-version: 2019-03-01. */\n billingProfile?: BillingProfile;\n /** Specifies Scheduled Event related configurations. */\n scheduledEventsProfile?: ScheduledEventsProfile;\n /** UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n /** Specifies the capacity reservation related details of a scale set. <br><br>Minimum api-version: 2021-04-01. */\n capacityReservation?: CapacityReservationProfile;\n /** Specifies the gallery applications that should be made available to the VM/VMSS */\n applicationProfile?: ApplicationProfile;\n /** Specifies the hardware profile related details of a scale set. <br><br>Minimum api-version: 2021-11-01. */\n hardwareProfile?: VirtualMachineScaleSetHardwareProfile;\n}\n\n/** Describes a virtual machine scale set OS profile. */\nexport interface VirtualMachineScaleSetOSProfile {\n /** Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. */\n computerNamePrefix?: string;\n /** Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in \".\" <br><br> **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters */\n adminUsername?: string;\n /** Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\\W_]) <br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */\n adminPassword?: string;\n /** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) */\n customData?: string;\n /** Specifies Windows operating system settings on the virtual machine. */\n windowsConfiguration?: WindowsConfiguration;\n /** Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */\n linuxConfiguration?: LinuxConfiguration;\n /** Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n secrets?: Array<VaultSecretGroup>;\n /** Specifies whether extension operations should be allowed on the virtual machine scale set. <br><br>This may only be set to False when no extensions are present on the virtual machine scale set. */\n allowExtensionOperations?: boolean;\n}\n\n/** Specifies Windows operating system settings on the virtual machine. */\nexport interface WindowsConfiguration {\n /** Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */\n provisionVMAgent?: boolean;\n /** Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. <br><br> For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. */\n enableAutomaticUpdates?: boolean;\n /** Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". <br><br> Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). */\n timeZone?: string;\n /** Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. */\n additionalUnattendContent?: Array<AdditionalUnattendContent>;\n /** [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */\n patchSettings?: PatchSettings;\n /** Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */\n winRM?: WinRMConfiguration;\n /** Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. */\n enableVMAgentPlatformUpdates?: boolean;\n}\n\n/** 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. */\nexport interface AdditionalUnattendContent {\n /** The pass name. Currently, the only allowable value is OobeSystem. */\n passName?: \"OobeSystem\";\n /** The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. */\n componentName?: \"Microsoft-Windows-Shell-Setup\";\n /** Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. */\n settingName?: \"AutoLogon\" | \"FirstLogonCommands\";\n /** Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. */\n content?: string;\n}\n\n/** Specifies settings related to VM Guest Patching on Windows. */\nexport interface PatchSettings {\n /** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true */\n patchMode?: \"Manual\" | \"AutomaticByOS\" | \"AutomaticByPlatform\";\n /** Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. */\n enableHotpatching?: boolean;\n /** Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You control the timing of patch assessments on a virtual machine.<br /><br /> **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */\n assessmentMode?: \"ImageDefault\" | \"AutomaticByPlatform\";\n /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */\n automaticByPlatformSettings?: WindowsVMGuestPatchAutomaticByPlatformSettings;\n}\n\n/** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */\nexport interface WindowsVMGuestPatchAutomaticByPlatformSettings {\n /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */\n rebootSetting?: \"Unknown\" | \"IfRequired\" | \"Never\" | \"Always\";\n}\n\n/** Describes Windows Remote Management configuration of the VM */\nexport interface WinRMConfiguration {\n /** The list of Windows Remote Management listeners */\n listeners?: Array<WinRMListener>;\n}\n\n/** Describes Protocol and thumbprint of Windows Remote Management listener */\nexport interface WinRMListener {\n /** Specifies the protocol of WinRM listener. <br><br> Possible values are: <br>**http** <br><br> **https** */\n protocol?: \"Http\" | \"Https\";\n /** This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> \"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br> \"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n certificateUrl?: string;\n}\n\n/** Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */\nexport interface LinuxConfiguration {\n /** Specifies whether password authentication should be disabled. */\n disablePasswordAuthentication?: boolean;\n /** Specifies the ssh key configuration for a Linux OS. */\n ssh?: SshConfiguration;\n /** Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */\n provisionVMAgent?: boolean;\n /** [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */\n patchSettings?: LinuxPatchSettings;\n /** Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. */\n enableVMAgentPlatformUpdates?: boolean;\n}\n\n/** SSH configuration for Linux based VMs running on Azure */\nexport interface SshConfiguration {\n /** The list of SSH public keys used to authenticate with linux based VMs. */\n publicKeys?: Array<SshPublicKey>;\n}\n\n/** Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */\nexport interface SshPublicKey {\n /** Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */\n path?: string;\n /** SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */\n keyData?: string;\n}\n\n/** Specifies settings related to VM Guest Patching on Linux. */\nexport interface LinuxPatchSettings {\n /** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - The virtual machine's default patching configuration is used. <br /><br /> **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true */\n patchMode?: \"ImageDefault\" | \"AutomaticByPlatform\";\n /** Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You control the timing of patch assessments on a virtual machine. <br /><br /> **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */\n assessmentMode?: \"ImageDefault\" | \"AutomaticByPlatform\";\n /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */\n automaticByPlatformSettings?: LinuxVMGuestPatchAutomaticByPlatformSettings;\n}\n\n/** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */\nexport interface LinuxVMGuestPatchAutomaticByPlatformSettings {\n /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */\n rebootSetting?: \"Unknown\" | \"IfRequired\" | \"Never\" | \"Always\";\n}\n\n/** Describes a set of certificates which are all in the same Key Vault. */\nexport interface VaultSecretGroup {\n /** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */\n sourceVault?: SubResource;\n /** The list of key vault references in SourceVault which contain certificates. */\n vaultCertificates?: Array<VaultCertificate>;\n}\n\nexport interface SubResource {\n /** Resource Id */\n id?: string;\n}\n\n/** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */\nexport interface VaultCertificate {\n /** This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> \"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br> \"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n certificateUrl?: string;\n /** For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name &lt;UppercaseThumbprint&gt;.crt for the X509 certificate file and &lt;UppercaseThumbprint&gt;.prv for private key. Both of these files are .pem formatted. */\n certificateStore?: string;\n}\n\n/** Describes a virtual machine scale set storage profile. */\nexport interface VirtualMachineScaleSetStorageProfile {\n /** 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. */\n imageReference?: ImageReference;\n /** Specifies information about the operating system disk used by the virtual machines in the scale set. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n osDisk?: VirtualMachineScaleSetOSDisk;\n /** Specifies the parameters that are used to add data disks to the virtual machines in the scale set. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n dataDisks?: Array<VirtualMachineScaleSetDataDisk>;\n diskControllerType?: string;\n}\n\n/** 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. */\nexport interface ImageReference extends SubResource {\n /** The image publisher. */\n publisher?: string;\n /** Specifies the offer of the platform image or marketplace image used to create the virtual machine. */\n offer?: string;\n /** The image SKU. */\n sku?: string;\n /** Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. */\n version?: string;\n /** Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. */\n sharedGalleryImageId?: string;\n /** Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. */\n communityGalleryImageId?: string;\n}\n\n/** Describes a virtual machine scale set operating system disk. */\nexport interface VirtualMachineScaleSetOSDisk {\n /** The disk name. */\n name?: string;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. */\n diffDiskSettings?: DiffDiskSettings;\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** 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. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType?: \"Windows\" | \"Linux\";\n /** Specifies information about the unmanaged user image to base the scale set on. */\n image?: VirtualHardDisk;\n /** Specifies the container urls that are used to store operating system disks for the scale set. */\n vhdContainers?: Array<string>;\n /** The managed disk parameters. */\n managedDisk?: VirtualMachineScaleSetManagedDiskParameters;\n /** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.<br><br> **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes the parameters of ephemeral disk settings that can be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk. */\nexport interface DiffDiskSettings {\n /** Specifies the ephemeral disk settings for operating system disk. */\n option?: \"Local\";\n /** Specifies the ephemeral disk placement for operating system disk.<br><br> Possible values are: <br><br> **CacheDisk** <br><br> **ResourceDisk** <br><br> Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.<br><br> Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. */\n placement?: \"CacheDisk\" | \"ResourceDisk\";\n}\n\n/** Describes the uri of a disk. */\nexport interface VirtualHardDisk {\n /** Specifies the virtual hard disk's uri. */\n uri?: string;\n}\n\n/** Describes the parameters of a ScaleSet managed disk. */\nexport interface VirtualMachineScaleSetManagedDiskParameters {\n /** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */\n storageAccountType?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n /** Specifies the customer managed disk encryption set resource id for the managed disk. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n /** Specifies the security profile for the managed disk. */\n securityProfile?: VMDiskSecurityProfile;\n}\n\n/** Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. <br><br> NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */\nexport interface DiskEncryptionSetParameters extends SubResource {}\n\n/** Specifies the security profile settings for the managed disk. <br><br> NOTE: It can only be set for Confidential VMs */\nexport interface VMDiskSecurityProfile {\n /** Specifies the EncryptionType of the managed disk. <br> It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. <br><br> NOTE: It can be set for only Confidential VMs. */\n securityEncryptionType?: \"VMGuestStateOnly\" | \"DiskWithVMGuestState\";\n /** Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n}\n\n/** Describes a virtual machine scale set data disk. */\nexport interface VirtualMachineScaleSetDataDisk {\n /** The disk name. */\n name?: string;\n /** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */\n lun: number;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** The create option. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The managed disk parameters. */\n managedDisk?: VirtualMachineScaleSetManagedDiskParameters;\n /** Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */\n diskIOPSReadWrite?: number;\n /** Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */\n diskMBpsReadWrite?: number;\n /** Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).<br><br> Possible values: <br><br> **Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.<br><br> **Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.<br><br> The default value is set to **Delete**. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machine scale set network profile. */\nexport interface VirtualMachineScaleSetNetworkProfile {\n /** A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */\n healthProbe?: ApiEntityReference;\n /** The list of network configurations. */\n networkInterfaceConfigurations?: Array<VirtualMachineScaleSetNetworkConfiguration>;\n /** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */\n networkApiVersion?: \"2020-11-01\";\n}\n\n/** The API entity reference. */\nexport interface ApiEntityReference {\n /** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */\n id?: string;\n}\n\n/** Describes a virtual machine scale set network profile's network configurations. */\nexport interface VirtualMachineScaleSetNetworkConfiguration extends SubResource {\n /** The network configuration name. */\n name: string;\n /** Describes a virtual machine scale set network profile's IP configuration. */\n properties?: VirtualMachineScaleSetNetworkConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration. */\nexport interface VirtualMachineScaleSetNetworkConfigurationProperties {\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** Specifies whether the network interface is accelerated networking-enabled. */\n enableAcceleratedNetworking?: boolean;\n /** Specifies whether the network interface is disabled for tcp state tracking. */\n disableTcpStateTracking?: boolean;\n /** Specifies whether the network interface is FPGA networking-enabled. */\n enableFpga?: boolean;\n /** The network security group. */\n networkSecurityGroup?: SubResource;\n /** The dns settings to be applied on the network interfaces. */\n dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings;\n /** Specifies the IP configurations of the network interface. */\n ipConfigurations: Array<VirtualMachineScaleSetIPConfiguration>;\n /** Whether IP forwarding enabled on this NIC. */\n enableIPForwarding?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machines scale sets network configuration's DNS settings. */\nexport interface VirtualMachineScaleSetNetworkConfigurationDnsSettings {\n /** List of DNS servers IP addresses */\n dnsServers?: Array<string>;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration. */\nexport interface VirtualMachineScaleSetIPConfiguration extends SubResource {\n /** The IP configuration name. */\n name: string;\n /** Describes a virtual machine scale set network profile's IP configuration properties. */\n properties?: VirtualMachineScaleSetIPConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration properties. */\nexport interface VirtualMachineScaleSetIPConfigurationProperties {\n /** Specifies the identifier of the subnet. */\n subnet?: ApiEntityReference;\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** The publicIPAddressConfiguration. */\n publicIPAddressConfiguration?: VirtualMachineScaleSetPublicIPAddressConfiguration;\n /** 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'. */\n privateIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. */\n applicationGatewayBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to application security group. */\n applicationSecurityGroups?: Array<SubResource>;\n /** Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */\n loadBalancerBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */\n loadBalancerInboundNatPools?: Array<SubResource>;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetPublicIPAddressConfiguration {\n /** The publicIP address configuration name. */\n name: string;\n /** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\n properties?: VirtualMachineScaleSetPublicIPAddressConfigurationProperties;\n /** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */\n sku?: PublicIPAddressSku;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties {\n /** The idle timeout of the public IP address. */\n idleTimeoutInMinutes?: number;\n /** The dns settings to be applied on the publicIP addresses . */\n dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings;\n /** The list of IP tags associated with the public IP address. */\n ipTags?: Array<VirtualMachineScaleSetIpTag>;\n /** The PublicIPPrefix from which to allocate publicIP addresses. */\n publicIPPrefix?: SubResource;\n /** 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'. */\n publicIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specify what happens to the public IP when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machines scale sets network configuration's DNS settings. */\nexport interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings {\n /** The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created */\n domainNameLabel: string;\n}\n\n/** Contains the IP tag associated with the public IP address. */\nexport interface VirtualMachineScaleSetIpTag {\n /** IP tag type. Example: FirstPartyUsage. */\n ipTagType?: string;\n /** IP tag associated with the public IP. Example: SQL, Storage etc. */\n tag?: string;\n}\n\n/** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */\nexport interface PublicIPAddressSku {\n /** Specify public IP sku name */\n name?: \"Basic\" | \"Standard\";\n /** Specify public IP sku tier */\n tier?: \"Regional\" | \"Global\";\n}\n\n/** Specifies the Security profile settings for the virtual machine or virtual machine scale set. */\nexport interface SecurityProfile {\n /** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\n uefiSettings?: UefiSettings;\n /** This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. <br><br> Default: The Encryption at host will be disabled unless this property is set to true for the resource. */\n encryptionAtHost?: boolean;\n /** Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. <br><br> Default: UefiSettings will not be enabled unless this property is set. */\n securityType?: \"TrustedLaunch\" | \"ConfidentialVM\";\n}\n\n/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\nexport interface UefiSettings {\n /** Specifies whether secure boot should be enabled on the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\n secureBootEnabled?: boolean;\n /** Specifies whether vTPM should be enabled on the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\n vTpmEnabled?: boolean;\n}\n\n/** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\nexport interface DiagnosticsProfile {\n /** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br>**NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\n bootDiagnostics?: BootDiagnostics;\n}\n\n/** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\nexport interface BootDiagnostics {\n /** Whether boot diagnostics should be enabled on the Virtual Machine. */\n enabled?: boolean;\n /** Uri of the storage account to use for placing the console output and screenshot. <br><br>If storageUri is not specified while enabling boot diagnostics, managed storage will be used. */\n storageUri?: string;\n}\n\n/** Describes a virtual machine scale set extension profile. */\nexport interface VirtualMachineScaleSetExtensionProfile {\n /** The virtual machine scale set child extension resources. */\n extensions?: Array<VirtualMachineScaleSetExtension>;\n /** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01 */\n extensionsTimeBudget?: string;\n}\n\n/** Describes a Virtual Machine Scale Set Extension. */\nexport interface VirtualMachineScaleSetExtension extends SubResourceReadOnly {\n /** The name of the extension. */\n name?: string;\n /** Describes the properties of a Virtual Machine Scale Set Extension. */\n properties?: VirtualMachineScaleSetExtensionProperties;\n}\n\n/** Describes the properties of a Virtual Machine Scale Set Extension. */\nexport interface VirtualMachineScaleSetExtensionProperties {\n /** If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. */\n forceUpdateTag?: string;\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */\n autoUpgradeMinorVersion?: boolean;\n /** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */\n enableAutomaticUpgrade?: boolean;\n /** Json formatted public settings for the extension. */\n settings?: any;\n /** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */\n protectedSettings?: any;\n /** Collection of extension names after which this extension needs to be provisioned. */\n provisionAfterExtensions?: Array<string>;\n /** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */\n suppressFailures?: boolean;\n /** The extensions protected settings that are passed by reference, and consumed from key vault */\n protectedSettingsFromKeyVault?: KeyVaultSecretReference;\n}\n\n/** Describes a reference to Key Vault Secret */\nexport interface KeyVaultSecretReference {\n /** The URL referencing a secret in a Key Vault. */\n secretUrl: string;\n /** The relative URL of the Key Vault containing the secret. */\n sourceVault: SubResource;\n}\n\nexport interface SubResourceReadOnly {}\n\n/** Specifies the billing related details of a Azure Spot VM or VMSS. <br><br>Minimum api-version: 2019-03-01. */\nexport interface BillingProfile {\n /** Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. <br><br> This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. <br><br> The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. <br><br> Possible values are: <br><br> - Any decimal value greater than zero. Example: 0.01538 <br><br> -1 – indicates default price to be up-to on-demand. <br><br> You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. <br><br>Minimum api-version: 2019-03-01. */\n maxPrice?: number;\n}\n\nexport interface ScheduledEventsProfile {\n /** Specifies Terminate Scheduled Event related configurations. */\n terminateNotificationProfile?: TerminateNotificationProfile;\n}\n\nexport interface TerminateNotificationProfile {\n /** Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) */\n notBeforeTimeout?: string;\n /** Specifies whether the Terminate Scheduled event is enabled or disabled. */\n enable?: boolean;\n}\n\n/** The parameters of a capacity reservation Profile. */\nexport interface CapacityReservationProfile {\n /** Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. */\n capacityReservationGroup?: SubResource;\n}\n\n/** Contains the list of gallery applications that should be made available to the VM/VMSS */\nexport interface ApplicationProfile {\n /** Specifies the gallery applications that should be made available to the VM/VMSS */\n galleryApplications?: Array<VMGalleryApplication>;\n}\n\n/** Specifies the required information to reference a compute gallery application version */\nexport interface VMGalleryApplication {\n /** Optional, Specifies a passthrough value for more generic context. */\n tags?: string;\n /** Optional, Specifies the order in which the packages have to be installed */\n order?: number;\n /** Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} */\n packageReferenceId: string;\n /** Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided */\n configurationReference?: string;\n /** Optional, If true, any failure for any operation in the VmApplication will fail the deployment */\n treatFailureAsDeploymentFailure?: boolean;\n /** If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS */\n enableAutomaticUpgrade?: boolean;\n}\n\n/** Specifies the hardware settings for the virtual machine scale set. */\nexport interface VirtualMachineScaleSetHardwareProfile {\n /** Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */\n vmSizeProperties?: VMSizeProperties;\n}\n\n/** Specifies VM Size Property settings on the virtual machine. */\nexport interface VMSizeProperties {\n /** Specifies the number of vCPUs available for the VM. <br><br> When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) . */\n vCPUsAvailable?: number;\n /** Specifies the vCPU to physical core ratio. <br><br> When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) <br><br> Setting this property to 1 also means that hyper-threading is disabled. */\n vCPUsPerCore?: number;\n}\n\n/** Enables or disables a capability on the virtual machine or virtual machine scale set. */\nexport interface AdditionalCapabilities {\n /** The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. */\n ultraSSDEnabled?: boolean;\n /** The flag that enables or disables hibernation capability on the VM. */\n hibernationEnabled?: boolean;\n}\n\n/** Describes a scale-in policy for a virtual machine scale set. */\nexport interface ScaleInPolicy {\n /** The rules to be followed when scaling-in a virtual machine scale set. <br><br> Possible values are: <br><br> **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. <br><br> **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. <br><br> **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. <br><br> */\n rules?: Array<\"Default\" | \"OldestVM\" | \"NewestVM\">;\n /** This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) */\n forceDeletion?: boolean;\n}\n\n/** Specifies the Spot-Try-Restore properties for the virtual machine scale set. <br><br> 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. */\nexport interface SpotRestorePolicy {\n /** Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints */\n enabled?: boolean;\n /** Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances */\n restoreTimeout?: string;\n}\n\n/** Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. <br><br>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. */\nexport interface PriorityMixPolicy {\n /** The base number of regular priority VMs that will be created in this scale set as it scales out. */\n baseRegularPriorityCount?: number;\n /** The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. */\n regularPriorityPercentageAboveBase?: number;\n}\n\n/** Identity for the virtual machine scale set. */\nexport interface VirtualMachineScaleSetIdentity {\n /** 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. */\n type?: \"SystemAssigned\" | \"UserAssigned\" | \"SystemAssigned, UserAssigned\" | \"None\";\n /** The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */\n userAssignedIdentities?: Record<string, UserAssignedIdentitiesValue>;\n}\n\nexport interface UserAssignedIdentitiesValue {}\n\n/** The complex type of the extended location. */\nexport interface ExtendedLocation {\n /** The name of the extended location. */\n name?: string;\n /** The type of the extended location. */\n type?: \"EdgeZone\";\n}\n\n/** The Resource model definition. */\nexport interface Resource {\n /** Resource location */\n location: string;\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Describes a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSetUpdate extends UpdateResource {\n /** The virtual machine scale set sku. */\n sku?: Sku;\n /** The purchase plan when deploying a virtual machine scale set from VM Marketplace images. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine Scale Set. */\n properties?: VirtualMachineScaleSetUpdateProperties;\n /** The identity of the virtual machine scale set, if configured. */\n identity?: VirtualMachineScaleSetIdentity;\n}\n\n/** Describes the properties of a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSetUpdateProperties {\n /** The upgrade policy. */\n upgradePolicy?: UpgradePolicy;\n /** Policy for automatic repairs. */\n automaticRepairsPolicy?: AutomaticRepairsPolicy;\n /** The virtual machine profile. */\n virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile;\n /** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */\n overprovision?: boolean;\n /** When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. */\n doNotRunExtensionsOnOverprovisionedVMs?: boolean;\n /** When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. */\n singlePlacementGroup?: boolean;\n /** Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */\n scaleInPolicy?: ScaleInPolicy;\n /** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n}\n\n/** Describes a virtual machine scale set virtual machine profile. */\nexport interface VirtualMachineScaleSetUpdateVMProfile {\n /** The virtual machine scale set OS profile. */\n osProfile?: VirtualMachineScaleSetUpdateOSProfile;\n /** The virtual machine scale set storage profile. */\n storageProfile?: VirtualMachineScaleSetUpdateStorageProfile;\n /** The virtual machine scale set network profile. */\n networkProfile?: VirtualMachineScaleSetUpdateNetworkProfile;\n /** The virtual machine scale set Security profile */\n securityProfile?: SecurityProfile;\n /** The virtual machine scale set diagnostics profile. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** The virtual machine scale set extension profile. */\n extensionProfile?: VirtualMachineScaleSetExtensionProfile;\n /** The license type, which is for bring your own license scenario. */\n licenseType?: string;\n /** Specifies the billing related details of a Azure Spot VMSS. <br><br>Minimum api-version: 2019-03-01. */\n billingProfile?: BillingProfile;\n /** Specifies Scheduled Event related configurations. */\n scheduledEventsProfile?: ScheduledEventsProfile;\n /** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n /** Specifies the hardware profile related details of a scale set. <br><br>Minimum api-version: 2021-11-01. */\n hardwareProfile?: VirtualMachineScaleSetHardwareProfile;\n}\n\n/** Describes a virtual machine scale set OS profile. */\nexport interface VirtualMachineScaleSetUpdateOSProfile {\n /** A base-64 encoded string of custom data. */\n customData?: string;\n /** The Windows Configuration of the OS profile. */\n windowsConfiguration?: WindowsConfiguration;\n /** The Linux Configuration of the OS profile. */\n linuxConfiguration?: LinuxConfiguration;\n /** The List of certificates for addition to the VM. */\n secrets?: Array<VaultSecretGroup>;\n}\n\n/** Describes a virtual machine scale set storage profile. */\nexport interface VirtualMachineScaleSetUpdateStorageProfile {\n /** The image reference. */\n imageReference?: ImageReference;\n /** The OS disk. */\n osDisk?: VirtualMachineScaleSetUpdateOSDisk;\n /** The data disks. */\n dataDisks?: Array<VirtualMachineScaleSetDataDisk>;\n diskControllerType?: string;\n}\n\n/** Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk. */\nexport interface VirtualMachineScaleSetUpdateOSDisk {\n /** The caching type. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. */\n image?: VirtualHardDisk;\n /** The list of virtual hard disk container uris. */\n vhdContainers?: Array<string>;\n /** The managed disk parameters. */\n managedDisk?: VirtualMachineScaleSetManagedDiskParameters;\n /** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.<br><br> **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machine scale set network profile. */\nexport interface VirtualMachineScaleSetUpdateNetworkProfile {\n /** A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */\n healthProbe?: ApiEntityReference;\n /** The list of network configurations. */\n networkInterfaceConfigurations?: Array<VirtualMachineScaleSetUpdateNetworkConfiguration>;\n /** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */\n networkApiVersion?: \"2020-11-01\";\n}\n\n/** Describes a virtual machine scale set network profile's network configurations. */\nexport interface VirtualMachineScaleSetUpdateNetworkConfiguration extends SubResource {\n /** The network configuration name. */\n name?: string;\n /** Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. */\n properties?: VirtualMachineScaleSetUpdateNetworkConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. */\nexport interface VirtualMachineScaleSetUpdateNetworkConfigurationProperties {\n /** Whether this is a primary NIC on a virtual machine. */\n primary?: boolean;\n /** Specifies whether the network interface is accelerated networking-enabled. */\n enableAcceleratedNetworking?: boolean;\n /** Specifies whether the network interface is disabled for tcp state tracking. */\n disableTcpStateTracking?: boolean;\n /** Specifies whether the network interface is FPGA networking-enabled. */\n enableFpga?: boolean;\n /** The network security group. */\n networkSecurityGroup?: SubResource;\n /** The dns settings to be applied on the network interfaces. */\n dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings;\n /** The virtual machine scale set IP Configuration. */\n ipConfigurations?: Array<VirtualMachineScaleSetUpdateIPConfiguration>;\n /** Whether IP forwarding enabled on this NIC. */\n enableIPForwarding?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** 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 */\nexport interface VirtualMachineScaleSetUpdateIPConfiguration extends SubResource {\n /** The IP configuration name. */\n name?: string;\n /** Describes a virtual machine scale set network profile's IP configuration properties. */\n properties?: VirtualMachineScaleSetUpdateIPConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration properties. */\nexport interface VirtualMachineScaleSetUpdateIPConfigurationProperties {\n /** The subnet. */\n subnet?: ApiEntityReference;\n /** Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. */\n primary?: boolean;\n /** The publicIPAddressConfiguration. */\n publicIPAddressConfiguration?: VirtualMachineScaleSetUpdatePublicIPAddressConfiguration;\n /** 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'. */\n privateIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** The application gateway backend address pools. */\n applicationGatewayBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to application security group. */\n applicationSecurityGroups?: Array<SubResource>;\n /** The load balancer backend address pools. */\n loadBalancerBackendAddressPools?: Array<SubResource>;\n /** The load balancer inbound nat pools. */\n loadBalancerInboundNatPools?: Array<SubResource>;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetUpdatePublicIPAddressConfiguration {\n /** The publicIP address configuration name. */\n name?: string;\n /** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\n properties?: VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties {\n /** The idle timeout of the public IP address. */\n idleTimeoutInMinutes?: number;\n /** The dns settings to be applied on the publicIP addresses . */\n dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings;\n /** The PublicIPPrefix from which to allocate publicIP addresses. */\n publicIPPrefix?: SubResource;\n /** Specify what happens to the public IP when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** The Update Resource model definition. */\nexport interface UpdateResource {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Specifies a list of virtual machine instance IDs from the VM scale set. */\nexport interface VirtualMachineScaleSetVMInstanceIDs {\n /** The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. */\n instanceIds?: Array<string>;\n}\n\n/** Specifies a list of virtual machine instance IDs from the VM scale set. */\nexport interface VirtualMachineScaleSetVMInstanceRequiredIDs {\n /** The virtual machine scale set instance ids. */\n instanceIds: Array<string>;\n}\n\n/** Instance view status. */\nexport interface InstanceViewStatus {\n /** The status code. */\n code?: string;\n /** The level code. */\n level?: \"Info\" | \"Warning\" | \"Error\";\n /** The short localizable label for the status. */\n displayStatus?: string;\n /** The detailed status message, including for alerts and error messages. */\n message?: string;\n /** The time of the status. */\n time?: Date | string;\n}\n\n/** Describes a Virtual Machine Scale Set Extension. */\nexport interface VirtualMachineScaleSetExtensionUpdate extends SubResourceReadOnly {\n /** Describes the properties of a Virtual Machine Scale Set Extension. */\n properties?: VirtualMachineScaleSetExtensionProperties;\n}\n\n/** Information about the number of virtual machine instances in each upgrade state. */\nexport interface RollingUpgradeProgressInfo {}\n\n/** Describes a Virtual Machine Scale Set VM Reimage Parameters. */\nexport interface VirtualMachineScaleSetReimageParameters\n extends VirtualMachineScaleSetVMReimageParameters {\n /** The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. */\n instanceIds?: Array<string>;\n}\n\n/** Describes a Virtual Machine Scale Set VM Reimage Parameters. */\nexport interface VirtualMachineScaleSetVMReimageParameters\n extends VirtualMachineReimageParameters {}\n\n/** Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged */\nexport interface VirtualMachineReimageParameters {\n /** Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk. */\n tempDisk?: boolean;\n}\n\n/** The status of the latest virtual machine scale set rolling upgrade. */\nexport interface RollingUpgradeStatusInfo extends Resource {\n /** The status of the latest virtual machine scale set rolling upgrade. */\n properties?: RollingUpgradeStatusInfoProperties;\n}\n\n/** The status of the latest virtual machine scale set rolling upgrade. */\nexport interface RollingUpgradeStatusInfoProperties {}\n\n/** Information about the current running state of the overall upgrade. */\nexport interface RollingUpgradeRunningStatus {}\n\nexport interface VMScaleSetConvertToSinglePlacementGroupInput {\n /** Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances. */\n activePlacementGroupId?: string;\n}\n\n/** The input for OrchestrationServiceState */\nexport interface OrchestrationServiceStateInput {\n /** The name of the service. */\n serviceName: \"AutomaticRepairs\";\n /** The action to be performed. */\n action: \"Resume\" | \"Suspend\";\n}\n\n/** Describes a VMSS VM Extension. */\nexport interface VirtualMachineScaleSetVMExtension extends SubResourceReadOnly {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionProperties;\n}\n\n/** Describes the properties of a Virtual Machine Extension. */\nexport interface VirtualMachineExtensionProperties {\n /** How the extension handler should be forced to update even if the extension configuration has not changed. */\n forceUpdateTag?: string;\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */\n autoUpgradeMinorVersion?: boolean;\n /** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */\n enableAutomaticUpgrade?: boolean;\n /** Json formatted public settings for the extension. */\n settings?: any;\n /** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */\n protectedSettings?: any;\n /** The virtual machine extension instance view. */\n instanceView?: VirtualMachineExtensionInstanceView;\n /** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */\n suppressFailures?: boolean;\n /** The extensions protected settings that are passed by reference, and consumed from key vault */\n protectedSettingsFromKeyVault?: KeyVaultSecretReference;\n}\n\n/** The instance view of a virtual machine extension. */\nexport interface VirtualMachineExtensionInstanceView {\n /** The virtual machine extension name. */\n name?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** The resource status information. */\n substatuses?: Array<InstanceViewStatus>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Describes a VMSS VM Extension. */\nexport interface VirtualMachineScaleSetVMExtensionUpdate extends SubResourceReadOnly {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionUpdateProperties;\n}\n\n/** Describes the properties of a Virtual Machine Extension. */\nexport interface VirtualMachineExtensionUpdateProperties {\n /** How the extension handler should be forced to update even if the extension configuration has not changed. */\n forceUpdateTag?: string;\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */\n autoUpgradeMinorVersion?: boolean;\n /** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */\n enableAutomaticUpgrade?: boolean;\n /** Json formatted public settings for the extension. */\n settings?: any;\n /** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */\n protectedSettings?: any;\n /** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */\n suppressFailures?: boolean;\n /** The extensions protected settings that are passed by reference, and consumed from key vault */\n protectedSettingsFromKeyVault?: KeyVaultSecretReference;\n}\n\n/** Describes a virtual machine scale set virtual machine. */\nexport interface VirtualMachineScaleSetVM extends Resource {\n /** Describes the properties of a virtual machine scale set virtual machine. */\n properties?: VirtualMachineScaleSetVMProperties;\n /** 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**. */\n plan?: Plan;\n /** The identity of the virtual machine, if configured. */\n identity?: VirtualMachineIdentity;\n}\n\n/** Describes the properties of a virtual machine scale set virtual machine. */\nexport interface VirtualMachineScaleSetVMProperties {\n /** Specifies the hardware settings for the virtual machine. */\n hardwareProfile?: HardwareProfile;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: StorageProfile;\n /** Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the operating system settings for the virtual machine. */\n osProfile?: OSProfile;\n /** Specifies the Security related profile settings for the virtual machine. */\n securityProfile?: SecurityProfile;\n /** Specifies the network interfaces of the virtual machine. */\n networkProfile?: NetworkProfile;\n /** Specifies the network profile configuration of the virtual machine. */\n networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration;\n /** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. */\n availabilitySet?: SubResource;\n /** Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15 */\n licenseType?: string;\n /** Specifies the protection policy of the virtual machine. */\n protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy;\n /** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n}\n\n/** The instance view of a virtual machine scale set VM. */\nexport interface VirtualMachineScaleSetVMInstanceView {\n /** The Update Domain count. */\n platformUpdateDomain?: number;\n /** The Fault Domain count. */\n platformFaultDomain?: number;\n /** The Remote desktop certificate thumbprint. */\n rdpThumbPrint?: string;\n /** The VM Agent running on the virtual machine. */\n vmAgent?: VirtualMachineAgentInstanceView;\n /** The Maintenance Operation status on the virtual machine. */\n maintenanceRedeployStatus?: MaintenanceRedeployStatus;\n /** The disks information. */\n disks?: Array<DiskInstanceView>;\n /** The extensions information. */\n extensions?: Array<VirtualMachineExtensionInstanceView>;\n /** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\n bootDiagnostics?: BootDiagnosticsInstanceView;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n /** The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. */\n placementGroupId?: string;\n}\n\n/** The instance view of the VM Agent running on the virtual machine. */\nexport interface VirtualMachineAgentInstanceView {\n /** The VM Agent full version. */\n vmAgentVersion?: string;\n /** The virtual machine extension handler instance view. */\n extensionHandlers?: Array<VirtualMachineExtensionHandlerInstanceView>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** The instance view of a virtual machine extension handler. */\nexport interface VirtualMachineExtensionHandlerInstanceView {\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** The extension handler status. */\n status?: InstanceViewStatus;\n}\n\n/** Maintenance Operation Status. */\nexport interface MaintenanceRedeployStatus {\n /** True, if customer is allowed to perform Maintenance. */\n isCustomerInitiatedMaintenanceAllowed?: boolean;\n /** Start Time for the Pre Maintenance Window. */\n preMaintenanceWindowStartTime?: Date | string;\n /** End Time for the Pre Maintenance Window. */\n preMaintenanceWindowEndTime?: Date | string;\n /** Start Time for the Maintenance Window. */\n maintenanceWindowStartTime?: Date | string;\n /** End Time for the Maintenance Window. */\n maintenanceWindowEndTime?: Date | string;\n /** The Last Maintenance Operation Result Code. */\n lastOperationResultCode?: \"None\" | \"RetryLater\" | \"MaintenanceAborted\" | \"MaintenanceCompleted\";\n /** Message returned for the last Maintenance Operation. */\n lastOperationMessage?: string;\n}\n\n/** The instance view of the disk. */\nexport interface DiskInstanceView {\n /** The disk name. */\n name?: string;\n /** Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15 */\n encryptionSettings?: Array<DiskEncryptionSettings>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Describes a Encryption Settings for a Disk */\nexport interface DiskEncryptionSettings {\n /** Specifies the location of the disk encryption key, which is a Key Vault Secret. */\n diskEncryptionKey?: KeyVaultSecretReference;\n /** Specifies the location of the key encryption key in Key Vault. */\n keyEncryptionKey?: KeyVaultKeyReference;\n /** Specifies whether disk encryption should be enabled on the virtual machine. */\n enabled?: boolean;\n}\n\n/** Describes a reference to Key Vault Key */\nexport interface KeyVaultKeyReference {\n /** The URL referencing a key encryption key in Key Vault. */\n keyUrl: string;\n /** The relative URL of the Key Vault containing the key. */\n sourceVault: SubResource;\n}\n\n/** The health status of the VM. */\nexport interface VirtualMachineHealthStatus {}\n\n/** The instance view of a virtual machine boot diagnostics. */\nexport interface BootDiagnosticsInstanceView {}\n\n/** Specifies the hardware settings for the virtual machine. */\nexport interface HardwareProfile {\n /** Specifies the size of the virtual machine. <br><br> The enum data type is currently deprecated and will be removed by December 23rd 2023. <br><br> Recommended way to get the list of available sizes is using these APIs: <br><br> [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) <br><br> [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list) <br><br> [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). <br><br> The available VM sizes depend on region and availability set. */\n vmSize?:\n | \"Basic_A0\"\n | \"Basic_A1\"\n | \"Basic_A2\"\n | \"Basic_A3\"\n | \"Basic_A4\"\n | \"Standard_A0\"\n | \"Standard_A1\"\n | \"Standard_A2\"\n | \"Standard_A3\"\n | \"Standard_A4\"\n | \"Standard_A5\"\n | \"Standard_A6\"\n | \"Standard_A7\"\n | \"Standard_A8\"\n | \"Standard_A9\"\n | \"Standard_A10\"\n | \"Standard_A11\"\n | \"Standard_A1_v2\"\n | \"Standard_A2_v2\"\n | \"Standard_A4_v2\"\n | \"Standard_A8_v2\"\n | \"Standard_A2m_v2\"\n | \"Standard_A4m_v2\"\n | \"Standard_A8m_v2\"\n | \"Standard_B1s\"\n | \"Standard_B1ms\"\n | \"Standard_B2s\"\n | \"Standard_B2ms\"\n | \"Standard_B4ms\"\n | \"Standard_B8ms\"\n | \"Standard_D1\"\n | \"Standard_D2\"\n | \"Standard_D3\"\n | \"Standard_D4\"\n | \"Standard_D11\"\n | \"Standard_D12\"\n | \"Standard_D13\"\n | \"Standard_D14\"\n | \"Standard_D1_v2\"\n | \"Standard_D2_v2\"\n | \"Standard_D3_v2\"\n | \"Standard_D4_v2\"\n | \"Standard_D5_v2\"\n | \"Standard_D2_v3\"\n | \"Standard_D4_v3\"\n | \"Standard_D8_v3\"\n | \"Standard_D16_v3\"\n | \"Standard_D32_v3\"\n | \"Standard_D64_v3\"\n | \"Standard_D2s_v3\"\n | \"Standard_D4s_v3\"\n | \"Standard_D8s_v3\"\n | \"Standard_D16s_v3\"\n | \"Standard_D32s_v3\"\n | \"Standard_D64s_v3\"\n | \"Standard_D11_v2\"\n | \"Standard_D12_v2\"\n | \"Standard_D13_v2\"\n | \"Standard_D14_v2\"\n | \"Standard_D15_v2\"\n | \"Standard_DS1\"\n | \"Standard_DS2\"\n | \"Standard_DS3\"\n | \"Standard_DS4\"\n | \"Standard_DS11\"\n | \"Standard_DS12\"\n | \"Standard_DS13\"\n | \"Standard_DS14\"\n | \"Standard_DS1_v2\"\n | \"Standard_DS2_v2\"\n | \"Standard_DS3_v2\"\n | \"Standard_DS4_v2\"\n | \"Standard_DS5_v2\"\n | \"Standard_DS11_v2\"\n | \"Standard_DS12_v2\"\n | \"Standard_DS13_v2\"\n | \"Standard_DS14_v2\"\n | \"Standard_DS15_v2\"\n | \"Standard_DS13-4_v2\"\n | \"Standard_DS13-2_v2\"\n | \"Standard_DS14-8_v2\"\n | \"Standard_DS14-4_v2\"\n | \"Standard_E2_v3\"\n | \"Standard_E4_v3\"\n | \"Standard_E8_v3\"\n | \"Standard_E16_v3\"\n | \"Standard_E32_v3\"\n | \"Standard_E64_v3\"\n | \"Standard_E2s_v3\"\n | \"Standard_E4s_v3\"\n | \"Standard_E8s_v3\"\n | \"Standard_E16s_v3\"\n | \"Standard_E32s_v3\"\n | \"Standard_E64s_v3\"\n | \"Standard_E32-16_v3\"\n | \"Standard_E32-8s_v3\"\n | \"Standard_E64-32s_v3\"\n | \"Standard_E64-16s_v3\"\n | \"Standard_F1\"\n | \"Standard_F2\"\n | \"Standard_F4\"\n | \"Standard_F8\"\n | \"Standard_F16\"\n | \"Standard_F1s\"\n | \"Standard_F2s\"\n | \"Standard_F4s\"\n | \"Standard_F8s\"\n | \"Standard_F16s\"\n | \"Standard_F2s_v2\"\n | \"Standard_F4s_v2\"\n | \"Standard_F8s_v2\"\n | \"Standard_F16s_v2\"\n | \"Standard_F32s_v2\"\n | \"Standard_F64s_v2\"\n | \"Standard_F72s_v2\"\n | \"Standard_G1\"\n | \"Standard_G2\"\n | \"Standard_G3\"\n | \"Standard_G4\"\n | \"Standard_G5\"\n | \"Standard_GS1\"\n | \"Standard_GS2\"\n | \"Standard_GS3\"\n | \"Standard_GS4\"\n | \"Standard_GS5\"\n | \"Standard_GS4-8\"\n | \"Standard_GS4-4\"\n | \"Standard_GS5-16\"\n | \"Standard_GS5-8\"\n | \"Standard_H8\"\n | \"Standard_H16\"\n | \"Standard_H8m\"\n | \"Standard_H16m\"\n | \"Standard_H16r\"\n | \"Standard_H16mr\"\n | \"Standard_L4s\"\n | \"Standard_L8s\"\n | \"Standard_L16s\"\n | \"Standard_L32s\"\n | \"Standard_M64s\"\n | \"Standard_M64ms\"\n | \"Standard_M128s\"\n | \"Standard_M128ms\"\n | \"Standard_M64-32ms\"\n | \"Standard_M64-16ms\"\n | \"Standard_M128-64ms\"\n | \"Standard_M128-32ms\"\n | \"Standard_NC6\"\n | \"Standard_NC12\"\n | \"Standard_NC24\"\n | \"Standard_NC24r\"\n | \"Standard_NC6s_v2\"\n | \"Standard_NC12s_v2\"\n | \"Standard_NC24s_v2\"\n | \"Standard_NC24rs_v2\"\n | \"Standard_NC6s_v3\"\n | \"Standard_NC12s_v3\"\n | \"Standard_NC24s_v3\"\n | \"Standard_NC24rs_v3\"\n | \"Standard_ND6s\"\n | \"Standard_ND12s\"\n | \"Standard_ND24s\"\n | \"Standard_ND24rs\"\n | \"Standard_NV6\"\n | \"Standard_NV12\"\n | \"Standard_NV24\";\n /** Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. <br><br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */\n vmSizeProperties?: VMSizeProperties;\n}\n\n/** Specifies the storage settings for the virtual machine disks. */\nexport interface StorageProfile {\n /** 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. */\n imageReference?: ImageReference;\n /** Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n osDisk?: OSDisk;\n /** Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n dataDisks?: Array<DataDisk>;\n /** Specifies the disk controller type configured for the VM. <br><br>NOTE: This property will be set to the default disk controller type if not specified provided virtual machine is being created as a hyperVGeneration: V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. <br>You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. <br><br> Minimum api-version: 2022-08-01 */\n diskControllerType?: \"SCSI\" | \"NVMe\";\n}\n\n/** Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\nexport interface OSDisk {\n /** 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. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType?: \"Windows\" | \"Linux\";\n /** Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15 */\n encryptionSettings?: DiskEncryptionSettings;\n /** The disk name. */\n name?: string;\n /** The virtual hard disk. */\n vhd?: VirtualHardDisk;\n /** 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. */\n image?: VirtualHardDisk;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None** for Standard storage. **ReadOnly** for Premium storage. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */\n diffDiskSettings?: DiffDiskSettings;\n /** Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The managed disk parameters. */\n managedDisk?: ManagedDiskParameters;\n /** Specifies whether OS Disk should be deleted or detached upon VM deletion. <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the os disk is retained after VM is deleted. <br><br> The default value is set to **detach**. For an ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for ephemeral OS Disk. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** The parameters of a managed disk. */\nexport interface ManagedDiskParameters extends SubResource {\n /** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */\n storageAccountType?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n /** Specifies the customer managed disk encryption set resource id for the managed disk. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n /** Specifies the security profile for the managed disk. */\n securityProfile?: VMDiskSecurityProfile;\n}\n\n/** Describes a data disk. */\nexport interface DataDisk {\n /** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */\n lun: number;\n /** The disk name. */\n name?: string;\n /** The virtual hard disk. */\n vhd?: VirtualHardDisk;\n /** 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. */\n image?: VirtualHardDisk;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The managed disk parameters. */\n managedDisk?: ManagedDiskParameters;\n /** Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset */\n toBeDetached?: boolean;\n /** 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: **ForceDetach**. <br><br> 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. <br><br> 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'. */\n detachOption?: \"ForceDetach\";\n /** Specifies whether data disk should be deleted or detached upon VM deletion.<br><br> Possible values: <br><br> **Delete** If this value is used, the data disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the data disk is retained after VM is deleted.<br><br> The default value is set to **detach** */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. */\nexport interface OSProfile {\n /** Specifies the host OS name of the virtual machine. <br><br> This name cannot be updated after the VM is created. <br><br> **Max-length (Windows):** 15 characters <br><br> **Max-length (Linux):** 64 characters. <br><br> For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). */\n computerName?: string;\n /** Specifies the name of the administrator account. <br><br> This property cannot be updated after the VM is created. <br><br> **Windows-only restriction:** Cannot end in \".\" <br><br> **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters. */\n adminUsername?: string;\n /** Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\\W_]) <br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */\n adminPassword?: string;\n /** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> **Note: Do not pass any secrets or passwords in customData property** <br><br> This property cannot be updated after the VM is created. <br><br> customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/) <br><br> For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) */\n customData?: string;\n /** Specifies Windows operating system settings on the virtual machine. */\n windowsConfiguration?: WindowsConfiguration;\n /** Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */\n linuxConfiguration?: LinuxConfiguration;\n /** Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n secrets?: Array<VaultSecretGroup>;\n /** Specifies whether extension operations should be allowed on the virtual machine. <br><br>This may only be set to False when no extensions are present on the virtual machine. */\n allowExtensionOperations?: boolean;\n /** Optional property which must either be set to True or omitted. */\n requireGuestProvisionSignal?: boolean;\n}\n\n/** Specifies the network interfaces or the networking configuration of the virtual machine. */\nexport interface NetworkProfile {\n /** Specifies the list of resource Ids for the network interfaces associated with the virtual machine. */\n networkInterfaces?: Array<NetworkInterfaceReference>;\n /** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations */\n networkApiVersion?: \"2020-11-01\";\n /** Specifies the networking configurations that will be used to create the virtual machine networking resources. */\n networkInterfaceConfigurations?: Array<VirtualMachineNetworkInterfaceConfiguration>;\n}\n\n/** Describes a network interface reference. */\nexport interface NetworkInterfaceReference extends SubResource {\n /** Describes a network interface reference properties. */\n properties?: NetworkInterfaceReferenceProperties;\n}\n\n/** Describes a network interface reference properties. */\nexport interface NetworkInterfaceReferenceProperties {\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machine network interface configurations. */\nexport interface VirtualMachineNetworkInterfaceConfiguration {\n /** The network interface configuration name. */\n name: string;\n /** Describes a virtual machine network profile's IP configuration. */\n properties?: VirtualMachineNetworkInterfaceConfigurationProperties;\n}\n\n/** Describes a virtual machine network profile's IP configuration. */\nexport interface VirtualMachineNetworkInterfaceConfigurationProperties {\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n /** Specifies whether the network interface is accelerated networking-enabled. */\n enableAcceleratedNetworking?: boolean;\n /** Specifies whether the network interface is disabled for tcp state tracking. */\n disableTcpStateTracking?: boolean;\n /** Specifies whether the network interface is FPGA networking-enabled. */\n enableFpga?: boolean;\n /** Whether IP forwarding enabled on this NIC. */\n enableIPForwarding?: boolean;\n /** The network security group. */\n networkSecurityGroup?: SubResource;\n /** The dns settings to be applied on the network interfaces. */\n dnsSettings?: VirtualMachineNetworkInterfaceDnsSettingsConfiguration;\n /** Specifies the IP configurations of the network interface. */\n ipConfigurations: Array<VirtualMachineNetworkInterfaceIPConfiguration>;\n dscpConfiguration?: SubResource;\n}\n\n/** Describes a virtual machines network configuration's DNS settings. */\nexport interface VirtualMachineNetworkInterfaceDnsSettingsConfiguration {\n /** List of DNS servers IP addresses */\n dnsServers?: Array<string>;\n}\n\n/** Describes a virtual machine network profile's IP configuration. */\nexport interface VirtualMachineNetworkInterfaceIPConfiguration {\n /** The IP configuration name. */\n name: string;\n /** Describes a virtual machine network interface IP configuration properties. */\n properties?: VirtualMachineNetworkInterfaceIPConfigurationProperties;\n}\n\n/** Describes a virtual machine network interface IP configuration properties. */\nexport interface VirtualMachineNetworkInterfaceIPConfigurationProperties {\n /** Specifies the identifier of the subnet. */\n subnet?: SubResource;\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** The publicIPAddressConfiguration. */\n publicIPAddressConfiguration?: VirtualMachinePublicIPAddressConfiguration;\n /** 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'. */\n privateIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specifies an array of references to application security group. */\n applicationSecurityGroups?: Array<SubResource>;\n /** Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. */\n applicationGatewayBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. */\n loadBalancerBackendAddressPools?: Array<SubResource>;\n}\n\n/** Describes a virtual machines IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachinePublicIPAddressConfiguration {\n /** The publicIP address configuration name. */\n name: string;\n /** Describes a virtual machines IP Configuration's PublicIPAddress configuration */\n properties?: VirtualMachinePublicIPAddressConfigurationProperties;\n /** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */\n sku?: PublicIPAddressSku;\n}\n\n/** Describes a virtual machines IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachinePublicIPAddressConfigurationProperties {\n /** The idle timeout of the public IP address. */\n idleTimeoutInMinutes?: number;\n /** Specify what happens to the public IP address when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n /** The dns settings to be applied on the publicIP addresses . */\n dnsSettings?: VirtualMachinePublicIPAddressDnsSettingsConfiguration;\n /** The list of IP tags associated with the public IP address. */\n ipTags?: Array<VirtualMachineIpTag>;\n /** The PublicIPPrefix from which to allocate publicIP addresses. */\n publicIPPrefix?: SubResource;\n /** 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'. */\n publicIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specify the public IP allocation type */\n publicIPAllocationMethod?: \"Dynamic\" | \"Static\";\n}\n\n/** Describes a virtual machines network configuration's DNS settings. */\nexport interface VirtualMachinePublicIPAddressDnsSettingsConfiguration {\n /** The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. */\n domainNameLabel: string;\n}\n\n/** Contains the IP tag associated with the public IP address. */\nexport interface VirtualMachineIpTag {\n /** IP tag type. Example: FirstPartyUsage. */\n ipTagType?: string;\n /** IP tag associated with the public IP. Example: SQL, Storage etc. */\n tag?: string;\n}\n\n/** Describes a virtual machine scale set VM network profile. */\nexport interface VirtualMachineScaleSetVMNetworkProfileConfiguration {\n /** The list of network configurations. */\n networkInterfaceConfigurations?: Array<VirtualMachineScaleSetNetworkConfiguration>;\n}\n\n/** The protection policy of a virtual machine scale set VM. */\nexport interface VirtualMachineScaleSetVMProtectionPolicy {\n /** Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. */\n protectFromScaleIn?: boolean;\n /** Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. */\n protectFromScaleSetActions?: boolean;\n}\n\n/** Describes a Virtual Machine Extension. */\nexport interface VirtualMachineExtension extends ResourceWithOptionalLocation {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionProperties;\n}\n\n/** The Resource model definition with location property as optional. */\nexport interface ResourceWithOptionalLocation {\n /** Resource location */\n location?: string;\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Identity for the virtual machine. */\nexport interface VirtualMachineIdentity {\n /** The type of identity used for the virtual machine. 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. */\n type?: \"SystemAssigned\" | \"UserAssigned\" | \"SystemAssigned, UserAssigned\" | \"None\";\n /** The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */\n userAssignedIdentities?: Record<string, UserAssignedIdentitiesValue>;\n}\n\n/** Describes a Virtual Machine Extension. */\nexport interface VirtualMachineExtensionUpdate extends UpdateResource {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionUpdateProperties;\n}\n\n/** Describes a Virtual Machine. */\nexport interface VirtualMachine extends Resource {\n /** 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**. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine. */\n properties?: VirtualMachineProperties;\n /** The identity of the virtual machine, if configured. */\n identity?: VirtualMachineIdentity;\n /** The virtual machine zones. */\n zones?: Array<string>;\n /** The extended location of the Virtual Machine. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** Describes the properties of a Virtual Machine. */\nexport interface VirtualMachineProperties {\n /** Specifies the hardware settings for the virtual machine. */\n hardwareProfile?: HardwareProfile;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: StorageProfile;\n /** Specifies additional capabilities enabled or disabled on the virtual machine. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. */\n osProfile?: OSProfile;\n /** Specifies the network interfaces of the virtual machine. */\n networkProfile?: NetworkProfile;\n /** Specifies the Security related profile settings for the virtual machine. */\n securityProfile?: SecurityProfile;\n /** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. */\n availabilitySet?: SubResource;\n /** Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01 */\n virtualMachineScaleSet?: SubResource;\n /** Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n /** Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01 */\n priority?: \"Regular\" | \"Low\" | \"Spot\";\n /** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */\n evictionPolicy?: \"Deallocate\" | \"Delete\";\n /** Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01. */\n billingProfile?: BillingProfile;\n /** Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01. */\n host?: SubResource;\n /** Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties. */\n hostGroup?: SubResource;\n /** Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15 */\n licenseType?: string;\n /** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01 */\n extensionsTimeBudget?: string;\n /** Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01 */\n platformFaultDomain?: number;\n /** Specifies Scheduled Event related configurations. */\n scheduledEventsProfile?: ScheduledEventsProfile;\n /** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n /** Specifies information about the capacity reservation that is used to allocate virtual machine. <br><br>Minimum api-version: 2021-04-01. */\n capacityReservation?: CapacityReservationProfile;\n /** Specifies the gallery applications that should be made available to the VM/VMSS */\n applicationProfile?: ApplicationProfile;\n}\n\n/** The instance view of a virtual machine. */\nexport interface VirtualMachineInstanceView {\n /** Specifies the update domain of the virtual machine. */\n platformUpdateDomain?: number;\n /** Specifies the fault domain of the virtual machine. */\n platformFaultDomain?: number;\n /** The computer name assigned to the virtual machine. */\n computerName?: string;\n /** The Operating System running on the virtual machine. */\n osName?: string;\n /** The version of Operating System running on the virtual machine. */\n osVersion?: string;\n /** Specifies the HyperVGeneration Type associated with a resource */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** The Remote desktop certificate thumbprint. */\n rdpThumbPrint?: string;\n /** The VM Agent running on the virtual machine. */\n vmAgent?: VirtualMachineAgentInstanceView;\n /** The Maintenance Operation status on the virtual machine. */\n maintenanceRedeployStatus?: MaintenanceRedeployStatus;\n /** The virtual machine disk information. */\n disks?: Array<DiskInstanceView>;\n /** The extensions information. */\n extensions?: Array<VirtualMachineExtensionInstanceView>;\n /** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\n bootDiagnostics?: BootDiagnosticsInstanceView;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n /** [Preview Feature] The status of virtual machine patch operations. */\n patchStatus?: VirtualMachinePatchStatus;\n}\n\n/** The status of virtual machine patch operations. */\nexport interface VirtualMachinePatchStatus {\n /** The available patch summary of the latest assessment operation for the virtual machine. */\n availablePatchSummary?: AvailablePatchSummary;\n /** The installation summary of the latest installation operation for the virtual machine. */\n lastPatchInstallationSummary?: LastPatchInstallationSummary;\n}\n\n/** Describes the properties of an virtual machine instance view for available patch summary. */\nexport interface AvailablePatchSummary {}\n\n/** Describes the properties of the last installed patch summary. */\nexport interface LastPatchInstallationSummary {}\n\n/** Capture Virtual Machine parameters. */\nexport interface VirtualMachineCaptureParameters {\n /** The captured virtual hard disk's name prefix. */\n vhdPrefix: string;\n /** The destination container name. */\n destinationContainerName: string;\n /** Specifies whether to overwrite the destination virtual hard disk, in case of conflict. */\n overwriteVhds: boolean;\n}\n\n/** Output of virtual machine capture operation. */\nexport interface VirtualMachineCaptureResult extends SubResource {}\n\n/** Describes a Virtual Machine Update. */\nexport interface VirtualMachineUpdate extends UpdateResource {\n /** 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**. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine. */\n properties?: VirtualMachineProperties;\n /** The identity of the virtual machine, if configured. */\n identity?: VirtualMachineIdentity;\n /** The virtual machine zones. */\n zones?: Array<string>;\n}\n\n/** Input for InstallPatches as directly received by the API */\nexport interface VirtualMachineInstallPatchesParameters {\n /** Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) */\n maximumDuration?: string;\n /** Defines when it is acceptable to reboot a VM during a software update operation. */\n rebootSetting: \"IfRequired\" | \"Never\" | \"Always\";\n /** Input for InstallPatches on a Windows VM, as directly received by the API */\n windowsParameters?: WindowsParameters;\n /** Input for InstallPatches on a Linux VM, as directly received by the API */\n linuxParameters?: LinuxParameters;\n}\n\n/** Input for InstallPatches on a Windows VM, as directly received by the API */\nexport interface WindowsParameters {\n /** The update classifications to select when installing patches for Windows. */\n classificationsToInclude?: Array<\n | \"Critical\"\n | \"Security\"\n | \"UpdateRollUp\"\n | \"FeaturePack\"\n | \"ServicePack\"\n | \"Definition\"\n | \"Tools\"\n | \"Updates\"\n >;\n /** Kbs to include in the patch operation */\n kbNumbersToInclude?: Array<string>;\n /** Kbs to exclude in the patch operation */\n kbNumbersToExclude?: Array<string>;\n /** Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. */\n excludeKbsRequiringReboot?: boolean;\n /** This is used to install patches that were published on or before this given max published date. */\n maxPatchPublishDate?: Date | string;\n}\n\n/** Input for InstallPatches on a Linux VM, as directly received by the API */\nexport interface LinuxParameters {\n /** The update classifications to select when installing patches for Linux. */\n classificationsToInclude?: Array<\"Critical\" | \"Security\" | \"Other\">;\n /** packages to include in the patch operation. Format: packageName_packageVersion */\n packageNameMasksToInclude?: Array<string>;\n /** packages to exclude in the patch operation. Format: packageName_packageVersion */\n packageNameMasksToExclude?: Array<string>;\n /** This is used as a maintenance run identifier for Auto VM Guest Patching in Linux. */\n maintenanceRunId?: string;\n}\n\n/** Describes a Virtual Machine Image. */\nexport interface VirtualMachineImage extends VirtualMachineImageResource {\n /** Describes the properties of a Virtual Machine Image. */\n properties?: VirtualMachineImageProperties;\n}\n\n/** Describes the properties of a Virtual Machine Image. */\nexport interface VirtualMachineImageProperties {\n /** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */\n plan?: PurchasePlan;\n /** Contains the os disk image information. */\n osDiskImage?: OSDiskImage;\n dataDiskImages?: Array<DataDiskImage>;\n /** Describes automatic OS upgrade properties on the image. */\n automaticOSUpgradeProperties?: AutomaticOSUpgradeProperties;\n /** Specifies the HyperVGeneration Type */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** Specifies disallowed configuration for the VirtualMachine created from the image */\n disallowed?: DisallowedConfiguration;\n features?: Array<VirtualMachineImageFeature>;\n /** Specifies the Architecture Type */\n architecture?: \"x64\" | \"Arm64\";\n}\n\n/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */\nexport interface PurchasePlan {\n /** The publisher ID. */\n publisher: string;\n /** The plan ID. */\n name: string;\n /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */\n product: string;\n}\n\n/** Contains the os disk image information. */\nexport interface OSDiskImage {\n /** The operating system of the osDiskImage. */\n operatingSystem: \"Windows\" | \"Linux\";\n}\n\n/** Contains the data disk images information. */\nexport interface DataDiskImage {}\n\n/** Describes automatic OS upgrade properties on the image. */\nexport interface AutomaticOSUpgradeProperties {\n /** Specifies whether automatic OS upgrade is supported on the image. */\n automaticOSUpgradeSupported: boolean;\n}\n\n/** Specifies the disallowed configuration for a virtual machine image. */\nexport interface DisallowedConfiguration {\n /** VM disk types which are disallowed. */\n vmDiskType?: \"None\" | \"Unmanaged\";\n}\n\n/** Specifies additional capabilities supported by the image */\nexport interface VirtualMachineImageFeature {\n /** The name of the feature. */\n name?: string;\n /** The corresponding value for the feature. */\n value?: string;\n}\n\n/** Virtual machine image resource information. */\nexport interface VirtualMachineImageResource extends SubResource {\n /** The name of the resource. */\n name: string;\n /** The supported Azure location of the resource. */\n location: string;\n /** Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). */\n tags?: Record<string, string>;\n /** The extended location of the Virtual Machine. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** Describes a Virtual Machine Extension Image. */\nexport interface VirtualMachineExtensionImage extends Resource {\n /** Describes the properties of a Virtual Machine Extension Image. */\n properties?: VirtualMachineExtensionImageProperties;\n}\n\n/** Describes the properties of a Virtual Machine Extension Image. */\nexport interface VirtualMachineExtensionImageProperties {\n /** The operating system this extension supports. */\n operatingSystem: string;\n /** The type of role (IaaS or PaaS) this extension supports. */\n computeRole: string;\n /** The schema defined by publisher, where extension consumers should provide settings in a matching schema. */\n handlerSchema: string;\n /** Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. */\n vmScaleSetEnabled?: boolean;\n /** Whether the handler can support multiple extensions. */\n supportsMultipleExtensions?: boolean;\n}\n\n/** 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. */\nexport interface AvailabilitySet extends Resource {\n /** The instance view of a resource. */\n properties?: AvailabilitySetProperties;\n /** Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. */\n sku?: Sku;\n}\n\n/** The instance view of a resource. */\nexport interface AvailabilitySetProperties {\n /** Update Domain count. */\n platformUpdateDomainCount?: number;\n /** Fault Domain count. */\n platformFaultDomainCount?: number;\n /** A list of references to all virtual machines in the availability set. */\n virtualMachines?: Array<SubResource>;\n /** Specifies information about the proximity placement group that the availability set should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n}\n\n/** Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated. */\nexport interface AvailabilitySetUpdate extends UpdateResource {\n /** The instance view of a resource. */\n properties?: AvailabilitySetProperties;\n /** Sku of the availability set */\n sku?: Sku;\n}\n\n/** Specifies information about the proximity placement group. */\nexport interface ProximityPlacementGroup extends Resource {\n /** Describes the properties of a Proximity Placement Group. */\n properties?: ProximityPlacementGroupProperties;\n /** Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. */\n zones?: Array<string>;\n}\n\n/** Describes the properties of a Proximity Placement Group. */\nexport interface ProximityPlacementGroupProperties {\n /** Specifies the type of the proximity placement group. <br><br> Possible values are: <br><br> **Standard** : Co-locate resources within an Azure region or Availability Zone. <br><br> **Ultra** : For future use. */\n proximityPlacementGroupType?: \"Standard\" | \"Ultra\";\n /** Describes colocation status of the Proximity Placement Group. */\n colocationStatus?: InstanceViewStatus;\n /** Specifies the user intent of the proximity placement group. */\n intent?: ProximityPlacementGroupPropertiesIntent;\n}\n\nexport interface SubResourceWithColocationStatus extends SubResource {\n /** Describes colocation status of a resource in the Proximity Placement Group. */\n colocationStatus?: InstanceViewStatus;\n}\n\n/** Specifies the user intent of the proximity placement group. */\nexport interface ProximityPlacementGroupPropertiesIntent {\n /** Specifies possible sizes of virtual machines that can be created in the proximity placement group. */\n vmSizes?: Array<string>;\n}\n\n/** Specifies information about the proximity placement group. */\nexport interface ProximityPlacementGroupUpdate extends UpdateResource {}\n\n/** Specifies information about the dedicated host group that the dedicated hosts should be assigned to. <br><br> 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. */\nexport interface DedicatedHostGroup extends Resource {\n /** Dedicated Host Group Properties. */\n properties?: DedicatedHostGroupProperties;\n /** Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. */\n zones?: Array<string>;\n}\n\n/** Dedicated Host Group Properties. */\nexport interface DedicatedHostGroupProperties {\n /** Number of fault domains that the host group can span. */\n platformFaultDomainCount: number;\n /** Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. <br><br>Minimum api-version: 2020-06-01. */\n supportAutomaticPlacement?: boolean;\n /** Enables or disables a capability on the dedicated host group.<br><br>Minimum api-version: 2022-03-01. */\n additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities;\n}\n\nexport interface DedicatedHostGroupInstanceView {\n /** List of instance view of the dedicated hosts under the dedicated host group. */\n hosts?: Array<DedicatedHostInstanceViewWithName>;\n}\n\n/** 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. */\nexport interface DedicatedHostInstanceViewWithName extends DedicatedHostInstanceView {}\n\n/** The instance view of a dedicated host. */\nexport interface DedicatedHostInstanceView {\n /** Unutilized capacity of the dedicated host. */\n availableCapacity?: DedicatedHostAvailableCapacity;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Dedicated host unutilized capacity. */\nexport interface DedicatedHostAvailableCapacity {\n /** The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. */\n allocatableVMs?: Array<DedicatedHostAllocatableVM>;\n}\n\n/** Represents the dedicated host unutilized capacity in terms of a specific VM size. */\nexport interface DedicatedHostAllocatableVM {\n /** VM size in terms of which the unutilized capacity is represented. */\n vmSize?: string;\n /** Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. */\n count?: number;\n}\n\n/** Enables or disables a capability on the dedicated host group.<br><br>Minimum api-version: 2022-03-01. */\nexport interface DedicatedHostGroupPropertiesAdditionalCapabilities {\n /** The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. <br><br>NOTE: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. <br><br>Minimum api-version: 2022-03-01. */\n ultraSSDEnabled?: boolean;\n}\n\n/** Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated. */\nexport interface DedicatedHostGroupUpdate extends UpdateResource {\n /** Dedicated Host Group Properties. */\n properties?: DedicatedHostGroupProperties;\n /** Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. */\n zones?: Array<string>;\n}\n\n/** Specifies information about the Dedicated host. */\nexport interface DedicatedHost extends Resource {\n /** Properties of the dedicated host. */\n properties?: DedicatedHostProperties;\n /** SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. */\n sku: Sku;\n}\n\n/** Properties of the dedicated host. */\nexport interface DedicatedHostProperties {\n /** Fault domain of the dedicated host within a dedicated host group. */\n platformFaultDomain?: number;\n /** Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. */\n autoReplaceOnFailure?: boolean;\n /** Specifies the software license type that will be applied to the VMs deployed on the dedicated host. <br><br> Possible values are: <br><br> **None** <br><br> **Windows_Server_Hybrid** <br><br> **Windows_Server_Perpetual** <br><br> Default: **None** */\n licenseType?: \"None\" | \"Windows_Server_Hybrid\" | \"Windows_Server_Perpetual\";\n}\n\n/** Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated. */\nexport interface DedicatedHostUpdate extends UpdateResource {\n /** Properties of the dedicated host. */\n properties?: DedicatedHostProperties;\n}\n\n/** Specifies information about the SSH public key. */\nexport interface SshPublicKeyResource extends Resource {\n /** Properties of the SSH public key. */\n properties?: SshPublicKeyResourceProperties;\n}\n\n/** Properties of the SSH public key. */\nexport interface SshPublicKeyResourceProperties {\n /** SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. */\n publicKey?: string;\n}\n\n/** Specifies information about the SSH public key. */\nexport interface SshPublicKeyUpdateResource extends UpdateResource {\n /** Properties of the SSH public key. */\n properties?: SshPublicKeyResourceProperties;\n}\n\n/** 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. */\nexport interface Image extends Resource {\n /** Describes the properties of an Image. */\n properties?: ImageProperties;\n /** The extended location of the Image. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** Describes the properties of an Image. */\nexport interface ImageProperties {\n /** The source virtual machine from which Image is created. */\n sourceVirtualMachine?: SubResource;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: ImageStorageProfile;\n /** Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. */\n hyperVGeneration?: \"V1\" | \"V2\";\n}\n\n/** Describes a storage profile. */\nexport interface ImageStorageProfile {\n /** Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n osDisk?: ImageOSDisk;\n /** Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n dataDisks?: Array<ImageDataDisk>;\n /** Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). */\n zoneResilient?: boolean;\n}\n\n/** Describes an Operating System disk. */\nexport interface ImageOSDisk extends ImageDisk {\n /** This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType: \"Windows\" | \"Linux\";\n /** The OS State. For managed images, use Generalized. */\n osState: \"Generalized\" | \"Specialized\";\n}\n\n/** Describes a image disk. */\nexport interface ImageDisk {\n /** The snapshot. */\n snapshot?: SubResource;\n /** The managedDisk. */\n managedDisk?: SubResource;\n /** The Virtual Hard Disk. */\n blobUri?: string;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB */\n diskSizeGB?: number;\n /** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */\n storageAccountType?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n /** Specifies the customer managed disk encryption set resource id for the managed image disk. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n}\n\n/** Describes a data disk. */\nexport interface ImageDataDisk extends ImageDisk {\n /** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */\n lun: number;\n}\n\n/** The source user image virtual hard disk. Only tags may be updated. */\nexport interface ImageUpdate extends UpdateResource {\n /** Describes the properties of an Image. */\n properties?: ImageProperties;\n}\n\n/** Create or update Restore Point collection parameters. */\nexport interface RestorePointCollection extends Resource {\n /** The restore point collection properties. */\n properties?: RestorePointCollectionProperties;\n}\n\n/** The restore point collection properties. */\nexport interface RestorePointCollectionProperties {\n /** The properties of the source resource that this restore point collection is created from. */\n source?: RestorePointCollectionSourceProperties;\n}\n\n/** The properties of the source resource that this restore point collection is created from. */\nexport interface RestorePointCollectionSourceProperties {\n /** Resource Id of the source resource used to create this restore point collection */\n id?: string;\n}\n\n/** Restore Point details. */\nexport interface RestorePoint extends ProxyResource {\n /** The restore point properties. */\n properties?: RestorePointProperties;\n}\n\n/** The restore point properties. */\nexport interface RestorePointProperties {\n /** List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. */\n excludeDisks?: Array<ApiEntityReference>;\n /** 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. */\n consistencyMode?: \"CrashConsistent\" | \"FileSystemConsistent\" | \"ApplicationConsistent\";\n /** Gets the creation time of the restore point. */\n timeCreated?: Date | string;\n /** Resource Id of the source restore point from which a copy needs to be created. */\n sourceRestorePoint?: ApiEntityReference;\n}\n\n/** 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. */\nexport interface RestorePointSourceMetadata {\n /** Gets the hardware profile. */\n hardwareProfile?: HardwareProfile;\n /** Gets the storage profile. */\n storageProfile?: RestorePointSourceVMStorageProfile;\n /** Gets the OS profile. */\n osProfile?: OSProfile;\n /** Gets the diagnostics profile. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** Gets the license type, which is for bring your own license scenario. */\n licenseType?: string;\n /** Gets the virtual machine unique id. */\n vmId?: string;\n /** Gets the security profile. */\n securityProfile?: SecurityProfile;\n /** Location of the VM from which the restore point was created. */\n location?: string;\n}\n\n/** Describes the storage profile. */\nexport interface RestorePointSourceVMStorageProfile {\n /** Gets the OS disk of the VM captured at the time of the restore point creation. */\n osDisk?: RestorePointSourceVmosDisk;\n /** Gets the data disks of the VM captured at the time of the restore point creation. */\n dataDisks?: Array<RestorePointSourceVMDataDisk>;\n}\n\n/** Describes an Operating System disk. */\nexport interface RestorePointSourceVmosDisk {\n /** Gets the Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** Gets the disk encryption settings. */\n encryptionSettings?: DiskEncryptionSettings;\n /** Gets the disk name. */\n name?: string;\n /** Gets the caching type. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Gets the disk size in GB. */\n diskSizeGB?: number;\n /** Gets the managed disk details */\n managedDisk?: ManagedDiskParameters;\n /** Gets the disk restore point Id. */\n diskRestorePoint?: ApiEntityReference;\n}\n\n/** Describes a data disk. */\nexport interface RestorePointSourceVMDataDisk {\n /** Gets the logical unit number. */\n lun?: number;\n /** Gets the disk name. */\n name?: string;\n /** Gets the caching type. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. */\n diskSizeGB?: number;\n /** Gets the managed disk details */\n managedDisk?: ManagedDiskParameters;\n /** Gets the disk restore point Id. */\n diskRestorePoint?: ApiEntityReference;\n}\n\n/** The instance view of a restore point. */\nexport interface RestorePointInstanceView {\n /** The disk restore points information. */\n diskRestorePoints?: Array<DiskRestorePointInstanceView>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** The instance view of a disk restore point. */\nexport interface DiskRestorePointInstanceView {\n /** Disk restore point Id. */\n id?: string;\n /** The disk restore point replication status information. */\n replicationStatus?: DiskRestorePointReplicationStatus;\n}\n\n/** The instance view of a disk restore point. */\nexport interface DiskRestorePointReplicationStatus {\n /** The resource status information. */\n status?: InstanceViewStatus;\n /** Replication completion percentage. */\n completionPercent?: number;\n}\n\n/** The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location */\nexport interface ProxyResource {}\n\n/** Update Restore Point collection parameters. */\nexport interface RestorePointCollectionUpdate extends UpdateResource {\n /** The restore point collection properties. */\n properties?: RestorePointCollectionProperties;\n}\n\n/** Specifies information about the capacity reservation group that the capacity reservations should be assigned to. <br><br> 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. */\nexport interface CapacityReservationGroup extends Resource {\n /** capacity reservation group Properties. */\n properties?: CapacityReservationGroupProperties;\n /** Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. */\n zones?: Array<string>;\n}\n\n/** capacity reservation group Properties. */\nexport interface CapacityReservationGroupProperties {}\n\nexport interface CapacityReservationGroupInstanceView {}\n\n/** 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. */\nexport interface CapacityReservationInstanceViewWithName extends CapacityReservationInstanceView {}\n\n/** 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. */\nexport interface CapacityReservationInstanceView {\n /** Unutilized capacity of the capacity reservation. */\n utilizationInfo?: CapacityReservationUtilization;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Represents the capacity reservation utilization in terms of resources allocated. */\nexport interface CapacityReservationUtilization {}\n\n/** Specifies information about the capacity reservation group. Only tags can be updated. */\nexport interface CapacityReservationGroupUpdate extends UpdateResource {\n /** capacity reservation group Properties. */\n properties?: CapacityReservationGroupProperties;\n}\n\n/** Specifies information about the capacity reservation. */\nexport interface CapacityReservation extends Resource {\n /** Properties of the Capacity reservation. */\n properties?: CapacityReservationProperties;\n /** SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. */\n sku: Sku;\n /** Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. */\n zones?: Array<string>;\n}\n\n/** Properties of the Capacity reservation. */\nexport interface CapacityReservationProperties {}\n\n/** Specifies information about the capacity reservation. Only tags and sku.capacity can be updated. */\nexport interface CapacityReservationUpdate extends UpdateResource {\n /** Properties of the Capacity reservation. */\n properties?: CapacityReservationProperties;\n /** SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. */\n sku?: Sku;\n}\n\n/** Api request input for LogAnalytics getRequestRateByInterval Api. */\nexport interface RequestRateByIntervalInput extends LogAnalyticsInputBase {\n /** Interval value in minutes used to create LogAnalytics call rate logs. */\n intervalLength: \"ThreeMins\" | \"FiveMins\" | \"ThirtyMins\" | \"SixtyMins\";\n}\n\n/** Api input base class for LogAnalytics Api. */\nexport interface LogAnalyticsInputBase {\n /** SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. */\n blobContainerSasUri: string;\n /** From time of the query */\n fromTime: Date | string;\n /** To time of the query */\n toTime: Date | string;\n /** Group query result by Throttle Policy applied. */\n groupByThrottlePolicy?: boolean;\n /** Group query result by Operation Name. */\n groupByOperationName?: boolean;\n /** Group query result by Resource Name. */\n groupByResourceName?: boolean;\n /** Group query result by Client Application ID. */\n groupByClientApplicationId?: boolean;\n /** Group query result by User Agent. */\n groupByUserAgent?: boolean;\n}\n\n/** Api request input for LogAnalytics getThrottledRequests Api. */\nexport interface ThrottledRequestsInput extends LogAnalyticsInputBase {}\n\n/** Capture Virtual Machine parameters. */\nexport interface RunCommandInput {\n /** The run command id. */\n commandId: string;\n /** Optional. The script to be executed. When this value is given, the given script will override the default script of the command. */\n script?: Array<string>;\n /** The run command parameters. */\n parameters?: Array<RunCommandInputParameter>;\n}\n\n/** Describes the properties of a run command parameter. */\nexport interface RunCommandInputParameter {\n /** The run command parameter name. */\n name: string;\n /** The run command parameter value. */\n value: string;\n}\n\n/** Describes a Virtual Machine run command. */\nexport interface VirtualMachineRunCommand extends Resource {\n /** Describes the properties of a Virtual Machine run command. */\n properties?: VirtualMachineRunCommandProperties;\n}\n\n/** Describes the properties of a Virtual Machine run command. */\nexport interface VirtualMachineRunCommandProperties {\n /** The source of the run command script. */\n source?: VirtualMachineRunCommandScriptSource;\n /** The parameters used by the script. */\n parameters?: Array<RunCommandInputParameter>;\n /** The parameters used by the script. */\n protectedParameters?: Array<RunCommandInputParameter>;\n /** Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. */\n asyncExecution?: boolean;\n /** Specifies the user account on the VM when executing the run command. */\n runAsUser?: string;\n /** Specifies the user account password on the VM when executing the run command. */\n runAsPassword?: string;\n /** The timeout in seconds to execute the run command. */\n timeoutInSeconds?: number;\n /** Specifies the Azure storage blob where script output stream will be uploaded. */\n outputBlobUri?: string;\n /** Specifies the Azure storage blob where script error stream will be uploaded. */\n errorBlobUri?: string;\n}\n\n/** Describes the script sources for run command. */\nexport interface VirtualMachineRunCommandScriptSource {\n /** Specifies the script content to be executed on the VM. */\n script?: string;\n /** Specifies the script download location. */\n scriptUri?: string;\n /** Specifies a commandId of predefined built-in script. */\n commandId?: string;\n}\n\n/** The instance view of a virtual machine run command. */\nexport interface VirtualMachineRunCommandInstanceView {\n /** Script execution status. */\n executionState?:\n | \"Unknown\"\n | \"Pending\"\n | \"Running\"\n | \"Failed\"\n | \"Succeeded\"\n | \"TimedOut\"\n | \"Canceled\";\n /** Communicate script configuration errors or execution messages. */\n executionMessage?: string;\n /** Exit code returned from script execution. */\n exitCode?: number;\n /** Script output stream. */\n output?: string;\n /** Script error stream. */\n error?: string;\n /** Script start time. */\n startTime?: Date | string;\n /** Script end time. */\n endTime?: Date | string;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Describes a Virtual Machine run command. */\nexport interface VirtualMachineRunCommandUpdate extends UpdateResource {\n /** Describes the properties of a Virtual Machine run command. */\n properties?: VirtualMachineRunCommandProperties;\n}\n\n/** Disk resource. */\nexport interface Disk extends Resource {\n /** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */\n sku?: DiskSku;\n /** The Logical zone list for Disk. */\n zones?: Array<string>;\n /** The extended location where the disk will be created. Extended location cannot be changed. */\n extendedLocation?: ExtendedLocation;\n /** Disk resource properties. */\n properties?: DiskProperties;\n}\n\n/** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */\nexport interface DiskSku {\n /** The sku name. */\n name?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n}\n\n/** Disk resource properties. */\nexport interface DiskProperties {\n /** The Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} */\n purchasePlan?: PurchasePlanAutoGenerated;\n /** List of supported capabilities for the image from which the OS disk was created. */\n supportedCapabilities?: SupportedCapabilities;\n /** Disk source information. CreationData information cannot be changed after the disk has been created. */\n creationData: CreationData;\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadWrite?: number;\n /** The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadWrite?: number;\n /** The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadOnly?: number;\n /** The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadOnly?: number;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. */\n maxShares?: number;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. */\n tier?: string;\n /** Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. */\n burstingEnabled?: boolean;\n /** Indicates the OS on a disk supports hibernation. */\n supportsHibernation?: boolean;\n /** Contains the security related information for the resource. */\n securityProfile?: DiskSecurityProfile;\n /** Percentage complete for the background copy when a resource is created via the CopyStart operation. */\n completionPercent?: number;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n /** Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. */\n optimizedForFrequentAttach?: boolean;\n}\n\n/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */\nexport interface PurchasePlanAutoGenerated {\n /** The plan ID. */\n name: string;\n /** The publisher ID. */\n publisher: string;\n /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */\n product: string;\n /** The Offer Promotion Code. */\n promotionCode?: string;\n}\n\n/** List of supported capabilities persisted on the disk resource for VM use. */\nexport interface SupportedCapabilities {\n /** The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. */\n diskControllerTypes?: string;\n /** True if the image from which the OS disk is created supports accelerated networking. */\n acceleratedNetwork?: boolean;\n /** CPU architecture supported by an OS disk. */\n architecture?: \"x64\" | \"Arm64\";\n}\n\n/** Data used when creating a disk. */\nexport interface CreationData {\n /** This enumerates the possible sources of a disk's creation. */\n createOption:\n | \"Empty\"\n | \"Attach\"\n | \"FromImage\"\n | \"Import\"\n | \"Copy\"\n | \"Restore\"\n | \"Upload\"\n | \"CopyStart\"\n | \"ImportSecure\"\n | \"UploadPreparedSecure\";\n /** Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. */\n storageAccountId?: string;\n /** Disk source information for PIR or user images. */\n imageReference?: ImageDiskReference;\n /** Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. */\n galleryImageReference?: ImageDiskReference;\n /** If createOption is Import, this is the URI of a blob to be imported into a managed disk. */\n sourceUri?: string;\n /** If createOption is Copy, this is the ARM id of the source snapshot or disk. */\n sourceResourceId?: string;\n /** If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer). */\n uploadSizeBytes?: number;\n /** Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. */\n logicalSectorSize?: number;\n /** If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. */\n securityDataUri?: string;\n /** Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled. */\n performancePlus?: boolean;\n}\n\n/** The source image used for creating the disk. */\nexport interface ImageDiskReference {\n /** A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. */\n id?: string;\n /** A relative uri containing a direct shared Azure Compute Gallery image reference. */\n sharedGalleryImageId?: string;\n /** A relative uri containing a community Azure Compute Gallery image reference. */\n communityGalleryImageId?: string;\n /** If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null. */\n lun?: number;\n}\n\n/** Encryption settings for disk or snapshot */\nexport interface EncryptionSettingsCollection {\n /** Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged. */\n enabled: boolean;\n /** A collection of encryption settings, one for each disk volume. */\n encryptionSettings?: Array<EncryptionSettingsElement>;\n /** Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption. */\n encryptionSettingsVersion?: string;\n}\n\n/** Encryption settings for one disk volume. */\nexport interface EncryptionSettingsElement {\n /** Key Vault Secret Url and vault id of the disk encryption key */\n diskEncryptionKey?: KeyVaultAndSecretReference;\n /** Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. */\n keyEncryptionKey?: KeyVaultAndKeyReference;\n}\n\n/** Key Vault Secret Url and vault id of the encryption key */\nexport interface KeyVaultAndSecretReference {\n /** Resource id of the KeyVault containing the key or secret */\n sourceVault: SourceVault;\n /** Url pointing to a key or secret in KeyVault */\n secretUrl: string;\n}\n\n/** The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} */\nexport interface SourceVault {\n /** Resource Id */\n id?: string;\n}\n\n/** Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey */\nexport interface KeyVaultAndKeyReference {\n /** Resource id of the KeyVault containing the key or secret */\n sourceVault: SourceVault;\n /** Url pointing to a key or secret in KeyVault */\n keyUrl: string;\n}\n\n/** Encryption at rest settings for disk or snapshot */\nexport interface Encryption {\n /** ResourceId of the disk encryption set to use for enabling encryption at rest. */\n diskEncryptionSetId?: string;\n /** The type of key used to encrypt the data of the disk. */\n type?:\n | \"EncryptionAtRestWithPlatformKey\"\n | \"EncryptionAtRestWithCustomerKey\"\n | \"EncryptionAtRestWithPlatformAndCustomerKeys\";\n}\n\nexport interface ShareInfoElement {}\n\n/** Properties of the disk for which update is pending. */\nexport interface PropertyUpdatesInProgress {\n /** The target performance tier of the disk if a tier change operation is in progress. */\n targetTier?: string;\n}\n\n/** Contains the security related information for the resource. */\nexport interface DiskSecurityProfile {\n /** Specifies the SecurityType of the VM. Applicable for OS disks only. */\n securityType?:\n | \"TrustedLaunch\"\n | \"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey\"\n | \"ConfidentialVM_DiskEncryptedWithPlatformKey\"\n | \"ConfidentialVM_DiskEncryptedWithCustomerKey\";\n /** ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key */\n secureVMDiskEncryptionSetId?: string;\n}\n\n/** Disk update resource. */\nexport interface DiskUpdate {\n /** Disk resource update properties. */\n properties?: DiskUpdateProperties;\n /** Resource tags */\n tags?: Record<string, string>;\n /** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */\n sku?: DiskSku;\n}\n\n/** Disk resource update properties. */\nexport interface DiskUpdateProperties {\n /** the Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadWrite?: number;\n /** The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadWrite?: number;\n /** The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadOnly?: number;\n /** The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadOnly?: number;\n /** The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. */\n maxShares?: number;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. */\n tier?: string;\n /** Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. */\n burstingEnabled?: boolean;\n /** Purchase plan information to be added on the OS disk */\n purchasePlan?: PurchasePlanAutoGenerated;\n /** List of supported capabilities to be added on the OS disk. */\n supportedCapabilities?: SupportedCapabilities;\n /** Indicates the OS on a disk supports hibernation. */\n supportsHibernation?: boolean;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n /** Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. */\n optimizedForFrequentAttach?: boolean;\n}\n\n/** Data used for requesting a SAS. */\nexport interface GrantAccessData {\n access: \"None\" | \"Read\" | \"Write\";\n /** Time duration in seconds until the SAS access expires. */\n durationInSeconds: number;\n /** Set this flag to true to get additional SAS for VM guest state */\n getSecureVMGuestStateSAS?: boolean;\n}\n\n/** disk access resource. */\nexport interface DiskAccess extends Resource {\n properties?: DiskAccessProperties;\n /** The extended location where the disk access will be created. Extended location cannot be changed. */\n extendedLocation?: ExtendedLocation;\n}\n\nexport interface DiskAccessProperties {}\n\n/** The Private Endpoint Connection resource. */\nexport interface PrivateEndpointConnection {\n /** Resource properties. */\n properties?: PrivateEndpointConnectionProperties;\n}\n\n/** Properties of the PrivateEndpointConnectProperties. */\nexport interface PrivateEndpointConnectionProperties {\n /** A collection of information about the state of the connection between DiskAccess and Virtual Network. */\n privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;\n}\n\n/** The Private Endpoint resource. */\nexport interface PrivateEndpoint {}\n\n/** A collection of information about the state of the connection between service consumer and provider. */\nexport interface PrivateLinkServiceConnectionState {\n /** Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */\n status?: \"Pending\" | \"Approved\" | \"Rejected\";\n /** The reason for approval/rejection of the connection. */\n description?: string;\n /** A message indicating if changes on the service provider require any updates on the consumer. */\n actionsRequired?: string;\n}\n\n/** Used for updating a disk access resource. */\nexport interface DiskAccessUpdate {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** disk encryption set resource. */\nexport interface DiskEncryptionSet extends Resource {\n /** 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. */\n identity?: EncryptionSetIdentity;\n properties?: EncryptionSetProperties;\n}\n\n/** 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. */\nexport interface EncryptionSetIdentity {\n /** 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. */\n type?: \"SystemAssigned\" | \"UserAssigned\" | \"SystemAssigned, UserAssigned\" | \"None\";\n /** The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */\n userAssignedIdentities?: Record<string, UserAssignedIdentitiesValue>;\n}\n\nexport interface EncryptionSetProperties {\n /** The type of key used to encrypt the data of the disk. */\n encryptionType?:\n | \"EncryptionAtRestWithCustomerKey\"\n | \"EncryptionAtRestWithPlatformAndCustomerKeys\"\n | \"ConfidentialVmEncryptedWithCustomerKey\";\n /** The key vault key which is currently used by this disk encryption set. */\n activeKey?: KeyForDiskEncryptionSet;\n /** Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. */\n rotationToLatestKeyVersionEnabled?: boolean;\n /** Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. */\n federatedClientId?: string;\n}\n\n/** Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */\nexport interface KeyForDiskEncryptionSet {\n /** Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. */\n sourceVault?: SourceVault;\n /** Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. */\n keyUrl: string;\n}\n\n/** disk encryption set update resource. */\nexport interface DiskEncryptionSetUpdate {\n /** disk encryption set resource update properties. */\n properties?: DiskEncryptionSetUpdateProperties;\n /** Resource tags */\n tags?: Record<string, string>;\n /** 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. */\n identity?: EncryptionSetIdentity;\n}\n\n/** disk encryption set resource update properties. */\nexport interface DiskEncryptionSetUpdateProperties {\n /** The type of key used to encrypt the data of the disk. */\n encryptionType?:\n | \"EncryptionAtRestWithCustomerKey\"\n | \"EncryptionAtRestWithPlatformAndCustomerKeys\"\n | \"ConfidentialVmEncryptedWithCustomerKey\";\n /** Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */\n activeKey?: KeyForDiskEncryptionSet;\n /** Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. */\n rotationToLatestKeyVersionEnabled?: boolean;\n /** Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. */\n federatedClientId?: string;\n}\n\n/** Snapshot resource. */\nexport interface Snapshot extends Resource {\n /** 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 */\n sku?: SnapshotSku;\n /** The extended location where the snapshot will be created. Extended location cannot be changed. */\n extendedLocation?: ExtendedLocation;\n /** Snapshot resource properties. */\n properties?: SnapshotProperties;\n}\n\n/** 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 */\nexport interface SnapshotSku {\n /** The sku name. */\n name?: \"Standard_LRS\" | \"Premium_LRS\" | \"Standard_ZRS\";\n}\n\n/** Snapshot resource properties. */\nexport interface SnapshotProperties {\n /** The Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** Purchase plan information for the image from which the source disk for the snapshot was originally created. */\n purchasePlan?: PurchasePlanAutoGenerated;\n /** List of supported capabilities for the image from which the source disk from the snapshot was originally created. */\n supportedCapabilities?: SupportedCapabilities;\n /** Disk source information. CreationData information cannot be changed after the disk has been created. */\n creationData: CreationData;\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. */\n incremental?: boolean;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Contains the security related information for the resource. */\n securityProfile?: DiskSecurityProfile;\n /** Indicates the OS on a snapshot supports hibernation. */\n supportsHibernation?: boolean;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Percentage complete for the background copy when a resource is created via the CopyStart operation. */\n completionPercent?: number;\n /** Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */\n copyCompletionError?: CopyCompletionError;\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n}\n\n/** Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */\nexport interface CopyCompletionError {\n /** Indicates the error code if the background copy of a resource created via the CopyStart operation fails. */\n errorCode: \"CopySourceNotFound\";\n /** Indicates the error message if the background copy of a resource created via the CopyStart operation fails. */\n errorMessage: string;\n}\n\n/** Snapshot update resource. */\nexport interface SnapshotUpdate {\n /** Snapshot resource update properties. */\n properties?: SnapshotUpdateProperties;\n /** Resource tags */\n tags?: Record<string, string>;\n /** 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 */\n sku?: SnapshotSku;\n}\n\n/** Snapshot resource update properties. */\nexport interface SnapshotUpdateProperties {\n /** the Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Indicates the OS on a snapshot supports hibernation. */\n supportsHibernation?: boolean;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n /** List of supported capabilities for the image from which the OS disk was created. */\n supportedCapabilities?: SupportedCapabilities;\n}\n\n/** Specifies information about the Shared Image Gallery that you want to create or update. */\nexport interface Gallery extends Resource {\n /** Describes the properties of a Shared Image Gallery. */\n properties?: GalleryProperties;\n}\n\n/** Describes the properties of a Shared Image Gallery. */\nexport interface GalleryProperties {\n /** The description of this Shared Image Gallery resource. This property is updatable. */\n description?: string;\n /** Describes the gallery unique name. */\n identifier?: GalleryIdentifier;\n /** Profile for gallery sharing to subscription or tenant */\n sharingProfile?: SharingProfile;\n /** Contains information about the soft deletion policy of the gallery. */\n softDeletePolicy?: SoftDeletePolicy;\n}\n\n/** Describes the gallery unique name. */\nexport interface GalleryIdentifier {}\n\n/** Profile for gallery sharing to subscription or tenant */\nexport interface SharingProfile {\n /** This property allows you to specify the permission of sharing gallery. <br><br> Possible values are: <br><br> **Private** <br><br> **Groups** <br><br> **Community** */\n permissions?: \"Private\" | \"Groups\" | \"Community\";\n /** Information of community gallery if current gallery is shared to community. */\n communityGalleryInfo?: CommunityGalleryInfo;\n}\n\n/** Group of the gallery sharing profile */\nexport interface SharingProfileGroup {\n /** This property allows you to specify the type of sharing group. <br><br> Possible values are: <br><br> **Subscriptions** <br><br> **AADTenants** */\n type?: \"Subscriptions\" | \"AADTenants\";\n /** A list of subscription/tenant ids the gallery is aimed to be shared to. */\n ids?: Array<string>;\n}\n\n/** Information of community gallery if current gallery is shared to community */\nexport interface CommunityGalleryInfo {\n /** The link to the publisher website. Visible to all users. */\n publisherUri?: string;\n /** Community gallery publisher support email. The email address of the publisher. Visible to all users. */\n publisherContact?: string;\n /** End-user license agreement for community gallery image. */\n eula?: string;\n /** The prefix of the gallery name that will be displayed publicly. Visible to all users. */\n publicNamePrefix?: string;\n}\n\n/** Contains information about the soft deletion policy of the gallery. */\nexport interface SoftDeletePolicy {\n /** Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. */\n isSoftDeleteEnabled?: boolean;\n}\n\n/** Sharing status of current gallery. */\nexport interface SharingStatus {\n /** Summary of all regional sharing status. */\n summary?: Array<RegionalSharingStatus>;\n}\n\n/** Gallery regional sharing status */\nexport interface RegionalSharingStatus {\n /** Region name */\n region?: string;\n /** Details of gallery regional sharing failure. */\n details?: string;\n}\n\n/** Specifies information about the Shared Image Gallery that you want to update. */\nexport interface GalleryUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a Shared Image Gallery. */\n properties?: GalleryProperties;\n}\n\n/** The Update Resource model definition. */\nexport interface UpdateResourceDefinition {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Specifies information about the gallery image definition that you want to create or update. */\nexport interface GalleryImage extends Resource {\n /** Describes the properties of a gallery image definition. */\n properties?: GalleryImageProperties;\n}\n\n/** Describes the properties of a gallery image definition. */\nexport interface GalleryImageProperties {\n /** The description of this gallery image definition resource. This property is updatable. */\n description?: string;\n /** The Eula agreement for the gallery image definition. */\n eula?: string;\n /** The privacy statement uri. */\n privacyStatementUri?: string;\n /** The release note uri. */\n releaseNoteUri?: string;\n /** This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType: \"Windows\" | \"Linux\";\n /** This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. */\n osState: \"Generalized\" | \"Specialized\";\n /** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. */\n endOfLifeDate?: Date | string;\n /** This is the gallery image definition identifier. */\n identifier: GalleryImageIdentifier;\n /** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */\n recommended?: RecommendedMachineConfiguration;\n /** Describes the disallowed disk types. */\n disallowed?: Disallowed;\n /** Describes the gallery image definition purchase plan. This is used by marketplace images. */\n purchasePlan?: ImagePurchasePlan;\n /** A list of gallery image features. */\n features?: Array<GalleryImageFeature>;\n /** The architecture of the image. Applicable to OS disks only. */\n architecture?: \"x64\" | \"Arm64\";\n}\n\n/** This is the gallery image definition identifier. */\nexport interface GalleryImageIdentifier {\n /** The name of the gallery image definition publisher. */\n publisher: string;\n /** The name of the gallery image definition offer. */\n offer: string;\n /** The name of the gallery image definition SKU. */\n sku: string;\n}\n\n/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */\nexport interface RecommendedMachineConfiguration {\n /** Describes the resource range. */\n vCPUs?: ResourceRange;\n /** Describes the resource range. */\n memory?: ResourceRange;\n}\n\n/** Describes the resource range. */\nexport interface ResourceRange {\n /** The minimum number of the resource. */\n min?: number;\n /** The maximum number of the resource. */\n max?: number;\n}\n\n/** Describes the disallowed disk types. */\nexport interface Disallowed {\n /** A list of disk types. */\n diskTypes?: Array<string>;\n}\n\n/** Describes the gallery image definition purchase plan. This is used by marketplace images. */\nexport interface ImagePurchasePlan {\n /** The plan ID. */\n name?: string;\n /** The publisher ID. */\n publisher?: string;\n /** The product ID. */\n product?: string;\n}\n\n/** A feature for gallery image. */\nexport interface GalleryImageFeature {\n /** The name of the gallery image feature. */\n name?: string;\n /** The value of the gallery image feature. */\n value?: string;\n}\n\n/** Specifies information about the gallery image definition that you want to update. */\nexport interface GalleryImageUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery image definition. */\n properties?: GalleryImageProperties;\n}\n\n/** Specifies information about the gallery image version that you want to create or update. */\nexport interface GalleryImageVersion extends Resource {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryImageVersionProperties;\n}\n\n/** Describes the properties of a gallery image version. */\nexport interface GalleryImageVersionProperties {\n /** The publishing profile of a gallery image Version. */\n publishingProfile?: GalleryImageVersionPublishingProfile;\n /** This is the storage profile of a Gallery Image Version. */\n storageProfile: GalleryImageVersionStorageProfile;\n}\n\n/** The publishing profile of a gallery image Version. */\nexport interface GalleryImageVersionPublishingProfile\n extends GalleryArtifactPublishingProfileBase {}\n\n/** Describes the basic gallery artifact publishing profile. */\nexport interface GalleryArtifactPublishingProfileBase {\n /** The target regions where the Image Version is going to be replicated to. This property is updatable. */\n targetRegions?: Array<TargetRegion>;\n /** The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. */\n replicaCount?: number;\n /** If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */\n excludeFromLatest?: boolean;\n /** The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. */\n endOfLifeDate?: Date | string;\n /** Specifies the storage account type to be used to store the image. This property is not updatable. */\n storageAccountType?: \"Standard_LRS\" | \"Standard_ZRS\" | \"Premium_LRS\";\n /** Optional parameter which specifies the mode to be used for replication. This property is not updatable. */\n replicationMode?: \"Full\" | \"Shallow\";\n /** The target extended locations where the Image Version is going to be replicated to. This property is updatable. */\n targetExtendedLocations?: Array<GalleryTargetExtendedLocation>;\n}\n\n/** Describes the target region information. */\nexport interface TargetRegion {\n /** The name of the region. */\n name: string;\n /** The number of replicas of the Image Version to be created per region. This property is updatable. */\n regionalReplicaCount?: number;\n /** Specifies the storage account type to be used to store the image. This property is not updatable. */\n storageAccountType?: \"Standard_LRS\" | \"Standard_ZRS\" | \"Premium_LRS\";\n /** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */\n encryption?: EncryptionImages;\n}\n\n/** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */\nexport interface EncryptionImages {\n /** Contains encryption settings for an OS disk image. */\n osDiskImage?: OSDiskImageEncryption;\n /** A list of encryption specifications for data disk images. */\n dataDiskImages?: Array<DataDiskImageEncryption>;\n}\n\n/** Contains encryption settings for an OS disk image. */\nexport interface OSDiskImageEncryption extends DiskImageEncryption {\n /** This property specifies the security profile of an OS disk image. */\n securityProfile?: OSDiskImageSecurityProfile;\n}\n\n/** Contains security profile for an OS disk image. */\nexport interface OSDiskImageSecurityProfile {\n /** confidential VM encryption types */\n confidentialVMEncryptionType?:\n | \"EncryptedVMGuestStateOnlyWithPmk\"\n | \"EncryptedWithPmk\"\n | \"EncryptedWithCmk\";\n /** secure VM disk encryption set id */\n secureVMDiskEncryptionSetId?: string;\n}\n\n/** This is the disk image encryption base class. */\nexport interface DiskImageEncryption {\n /** A relative URI containing the resource ID of the disk encryption set. */\n diskEncryptionSetId?: string;\n}\n\n/** Contains encryption settings for a data disk image. */\nexport interface DataDiskImageEncryption extends DiskImageEncryption {\n /** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */\n lun: number;\n}\n\nexport interface GalleryTargetExtendedLocation {\n /** The name of the region. */\n name?: string;\n /** The name of the extended location. */\n extendedLocation?: GalleryExtendedLocation;\n /** The number of replicas of the Image Version to be created per extended location. This property is updatable. */\n extendedLocationReplicaCount?: number;\n /** Specifies the storage account type to be used to store the image. This property is not updatable. */\n storageAccountType?: \"Standard_LRS\" | \"Standard_ZRS\" | \"Premium_LRS\";\n /** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */\n encryption?: EncryptionImages;\n}\n\n/** The name of the extended location. */\nexport interface GalleryExtendedLocation {\n name?: string;\n /** It is type of the extended location. */\n type?: \"EdgeZone\" | \"Unknown\";\n}\n\n/** This is the storage profile of a Gallery Image Version. */\nexport interface GalleryImageVersionStorageProfile {\n /** The gallery artifact version source. */\n source?: GalleryArtifactVersionSource;\n /** This is the OS disk image. */\n osDiskImage?: GalleryOSDiskImage;\n /** A list of data disk images. */\n dataDiskImages?: Array<GalleryDataDiskImage>;\n}\n\n/** The gallery artifact version source. */\nexport interface GalleryArtifactVersionSource {\n /** The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. */\n id?: string;\n /** The uri of the gallery artifact version source. Currently used to specify vhd/blob source. */\n uri?: string;\n}\n\n/** This is the OS disk image. */\nexport interface GalleryOSDiskImage extends GalleryDiskImage {}\n\n/** This is the disk image base class. */\nexport interface GalleryDiskImage {\n /** The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' */\n hostCaching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** The gallery artifact version source. */\n source?: GalleryArtifactVersionSource;\n}\n\n/** This is the data disk image. */\nexport interface GalleryDataDiskImage extends GalleryDiskImage {\n /** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */\n lun: number;\n}\n\n/** This is the replication status of the gallery image version. */\nexport interface ReplicationStatus {}\n\n/** This is the regional replication status. */\nexport interface RegionalReplicationStatus {}\n\n/** Specifies information about the gallery image version that you want to update. */\nexport interface GalleryImageVersionUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryImageVersionProperties;\n}\n\n/** Specifies information about the gallery Application Definition that you want to create or update. */\nexport interface GalleryApplication extends Resource {\n /** Describes the properties of a gallery Application Definition. */\n properties?: GalleryApplicationProperties;\n}\n\n/** Describes the properties of a gallery Application Definition. */\nexport interface GalleryApplicationProperties {\n /** The description of this gallery Application Definition resource. This property is updatable. */\n description?: string;\n /** The Eula agreement for the gallery Application Definition. */\n eula?: string;\n /** The privacy statement uri. */\n privacyStatementUri?: string;\n /** The release note uri. */\n releaseNoteUri?: string;\n /** The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. */\n endOfLifeDate?: Date | string;\n /** This property allows you to specify the supported type of the OS that application is built for. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n supportedOSType: \"Windows\" | \"Linux\";\n}\n\n/** Specifies information about the gallery Application Definition that you want to update. */\nexport interface GalleryApplicationUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery Application Definition. */\n properties?: GalleryApplicationProperties;\n}\n\n/** Specifies information about the gallery Application Version that you want to create or update. */\nexport interface GalleryApplicationVersion extends Resource {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryApplicationVersionProperties;\n}\n\n/** Describes the properties of a gallery image version. */\nexport interface GalleryApplicationVersionProperties {\n /** The publishing profile of a gallery image version. */\n publishingProfile: GalleryApplicationVersionPublishingProfile;\n}\n\n/** The publishing profile of a gallery image version. */\nexport interface GalleryApplicationVersionPublishingProfile\n extends GalleryArtifactPublishingProfileBase {\n /** The source image from which the Image Version is going to be created. */\n source: UserArtifactSource;\n manageActions?: UserArtifactManage;\n /** 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. */\n settings?: UserArtifactSettings;\n /** Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. */\n advancedSettings?: Record<string, string>;\n /** Optional. Whether or not this application reports health. */\n enableHealthCheck?: boolean;\n}\n\n/** The source image from which the Image Version is going to be created. */\nexport interface UserArtifactSource {\n /** Required. The mediaLink of the artifact, must be a readable storage page blob. */\n mediaLink: string;\n /** Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. */\n defaultConfigurationLink?: string;\n}\n\nexport interface UserArtifactManage {\n /** Required. The path and arguments to install the gallery application. This is limited to 4096 characters. */\n install: string;\n /** Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. */\n remove: string;\n /** Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. */\n update?: string;\n}\n\n/** 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. */\nexport interface UserArtifactSettings {\n /** Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. */\n packageFileName?: string;\n /** Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with \"_config\". */\n configFileName?: string;\n}\n\n/** Specifies information about the gallery Application Version that you want to update. */\nexport interface GalleryApplicationVersionUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryApplicationVersionProperties;\n}\n\n/** Specifies information about the gallery sharing profile update. */\nexport interface SharingUpdate {\n /** This property allows you to specify the operation type of gallery sharing update. <br><br> Possible values are: <br><br> **Add** <br><br> **Remove** <br><br> **Reset** */\n operationType: \"Add\" | \"Remove\" | \"Reset\" | \"EnableCommunity\";\n /** A list of sharing profile groups. */\n groups?: Array<SharingProfileGroup>;\n}\n\n/** Describes the cloud service role sku. */\nexport interface CloudServiceRoleSku {\n /** The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. */\n name?: string;\n /** Specifies the tier of the cloud service. Possible Values are <br /><br /> **Standard** <br /><br /> **Basic** */\n tier?: string;\n /** Specifies the number of role instances in the cloud service. */\n capacity?: number;\n}\n\n/** Describes the cloud service. */\nexport interface CloudService {\n /** Resource location. */\n location: string;\n /** Resource tags. */\n tags?: Record<string, string>;\n /** Cloud service properties */\n properties?: CloudServiceProperties;\n /** The system meta data relating to this resource. */\n systemData?: SystemData;\n}\n\n/** Cloud service properties */\nexport interface CloudServiceProperties {\n /**\n * Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\n * This is a write-only property and is not returned in GET calls.\n */\n packageUrl?: string;\n /** Specifies the XML service configuration (.cscfg) for the cloud service. */\n configuration?: string;\n /**\n * Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\n * This is a write-only property and is not returned in GET calls.\n */\n configurationUrl?: string;\n /**\n * (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.\n * If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.\n */\n startCloudService?: boolean;\n /**\n * (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.\n * The default value is `false`.\n */\n allowModelOverride?: boolean;\n /**\n * Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains.\n * Possible Values are <br /><br />**Auto**<br /><br />**Manual** <br /><br />**Simultaneous**<br /><br />\n * If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.\n */\n upgradeMode?: \"Auto\" | \"Manual\" | \"Simultaneous\";\n /** Describes the role profile for the cloud service. */\n roleProfile?: CloudServiceRoleProfile;\n /** Describes the OS profile for the cloud service. */\n osProfile?: CloudServiceOsProfile;\n /** Network Profile for the cloud service. */\n networkProfile?: CloudServiceNetworkProfile;\n /** Describes a cloud service extension profile. */\n extensionProfile?: CloudServiceExtensionProfile;\n}\n\n/** Describes the role profile for the cloud service. */\nexport interface CloudServiceRoleProfile {\n /** List of roles for the cloud service. */\n roles?: Array<CloudServiceRoleProfileProperties>;\n}\n\n/** Describes the role properties. */\nexport interface CloudServiceRoleProfileProperties {\n /** Resource name. */\n name?: string;\n /** Describes the cloud service role sku. */\n sku?: CloudServiceRoleSku;\n}\n\n/** Describes the OS profile for the cloud service. */\nexport interface CloudServiceOsProfile {\n /** Specifies set of certificates that should be installed onto the role instances. */\n secrets?: Array<CloudServiceVaultSecretGroup>;\n}\n\n/** Describes a set of certificates which are all in the same Key Vault. */\nexport interface CloudServiceVaultSecretGroup {\n /** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */\n sourceVault?: SubResource;\n /** The list of key vault references in SourceVault which contain certificates. */\n vaultCertificates?: Array<CloudServiceVaultCertificate>;\n}\n\n/** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance. */\nexport interface CloudServiceVaultCertificate {\n /** This is the URL of a certificate that has been uploaded to Key Vault as a secret. */\n certificateUrl?: string;\n}\n\n/** Network Profile for the cloud service. */\nexport interface CloudServiceNetworkProfile {\n /** List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. */\n loadBalancerConfigurations?: Array<LoadBalancerConfiguration>;\n /**\n * Slot type for the cloud service.\n * Possible values are <br /><br />**Production**<br /><br />**Staging**<br /><br />\n * If not specified, the default value is Production.\n */\n slotType?: \"Production\" | \"Staging\";\n /** The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. */\n swappableCloudService?: SubResource;\n}\n\n/** Describes the load balancer configuration. */\nexport interface LoadBalancerConfiguration {\n /** Resource Id */\n id?: string;\n /** The name of the Load balancer */\n name: string;\n /** Properties of the load balancer configuration. */\n properties: LoadBalancerConfigurationProperties;\n}\n\n/** Describes the properties of the load balancer configuration. */\nexport interface LoadBalancerConfigurationProperties {\n /** 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. */\n frontendIPConfigurations: Array<LoadBalancerFrontendIPConfiguration>;\n}\n\n/** 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. */\nexport interface LoadBalancerFrontendIPConfiguration {\n /** The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. */\n name: string;\n /** Properties of load balancer frontend ip configuration. */\n properties: LoadBalancerFrontendIPConfigurationProperties;\n}\n\n/** Describes a cloud service IP Configuration */\nexport interface LoadBalancerFrontendIPConfigurationProperties {\n /** The reference to the public ip address resource. */\n publicIPAddress?: SubResource;\n /** The reference to the virtual network subnet resource. */\n subnet?: SubResource;\n /** The virtual network private IP address of the IP configuration. */\n privateIPAddress?: string;\n}\n\n/** Describes a cloud service extension profile. */\nexport interface CloudServiceExtensionProfile {\n /** List of extensions for the cloud service. */\n extensions?: Array<Extension>;\n}\n\n/** Describes a cloud service Extension. */\nexport interface Extension {\n /** The name of the extension. */\n name?: string;\n /** Extension Properties. */\n properties?: CloudServiceExtensionProperties;\n}\n\n/** Extension Properties. */\nexport interface CloudServiceExtensionProperties {\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension. */\n type?: string;\n /** Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. */\n typeHandlerVersion?: string;\n /** Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. */\n autoUpgradeMinorVersion?: boolean;\n /** Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. */\n settings?: any;\n /** Protected settings for the extension which are encrypted before sent to the role instance. */\n protectedSettings?: any;\n /** Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. */\n protectedSettingsFromKeyVault?: CloudServiceVaultAndSecretReference;\n /**\n * Tag to force apply the provided public and protected settings.\n * Changing the tag value allows for re-running the extension without changing any of the public or protected settings.\n * If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.\n * If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and\n * it is up to handler implementation whether to re-run it or not\n */\n forceUpdateTag?: string;\n /** Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. */\n rolesAppliedTo?: Array<string>;\n}\n\n/** Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. */\nexport interface CloudServiceVaultAndSecretReference {\n /** The ARM Resource ID of the Key Vault */\n sourceVault?: SubResource;\n /** Secret URL which contains the protected settings of the extension */\n secretUrl?: string;\n}\n\n/** The system meta data relating to this resource. */\nexport interface SystemData {}\n\nexport interface CloudServiceUpdate {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Specifies a list of role instances from the cloud service. */\nexport interface RoleInstances {\n /** List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. */\n roleInstances: Array<string>;\n}\n\n/** Defines an update domain for the cloud service. */\nexport interface UpdateDomain {}\n"]}
1
+ {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** Api error. */\nexport interface ApiError {\n /** The Api error details */\n details?: Array<ApiErrorBase>;\n /** The Api inner error */\n innererror?: InnerError;\n /** The error code. */\n code?: string;\n /** The target of the particular error. */\n target?: string;\n /** The error message. */\n message?: string;\n}\n\n/** Api error base. */\nexport interface ApiErrorBase {\n /** The error code. */\n code?: string;\n /** The target of the particular error. */\n target?: string;\n /** The error message. */\n message?: string;\n}\n\n/** Inner error details. */\nexport interface InnerError {\n /** The exception type. */\n exceptiontype?: string;\n /** The internal error message or exception dump. */\n errordetail?: string;\n}\n\n/** Describes a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSet extends Resource {\n /** The virtual machine scale set sku. */\n sku?: Sku;\n /** 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**. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine Scale Set. */\n properties?: VirtualMachineScaleSetProperties;\n /** The identity of the virtual machine scale set, if configured. */\n identity?: VirtualMachineScaleSetIdentity;\n /** The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set */\n zones?: Array<string>;\n /** The extended location of the Virtual Machine Scale Set. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** 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. */\nexport interface Sku {\n /** The sku name. */\n name?: string;\n /** Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic** */\n tier?: string;\n /** Specifies the number of virtual machines in the scale set. */\n capacity?: number;\n}\n\n/** 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**. */\nexport interface Plan {\n /** The plan ID. */\n name?: string;\n /** The publisher ID. */\n publisher?: string;\n /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */\n product?: string;\n /** The promotion code. */\n promotionCode?: string;\n}\n\n/** Describes the properties of a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSetProperties {\n /** The upgrade policy. */\n upgradePolicy?: UpgradePolicy;\n /** Policy for automatic repairs. */\n automaticRepairsPolicy?: AutomaticRepairsPolicy;\n /** The virtual machine profile. */\n virtualMachineProfile?: VirtualMachineScaleSetVMProfile;\n /** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */\n overprovision?: boolean;\n /** When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. */\n doNotRunExtensionsOnOverprovisionedVMs?: boolean;\n /** When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. */\n singlePlacementGroup?: boolean;\n /** Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set. */\n zoneBalance?: boolean;\n /** Fault Domain count for each placement group. */\n platformFaultDomainCount?: number;\n /** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n /** Specifies information about the dedicated host group that the virtual machine scale set resides in. <br><br>Minimum api-version: 2020-06-01. */\n hostGroup?: SubResource;\n /** Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */\n scaleInPolicy?: ScaleInPolicy;\n /** Specifies the orchestration mode for the virtual machine scale set. */\n orchestrationMode?: \"Uniform\" | \"Flexible\";\n /** Specifies the Spot Restore properties for the virtual machine scale set. */\n spotRestorePolicy?: SpotRestorePolicy;\n /** Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. */\n priorityMixPolicy?: PriorityMixPolicy;\n}\n\n/** Describes an upgrade policy - automatic, manual, or rolling. */\nexport interface UpgradePolicy {\n /** Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time. */\n mode?: \"Automatic\" | \"Manual\" | \"Rolling\";\n /** The configuration parameters used while performing a rolling upgrade. */\n rollingUpgradePolicy?: RollingUpgradePolicy;\n /** Configuration parameters used for performing automatic OS Upgrade. */\n automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy;\n}\n\n/** The configuration parameters used while performing a rolling upgrade. */\nexport interface RollingUpgradePolicy {\n /** The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. */\n maxBatchInstancePercent?: number;\n /** The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. */\n maxUnhealthyInstancePercent?: number;\n /** The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. */\n maxUnhealthyUpgradedInstancePercent?: number;\n /** The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). */\n pauseTimeBetweenBatches?: string;\n /** Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. */\n enableCrossZoneUpgrade?: boolean;\n /** Upgrade all unhealthy instances in a scale set before any healthy instances. */\n prioritizeUnhealthyInstances?: boolean;\n}\n\n/** The configuration parameters used for performing automatic OS upgrade. */\nexport interface AutomaticOSUpgradePolicy {\n /** Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. <br><br> If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. */\n enableAutomaticOSUpgrade?: boolean;\n /** Whether OS image rollback feature should be disabled. Default value is false. */\n disableAutomaticRollback?: boolean;\n /** Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */\n useRollingUpgradePolicy?: boolean;\n}\n\n/** Specifies the configuration parameters for automatic repairs on the virtual machine scale set. */\nexport interface AutomaticRepairsPolicy {\n /** Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. */\n enabled?: boolean;\n /** The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). */\n gracePeriod?: string;\n /** Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. */\n repairAction?: \"Replace\" | \"Restart\" | \"Reimage\";\n}\n\n/** Describes a virtual machine scale set virtual machine profile. */\nexport interface VirtualMachineScaleSetVMProfile {\n /** Specifies the operating system settings for the virtual machines in the scale set. */\n osProfile?: VirtualMachineScaleSetOSProfile;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: VirtualMachineScaleSetStorageProfile;\n /** Specifies properties of the network interfaces of the virtual machines in the scale set. */\n networkProfile?: VirtualMachineScaleSetNetworkProfile;\n /** Specifies the Security related profile settings for the virtual machines in the scale set. */\n securityProfile?: SecurityProfile;\n /** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** Specifies a collection of settings for extensions installed on virtual machines in the scale set. */\n extensionProfile?: VirtualMachineScaleSetExtensionProfile;\n /** Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15 */\n licenseType?: string;\n /** Specifies the priority for the virtual machines in the scale set. <br><br>Minimum api-version: 2017-10-30-preview */\n priority?: \"Regular\" | \"Low\" | \"Spot\";\n /** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */\n evictionPolicy?: \"Deallocate\" | \"Delete\";\n /** Specifies the billing related details of a Azure Spot VMSS. <br><br>Minimum api-version: 2019-03-01. */\n billingProfile?: BillingProfile;\n /** Specifies Scheduled Event related configurations. */\n scheduledEventsProfile?: ScheduledEventsProfile;\n /** UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n /** Specifies the capacity reservation related details of a scale set. <br><br>Minimum api-version: 2021-04-01. */\n capacityReservation?: CapacityReservationProfile;\n /** Specifies the gallery applications that should be made available to the VM/VMSS */\n applicationProfile?: ApplicationProfile;\n /** Specifies the hardware profile related details of a scale set. <br><br>Minimum api-version: 2021-11-01. */\n hardwareProfile?: VirtualMachineScaleSetHardwareProfile;\n}\n\n/** Describes a virtual machine scale set OS profile. */\nexport interface VirtualMachineScaleSetOSProfile {\n /** Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. */\n computerNamePrefix?: string;\n /** Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in \".\" <br><br> **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters */\n adminUsername?: string;\n /** Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\\W_]) <br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */\n adminPassword?: string;\n /** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) */\n customData?: string;\n /** Specifies Windows operating system settings on the virtual machine. */\n windowsConfiguration?: WindowsConfiguration;\n /** Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */\n linuxConfiguration?: LinuxConfiguration;\n /** Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n secrets?: Array<VaultSecretGroup>;\n /** Specifies whether extension operations should be allowed on the virtual machine scale set. <br><br>This may only be set to False when no extensions are present on the virtual machine scale set. */\n allowExtensionOperations?: boolean;\n}\n\n/** Specifies Windows operating system settings on the virtual machine. */\nexport interface WindowsConfiguration {\n /** Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */\n provisionVMAgent?: boolean;\n /** Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. <br><br> For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. */\n enableAutomaticUpdates?: boolean;\n /** Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\". <br><br> Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). */\n timeZone?: string;\n /** Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. */\n additionalUnattendContent?: Array<AdditionalUnattendContent>;\n /** [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */\n patchSettings?: PatchSettings;\n /** Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */\n winRM?: WinRMConfiguration;\n /** Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. */\n enableVMAgentPlatformUpdates?: boolean;\n}\n\n/** 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. */\nexport interface AdditionalUnattendContent {\n /** The pass name. Currently, the only allowable value is OobeSystem. */\n passName?: \"OobeSystem\";\n /** The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. */\n componentName?: \"Microsoft-Windows-Shell-Setup\";\n /** Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. */\n settingName?: \"AutoLogon\" | \"FirstLogonCommands\";\n /** Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. */\n content?: string;\n}\n\n/** Specifies settings related to VM Guest Patching on Windows. */\nexport interface PatchSettings {\n /** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true */\n patchMode?: \"Manual\" | \"AutomaticByOS\" | \"AutomaticByPlatform\";\n /** Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. */\n enableHotpatching?: boolean;\n /** Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You control the timing of patch assessments on a virtual machine.<br /><br /> **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */\n assessmentMode?: \"ImageDefault\" | \"AutomaticByPlatform\";\n /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */\n automaticByPlatformSettings?: WindowsVMGuestPatchAutomaticByPlatformSettings;\n}\n\n/** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */\nexport interface WindowsVMGuestPatchAutomaticByPlatformSettings {\n /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */\n rebootSetting?: \"Unknown\" | \"IfRequired\" | \"Never\" | \"Always\";\n}\n\n/** Describes Windows Remote Management configuration of the VM */\nexport interface WinRMConfiguration {\n /** The list of Windows Remote Management listeners */\n listeners?: Array<WinRMListener>;\n}\n\n/** Describes Protocol and thumbprint of Windows Remote Management listener */\nexport interface WinRMListener {\n /** Specifies the protocol of WinRM listener. <br><br> Possible values are: <br>**http** <br><br> **https** */\n protocol?: \"Http\" | \"Https\";\n /** This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> \"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br> \"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n certificateUrl?: string;\n}\n\n/** Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */\nexport interface LinuxConfiguration {\n /** Specifies whether password authentication should be disabled. */\n disablePasswordAuthentication?: boolean;\n /** Specifies the ssh key configuration for a Linux OS. */\n ssh?: SshConfiguration;\n /** Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */\n provisionVMAgent?: boolean;\n /** [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */\n patchSettings?: LinuxPatchSettings;\n /** Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. */\n enableVMAgentPlatformUpdates?: boolean;\n}\n\n/** SSH configuration for Linux based VMs running on Azure */\nexport interface SshConfiguration {\n /** The list of SSH public keys used to authenticate with linux based VMs. */\n publicKeys?: Array<SshPublicKey>;\n}\n\n/** Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */\nexport interface SshPublicKey {\n /** Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */\n path?: string;\n /** SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */\n keyData?: string;\n}\n\n/** Specifies settings related to VM Guest Patching on Linux. */\nexport interface LinuxPatchSettings {\n /** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - The virtual machine's default patching configuration is used. <br /><br /> **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true */\n patchMode?: \"ImageDefault\" | \"AutomaticByPlatform\";\n /** Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You control the timing of patch assessments on a virtual machine. <br /><br /> **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */\n assessmentMode?: \"ImageDefault\" | \"AutomaticByPlatform\";\n /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */\n automaticByPlatformSettings?: LinuxVMGuestPatchAutomaticByPlatformSettings;\n}\n\n/** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */\nexport interface LinuxVMGuestPatchAutomaticByPlatformSettings {\n /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */\n rebootSetting?: \"Unknown\" | \"IfRequired\" | \"Never\" | \"Always\";\n}\n\n/** Describes a set of certificates which are all in the same Key Vault. */\nexport interface VaultSecretGroup {\n /** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */\n sourceVault?: SubResource;\n /** The list of key vault references in SourceVault which contain certificates. */\n vaultCertificates?: Array<VaultCertificate>;\n}\n\nexport interface SubResource {\n /** Resource Id */\n id?: string;\n}\n\n/** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */\nexport interface VaultCertificate {\n /** This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: <br><br> {<br> \"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br> \"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n certificateUrl?: string;\n /** For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name &lt;UppercaseThumbprint&gt;.crt for the X509 certificate file and &lt;UppercaseThumbprint&gt;.prv for private key. Both of these files are .pem formatted. */\n certificateStore?: string;\n}\n\n/** Describes a virtual machine scale set storage profile. */\nexport interface VirtualMachineScaleSetStorageProfile {\n /** 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. */\n imageReference?: ImageReference;\n /** Specifies information about the operating system disk used by the virtual machines in the scale set. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n osDisk?: VirtualMachineScaleSetOSDisk;\n /** Specifies the parameters that are used to add data disks to the virtual machines in the scale set. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n dataDisks?: Array<VirtualMachineScaleSetDataDisk>;\n diskControllerType?: string;\n}\n\n/** 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. */\nexport interface ImageReference extends SubResource {\n /** The image publisher. */\n publisher?: string;\n /** Specifies the offer of the platform image or marketplace image used to create the virtual machine. */\n offer?: string;\n /** The image SKU. */\n sku?: string;\n /** Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. */\n version?: string;\n /** Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. */\n sharedGalleryImageId?: string;\n /** Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. */\n communityGalleryImageId?: string;\n}\n\n/** Describes a virtual machine scale set operating system disk. */\nexport interface VirtualMachineScaleSetOSDisk {\n /** The disk name. */\n name?: string;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies how the virtual machines in the scale set should be created.<br><br> The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. */\n diffDiskSettings?: DiffDiskSettings;\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** 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. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType?: \"Windows\" | \"Linux\";\n /** Specifies information about the unmanaged user image to base the scale set on. */\n image?: VirtualHardDisk;\n /** Specifies the container urls that are used to store operating system disks for the scale set. */\n vhdContainers?: Array<string>;\n /** The managed disk parameters. */\n managedDisk?: VirtualMachineScaleSetManagedDiskParameters;\n /** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.<br><br> **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes the parameters of ephemeral disk settings that can be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk. */\nexport interface DiffDiskSettings {\n /** Specifies the ephemeral disk settings for operating system disk. */\n option?: \"Local\";\n /** Specifies the ephemeral disk placement for operating system disk.<br><br> Possible values are: <br><br> **CacheDisk** <br><br> **ResourceDisk** <br><br> Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.<br><br> Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. */\n placement?: \"CacheDisk\" | \"ResourceDisk\";\n}\n\n/** Describes the uri of a disk. */\nexport interface VirtualHardDisk {\n /** Specifies the virtual hard disk's uri. */\n uri?: string;\n}\n\n/** Describes the parameters of a ScaleSet managed disk. */\nexport interface VirtualMachineScaleSetManagedDiskParameters {\n /** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */\n storageAccountType?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n /** Specifies the customer managed disk encryption set resource id for the managed disk. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n /** Specifies the security profile for the managed disk. */\n securityProfile?: VMDiskSecurityProfile;\n}\n\n/** Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. <br><br> NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */\nexport interface DiskEncryptionSetParameters extends SubResource {}\n\n/** Specifies the security profile settings for the managed disk. <br><br> NOTE: It can only be set for Confidential VMs */\nexport interface VMDiskSecurityProfile {\n /** Specifies the EncryptionType of the managed disk. <br> It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. <br><br> NOTE: It can be set for only Confidential VMs. */\n securityEncryptionType?: \"VMGuestStateOnly\" | \"DiskWithVMGuestState\";\n /** Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n}\n\n/** Describes a virtual machine scale set data disk. */\nexport interface VirtualMachineScaleSetDataDisk {\n /** The disk name. */\n name?: string;\n /** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */\n lun: number;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** The create option. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The managed disk parameters. */\n managedDisk?: VirtualMachineScaleSetManagedDiskParameters;\n /** Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */\n diskIOPSReadWrite?: number;\n /** Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */\n diskMBpsReadWrite?: number;\n /** Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).<br><br> Possible values: <br><br> **Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.<br><br> **Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.<br><br> The default value is set to **Delete**. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machine scale set network profile. */\nexport interface VirtualMachineScaleSetNetworkProfile {\n /** A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */\n healthProbe?: ApiEntityReference;\n /** The list of network configurations. */\n networkInterfaceConfigurations?: Array<VirtualMachineScaleSetNetworkConfiguration>;\n /** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */\n networkApiVersion?: \"2020-11-01\";\n}\n\n/** The API entity reference. */\nexport interface ApiEntityReference {\n /** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */\n id?: string;\n}\n\n/** Describes a virtual machine scale set network profile's network configurations. */\nexport interface VirtualMachineScaleSetNetworkConfiguration extends SubResource {\n /** The network configuration name. */\n name: string;\n /** Describes a virtual machine scale set network profile's IP configuration. */\n properties?: VirtualMachineScaleSetNetworkConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration. */\nexport interface VirtualMachineScaleSetNetworkConfigurationProperties {\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** Specifies whether the network interface is accelerated networking-enabled. */\n enableAcceleratedNetworking?: boolean;\n /** Specifies whether the network interface is disabled for tcp state tracking. */\n disableTcpStateTracking?: boolean;\n /** Specifies whether the network interface is FPGA networking-enabled. */\n enableFpga?: boolean;\n /** The network security group. */\n networkSecurityGroup?: SubResource;\n /** The dns settings to be applied on the network interfaces. */\n dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings;\n /** Specifies the IP configurations of the network interface. */\n ipConfigurations: Array<VirtualMachineScaleSetIPConfiguration>;\n /** Whether IP forwarding enabled on this NIC. */\n enableIPForwarding?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machines scale sets network configuration's DNS settings. */\nexport interface VirtualMachineScaleSetNetworkConfigurationDnsSettings {\n /** List of DNS servers IP addresses */\n dnsServers?: Array<string>;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration. */\nexport interface VirtualMachineScaleSetIPConfiguration extends SubResource {\n /** The IP configuration name. */\n name: string;\n /** Describes a virtual machine scale set network profile's IP configuration properties. */\n properties?: VirtualMachineScaleSetIPConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration properties. */\nexport interface VirtualMachineScaleSetIPConfigurationProperties {\n /** Specifies the identifier of the subnet. */\n subnet?: ApiEntityReference;\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** The publicIPAddressConfiguration. */\n publicIPAddressConfiguration?: VirtualMachineScaleSetPublicIPAddressConfiguration;\n /** 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'. */\n privateIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. */\n applicationGatewayBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to application security group. */\n applicationSecurityGroups?: Array<SubResource>;\n /** Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */\n loadBalancerBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */\n loadBalancerInboundNatPools?: Array<SubResource>;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetPublicIPAddressConfiguration {\n /** The publicIP address configuration name. */\n name: string;\n /** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\n properties?: VirtualMachineScaleSetPublicIPAddressConfigurationProperties;\n /** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */\n sku?: PublicIPAddressSku;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties {\n /** The idle timeout of the public IP address. */\n idleTimeoutInMinutes?: number;\n /** The dns settings to be applied on the publicIP addresses . */\n dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings;\n /** The list of IP tags associated with the public IP address. */\n ipTags?: Array<VirtualMachineScaleSetIpTag>;\n /** The PublicIPPrefix from which to allocate publicIP addresses. */\n publicIPPrefix?: SubResource;\n /** 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'. */\n publicIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specify what happens to the public IP when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machines scale sets network configuration's DNS settings. */\nexport interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings {\n /** The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created */\n domainNameLabel: string;\n}\n\n/** Contains the IP tag associated with the public IP address. */\nexport interface VirtualMachineScaleSetIpTag {\n /** IP tag type. Example: FirstPartyUsage. */\n ipTagType?: string;\n /** IP tag associated with the public IP. Example: SQL, Storage etc. */\n tag?: string;\n}\n\n/** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */\nexport interface PublicIPAddressSku {\n /** Specify public IP sku name */\n name?: \"Basic\" | \"Standard\";\n /** Specify public IP sku tier */\n tier?: \"Regional\" | \"Global\";\n}\n\n/** Specifies the Security profile settings for the virtual machine or virtual machine scale set. */\nexport interface SecurityProfile {\n /** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\n uefiSettings?: UefiSettings;\n /** This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. <br><br> Default: The Encryption at host will be disabled unless this property is set to true for the resource. */\n encryptionAtHost?: boolean;\n /** Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. <br><br> Default: UefiSettings will not be enabled unless this property is set. */\n securityType?: \"TrustedLaunch\" | \"ConfidentialVM\";\n}\n\n/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\nexport interface UefiSettings {\n /** Specifies whether secure boot should be enabled on the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\n secureBootEnabled?: boolean;\n /** Specifies whether vTPM should be enabled on the virtual machine. <br><br>Minimum api-version: 2020-12-01 */\n vTpmEnabled?: boolean;\n}\n\n/** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\nexport interface DiagnosticsProfile {\n /** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br>**NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\n bootDiagnostics?: BootDiagnostics;\n}\n\n/** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\nexport interface BootDiagnostics {\n /** Whether boot diagnostics should be enabled on the Virtual Machine. */\n enabled?: boolean;\n /** Uri of the storage account to use for placing the console output and screenshot. <br><br>If storageUri is not specified while enabling boot diagnostics, managed storage will be used. */\n storageUri?: string;\n}\n\n/** Describes a virtual machine scale set extension profile. */\nexport interface VirtualMachineScaleSetExtensionProfile {\n /** The virtual machine scale set child extension resources. */\n extensions?: Array<VirtualMachineScaleSetExtension>;\n /** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01 */\n extensionsTimeBudget?: string;\n}\n\n/** Describes a Virtual Machine Scale Set Extension. */\nexport interface VirtualMachineScaleSetExtension extends SubResourceReadOnly {\n /** The name of the extension. */\n name?: string;\n /** Describes the properties of a Virtual Machine Scale Set Extension. */\n properties?: VirtualMachineScaleSetExtensionProperties;\n}\n\n/** Describes the properties of a Virtual Machine Scale Set Extension. */\nexport interface VirtualMachineScaleSetExtensionProperties {\n /** If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. */\n forceUpdateTag?: string;\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */\n autoUpgradeMinorVersion?: boolean;\n /** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */\n enableAutomaticUpgrade?: boolean;\n /** Json formatted public settings for the extension. */\n settings?: any;\n /** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */\n protectedSettings?: any;\n /** Collection of extension names after which this extension needs to be provisioned. */\n provisionAfterExtensions?: Array<string>;\n /** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */\n suppressFailures?: boolean;\n /** The extensions protected settings that are passed by reference, and consumed from key vault */\n protectedSettingsFromKeyVault?: KeyVaultSecretReference;\n}\n\n/** Describes a reference to Key Vault Secret */\nexport interface KeyVaultSecretReference {\n /** The URL referencing a secret in a Key Vault. */\n secretUrl: string;\n /** The relative URL of the Key Vault containing the secret. */\n sourceVault: SubResource;\n}\n\nexport interface SubResourceReadOnly {}\n\n/** Specifies the billing related details of a Azure Spot VM or VMSS. <br><br>Minimum api-version: 2019-03-01. */\nexport interface BillingProfile {\n /** Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. <br><br> This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. <br><br> The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. <br><br> Possible values are: <br><br> - Any decimal value greater than zero. Example: 0.01538 <br><br> -1 – indicates default price to be up-to on-demand. <br><br> You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. <br><br>Minimum api-version: 2019-03-01. */\n maxPrice?: number;\n}\n\nexport interface ScheduledEventsProfile {\n /** Specifies Terminate Scheduled Event related configurations. */\n terminateNotificationProfile?: TerminateNotificationProfile;\n}\n\nexport interface TerminateNotificationProfile {\n /** Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) */\n notBeforeTimeout?: string;\n /** Specifies whether the Terminate Scheduled event is enabled or disabled. */\n enable?: boolean;\n}\n\n/** The parameters of a capacity reservation Profile. */\nexport interface CapacityReservationProfile {\n /** Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. */\n capacityReservationGroup?: SubResource;\n}\n\n/** Contains the list of gallery applications that should be made available to the VM/VMSS */\nexport interface ApplicationProfile {\n /** Specifies the gallery applications that should be made available to the VM/VMSS */\n galleryApplications?: Array<VMGalleryApplication>;\n}\n\n/** Specifies the required information to reference a compute gallery application version */\nexport interface VMGalleryApplication {\n /** Optional, Specifies a passthrough value for more generic context. */\n tags?: string;\n /** Optional, Specifies the order in which the packages have to be installed */\n order?: number;\n /** Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} */\n packageReferenceId: string;\n /** Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided */\n configurationReference?: string;\n /** Optional, If true, any failure for any operation in the VmApplication will fail the deployment */\n treatFailureAsDeploymentFailure?: boolean;\n /** If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS */\n enableAutomaticUpgrade?: boolean;\n}\n\n/** Specifies the hardware settings for the virtual machine scale set. */\nexport interface VirtualMachineScaleSetHardwareProfile {\n /** Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */\n vmSizeProperties?: VMSizeProperties;\n}\n\n/** Specifies VM Size Property settings on the virtual machine. */\nexport interface VMSizeProperties {\n /** Specifies the number of vCPUs available for the VM. <br><br> When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) . */\n vCPUsAvailable?: number;\n /** Specifies the vCPU to physical core ratio. <br><br> When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) <br><br> Setting this property to 1 also means that hyper-threading is disabled. */\n vCPUsPerCore?: number;\n}\n\n/** Enables or disables a capability on the virtual machine or virtual machine scale set. */\nexport interface AdditionalCapabilities {\n /** The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. */\n ultraSSDEnabled?: boolean;\n /** The flag that enables or disables hibernation capability on the VM. */\n hibernationEnabled?: boolean;\n}\n\n/** Describes a scale-in policy for a virtual machine scale set. */\nexport interface ScaleInPolicy {\n /** The rules to be followed when scaling-in a virtual machine scale set. <br><br> Possible values are: <br><br> **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. <br><br> **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. <br><br> **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal. <br><br> */\n rules?: Array<\"Default\" | \"OldestVM\" | \"NewestVM\">;\n /** This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) */\n forceDeletion?: boolean;\n}\n\n/** Specifies the Spot-Try-Restore properties for the virtual machine scale set. <br><br> 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. */\nexport interface SpotRestorePolicy {\n /** Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints */\n enabled?: boolean;\n /** Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances */\n restoreTimeout?: string;\n}\n\n/** Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. <br><br>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. */\nexport interface PriorityMixPolicy {\n /** The base number of regular priority VMs that will be created in this scale set as it scales out. */\n baseRegularPriorityCount?: number;\n /** The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. */\n regularPriorityPercentageAboveBase?: number;\n}\n\n/** Identity for the virtual machine scale set. */\nexport interface VirtualMachineScaleSetIdentity {\n /** 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. */\n type?: \"SystemAssigned\" | \"UserAssigned\" | \"SystemAssigned, UserAssigned\" | \"None\";\n /** The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */\n userAssignedIdentities?: Record<string, UserAssignedIdentitiesValue>;\n}\n\nexport interface UserAssignedIdentitiesValue {}\n\n/** The complex type of the extended location. */\nexport interface ExtendedLocation {\n /** The name of the extended location. */\n name?: string;\n /** The type of the extended location. */\n type?: \"EdgeZone\";\n}\n\n/** The Resource model definition. */\nexport interface Resource {\n /** Resource location */\n location: string;\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Describes a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSetUpdate extends UpdateResource {\n /** The virtual machine scale set sku. */\n sku?: Sku;\n /** The purchase plan when deploying a virtual machine scale set from VM Marketplace images. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine Scale Set. */\n properties?: VirtualMachineScaleSetUpdateProperties;\n /** The identity of the virtual machine scale set, if configured. */\n identity?: VirtualMachineScaleSetIdentity;\n}\n\n/** Describes the properties of a Virtual Machine Scale Set. */\nexport interface VirtualMachineScaleSetUpdateProperties {\n /** The upgrade policy. */\n upgradePolicy?: UpgradePolicy;\n /** Policy for automatic repairs. */\n automaticRepairsPolicy?: AutomaticRepairsPolicy;\n /** The virtual machine profile. */\n virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile;\n /** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */\n overprovision?: boolean;\n /** When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. */\n doNotRunExtensionsOnOverprovisionedVMs?: boolean;\n /** When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. */\n singlePlacementGroup?: boolean;\n /** Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */\n scaleInPolicy?: ScaleInPolicy;\n /** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n}\n\n/** Describes a virtual machine scale set virtual machine profile. */\nexport interface VirtualMachineScaleSetUpdateVMProfile {\n /** The virtual machine scale set OS profile. */\n osProfile?: VirtualMachineScaleSetUpdateOSProfile;\n /** The virtual machine scale set storage profile. */\n storageProfile?: VirtualMachineScaleSetUpdateStorageProfile;\n /** The virtual machine scale set network profile. */\n networkProfile?: VirtualMachineScaleSetUpdateNetworkProfile;\n /** The virtual machine scale set Security profile */\n securityProfile?: SecurityProfile;\n /** The virtual machine scale set diagnostics profile. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** The virtual machine scale set extension profile. */\n extensionProfile?: VirtualMachineScaleSetExtensionProfile;\n /** The license type, which is for bring your own license scenario. */\n licenseType?: string;\n /** Specifies the billing related details of a Azure Spot VMSS. <br><br>Minimum api-version: 2019-03-01. */\n billingProfile?: BillingProfile;\n /** Specifies Scheduled Event related configurations. */\n scheduledEventsProfile?: ScheduledEventsProfile;\n /** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n /** Specifies the hardware profile related details of a scale set. <br><br>Minimum api-version: 2021-11-01. */\n hardwareProfile?: VirtualMachineScaleSetHardwareProfile;\n}\n\n/** Describes a virtual machine scale set OS profile. */\nexport interface VirtualMachineScaleSetUpdateOSProfile {\n /** A base-64 encoded string of custom data. */\n customData?: string;\n /** The Windows Configuration of the OS profile. */\n windowsConfiguration?: WindowsConfiguration;\n /** The Linux Configuration of the OS profile. */\n linuxConfiguration?: LinuxConfiguration;\n /** The List of certificates for addition to the VM. */\n secrets?: Array<VaultSecretGroup>;\n}\n\n/** Describes a virtual machine scale set storage profile. */\nexport interface VirtualMachineScaleSetUpdateStorageProfile {\n /** The image reference. */\n imageReference?: ImageReference;\n /** The OS disk. */\n osDisk?: VirtualMachineScaleSetUpdateOSDisk;\n /** The data disks. */\n dataDisks?: Array<VirtualMachineScaleSetDataDisk>;\n diskControllerType?: string;\n}\n\n/** Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk. */\nexport interface VirtualMachineScaleSetUpdateOSDisk {\n /** The caching type. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist. */\n image?: VirtualHardDisk;\n /** The list of virtual hard disk container uris. */\n vhdContainers?: Array<string>;\n /** The managed disk parameters. */\n managedDisk?: VirtualMachineScaleSetManagedDiskParameters;\n /** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.<br><br> **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machine scale set network profile. */\nexport interface VirtualMachineScaleSetUpdateNetworkProfile {\n /** A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */\n healthProbe?: ApiEntityReference;\n /** The list of network configurations. */\n networkInterfaceConfigurations?: Array<VirtualMachineScaleSetUpdateNetworkConfiguration>;\n /** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */\n networkApiVersion?: \"2020-11-01\";\n}\n\n/** Describes a virtual machine scale set network profile's network configurations. */\nexport interface VirtualMachineScaleSetUpdateNetworkConfiguration extends SubResource {\n /** The network configuration name. */\n name?: string;\n /** Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. */\n properties?: VirtualMachineScaleSetUpdateNetworkConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. */\nexport interface VirtualMachineScaleSetUpdateNetworkConfigurationProperties {\n /** Whether this is a primary NIC on a virtual machine. */\n primary?: boolean;\n /** Specifies whether the network interface is accelerated networking-enabled. */\n enableAcceleratedNetworking?: boolean;\n /** Specifies whether the network interface is disabled for tcp state tracking. */\n disableTcpStateTracking?: boolean;\n /** Specifies whether the network interface is FPGA networking-enabled. */\n enableFpga?: boolean;\n /** The network security group. */\n networkSecurityGroup?: SubResource;\n /** The dns settings to be applied on the network interfaces. */\n dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettings;\n /** The virtual machine scale set IP Configuration. */\n ipConfigurations?: Array<VirtualMachineScaleSetUpdateIPConfiguration>;\n /** Whether IP forwarding enabled on this NIC. */\n enableIPForwarding?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** 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 */\nexport interface VirtualMachineScaleSetUpdateIPConfiguration extends SubResource {\n /** The IP configuration name. */\n name?: string;\n /** Describes a virtual machine scale set network profile's IP configuration properties. */\n properties?: VirtualMachineScaleSetUpdateIPConfigurationProperties;\n}\n\n/** Describes a virtual machine scale set network profile's IP configuration properties. */\nexport interface VirtualMachineScaleSetUpdateIPConfigurationProperties {\n /** The subnet. */\n subnet?: ApiEntityReference;\n /** Specifies the primary IP Configuration in case the network interface has more than one IP Configuration. */\n primary?: boolean;\n /** The publicIPAddressConfiguration. */\n publicIPAddressConfiguration?: VirtualMachineScaleSetUpdatePublicIPAddressConfiguration;\n /** 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'. */\n privateIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** The application gateway backend address pools. */\n applicationGatewayBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to application security group. */\n applicationSecurityGroups?: Array<SubResource>;\n /** The load balancer backend address pools. */\n loadBalancerBackendAddressPools?: Array<SubResource>;\n /** The load balancer inbound nat pools. */\n loadBalancerInboundNatPools?: Array<SubResource>;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetUpdatePublicIPAddressConfiguration {\n /** The publicIP address configuration name. */\n name?: string;\n /** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\n properties?: VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties;\n}\n\n/** Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties {\n /** The idle timeout of the public IP address. */\n idleTimeoutInMinutes?: number;\n /** The dns settings to be applied on the publicIP addresses . */\n dnsSettings?: VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings;\n /** The PublicIPPrefix from which to allocate publicIP addresses. */\n publicIPPrefix?: SubResource;\n /** Specify what happens to the public IP when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** The Update Resource model definition. */\nexport interface UpdateResource {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Specifies a list of virtual machine instance IDs from the VM scale set. */\nexport interface VirtualMachineScaleSetVMInstanceIDs {\n /** The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. */\n instanceIds?: Array<string>;\n}\n\n/** Specifies a list of virtual machine instance IDs from the VM scale set. */\nexport interface VirtualMachineScaleSetVMInstanceRequiredIDs {\n /** The virtual machine scale set instance ids. */\n instanceIds: Array<string>;\n}\n\n/** Instance view status. */\nexport interface InstanceViewStatus {\n /** The status code. */\n code?: string;\n /** The level code. */\n level?: \"Info\" | \"Warning\" | \"Error\";\n /** The short localizable label for the status. */\n displayStatus?: string;\n /** The detailed status message, including for alerts and error messages. */\n message?: string;\n /** The time of the status. */\n time?: Date | string;\n}\n\n/** Describes a Virtual Machine Scale Set Extension. */\nexport interface VirtualMachineScaleSetExtensionUpdate extends SubResourceReadOnly {\n /** Describes the properties of a Virtual Machine Scale Set Extension. */\n properties?: VirtualMachineScaleSetExtensionProperties;\n}\n\n/** Information about the number of virtual machine instances in each upgrade state. */\nexport interface RollingUpgradeProgressInfo {}\n\n/** Describes a Virtual Machine Scale Set VM Reimage Parameters. */\nexport interface VirtualMachineScaleSetReimageParameters extends VirtualMachineScaleSetVMReimageParameters {\n /** The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set. */\n instanceIds?: Array<string>;\n}\n\n/** Describes a Virtual Machine Scale Set VM Reimage Parameters. */\nexport interface VirtualMachineScaleSetVMReimageParameters extends VirtualMachineReimageParameters {}\n\n/** Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged */\nexport interface VirtualMachineReimageParameters {\n /** Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk. */\n tempDisk?: boolean;\n}\n\n/** The status of the latest virtual machine scale set rolling upgrade. */\nexport interface RollingUpgradeStatusInfo extends Resource {\n /** The status of the latest virtual machine scale set rolling upgrade. */\n properties?: RollingUpgradeStatusInfoProperties;\n}\n\n/** The status of the latest virtual machine scale set rolling upgrade. */\nexport interface RollingUpgradeStatusInfoProperties {}\n\n/** Information about the current running state of the overall upgrade. */\nexport interface RollingUpgradeRunningStatus {}\n\nexport interface VMScaleSetConvertToSinglePlacementGroupInput {\n /** Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances. */\n activePlacementGroupId?: string;\n}\n\n/** The input for OrchestrationServiceState */\nexport interface OrchestrationServiceStateInput {\n /** The name of the service. */\n serviceName: \"AutomaticRepairs\";\n /** The action to be performed. */\n action: \"Resume\" | \"Suspend\";\n}\n\n/** Describes a VMSS VM Extension. */\nexport interface VirtualMachineScaleSetVMExtension extends SubResourceReadOnly {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionProperties;\n}\n\n/** Describes the properties of a Virtual Machine Extension. */\nexport interface VirtualMachineExtensionProperties {\n /** How the extension handler should be forced to update even if the extension configuration has not changed. */\n forceUpdateTag?: string;\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */\n autoUpgradeMinorVersion?: boolean;\n /** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */\n enableAutomaticUpgrade?: boolean;\n /** Json formatted public settings for the extension. */\n settings?: any;\n /** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */\n protectedSettings?: any;\n /** The virtual machine extension instance view. */\n instanceView?: VirtualMachineExtensionInstanceView;\n /** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */\n suppressFailures?: boolean;\n /** The extensions protected settings that are passed by reference, and consumed from key vault */\n protectedSettingsFromKeyVault?: KeyVaultSecretReference;\n}\n\n/** The instance view of a virtual machine extension. */\nexport interface VirtualMachineExtensionInstanceView {\n /** The virtual machine extension name. */\n name?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** The resource status information. */\n substatuses?: Array<InstanceViewStatus>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Describes a VMSS VM Extension. */\nexport interface VirtualMachineScaleSetVMExtensionUpdate extends SubResourceReadOnly {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionUpdateProperties;\n}\n\n/** Describes the properties of a Virtual Machine Extension. */\nexport interface VirtualMachineExtensionUpdateProperties {\n /** How the extension handler should be forced to update even if the extension configuration has not changed. */\n forceUpdateTag?: string;\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */\n autoUpgradeMinorVersion?: boolean;\n /** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */\n enableAutomaticUpgrade?: boolean;\n /** Json formatted public settings for the extension. */\n settings?: any;\n /** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */\n protectedSettings?: any;\n /** Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */\n suppressFailures?: boolean;\n /** The extensions protected settings that are passed by reference, and consumed from key vault */\n protectedSettingsFromKeyVault?: KeyVaultSecretReference;\n}\n\n/** Describes a virtual machine scale set virtual machine. */\nexport interface VirtualMachineScaleSetVM extends Resource {\n /** Describes the properties of a virtual machine scale set virtual machine. */\n properties?: VirtualMachineScaleSetVMProperties;\n /** 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**. */\n plan?: Plan;\n /** The identity of the virtual machine, if configured. */\n identity?: VirtualMachineIdentity;\n}\n\n/** Describes the properties of a virtual machine scale set virtual machine. */\nexport interface VirtualMachineScaleSetVMProperties {\n /** Specifies the hardware settings for the virtual machine. */\n hardwareProfile?: HardwareProfile;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: StorageProfile;\n /** Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the operating system settings for the virtual machine. */\n osProfile?: OSProfile;\n /** Specifies the Security related profile settings for the virtual machine. */\n securityProfile?: SecurityProfile;\n /** Specifies the network interfaces of the virtual machine. */\n networkProfile?: NetworkProfile;\n /** Specifies the network profile configuration of the virtual machine. */\n networkProfileConfiguration?: VirtualMachineScaleSetVMNetworkProfileConfiguration;\n /** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. */\n availabilitySet?: SubResource;\n /** Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15 */\n licenseType?: string;\n /** Specifies the protection policy of the virtual machine. */\n protectionPolicy?: VirtualMachineScaleSetVMProtectionPolicy;\n /** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n}\n\n/** The instance view of a virtual machine scale set VM. */\nexport interface VirtualMachineScaleSetVMInstanceView {\n /** The Update Domain count. */\n platformUpdateDomain?: number;\n /** The Fault Domain count. */\n platformFaultDomain?: number;\n /** The Remote desktop certificate thumbprint. */\n rdpThumbPrint?: string;\n /** The VM Agent running on the virtual machine. */\n vmAgent?: VirtualMachineAgentInstanceView;\n /** The Maintenance Operation status on the virtual machine. */\n maintenanceRedeployStatus?: MaintenanceRedeployStatus;\n /** The disks information. */\n disks?: Array<DiskInstanceView>;\n /** The extensions information. */\n extensions?: Array<VirtualMachineExtensionInstanceView>;\n /** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\n bootDiagnostics?: BootDiagnosticsInstanceView;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n /** The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. */\n placementGroupId?: string;\n}\n\n/** The instance view of the VM Agent running on the virtual machine. */\nexport interface VirtualMachineAgentInstanceView {\n /** The VM Agent full version. */\n vmAgentVersion?: string;\n /** The virtual machine extension handler instance view. */\n extensionHandlers?: Array<VirtualMachineExtensionHandlerInstanceView>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** The instance view of a virtual machine extension handler. */\nexport interface VirtualMachineExtensionHandlerInstanceView {\n /** Specifies the type of the extension; an example is \"CustomScriptExtension\". */\n type?: string;\n /** Specifies the version of the script handler. */\n typeHandlerVersion?: string;\n /** The extension handler status. */\n status?: InstanceViewStatus;\n}\n\n/** Maintenance Operation Status. */\nexport interface MaintenanceRedeployStatus {\n /** True, if customer is allowed to perform Maintenance. */\n isCustomerInitiatedMaintenanceAllowed?: boolean;\n /** Start Time for the Pre Maintenance Window. */\n preMaintenanceWindowStartTime?: Date | string;\n /** End Time for the Pre Maintenance Window. */\n preMaintenanceWindowEndTime?: Date | string;\n /** Start Time for the Maintenance Window. */\n maintenanceWindowStartTime?: Date | string;\n /** End Time for the Maintenance Window. */\n maintenanceWindowEndTime?: Date | string;\n /** The Last Maintenance Operation Result Code. */\n lastOperationResultCode?: \"None\" | \"RetryLater\" | \"MaintenanceAborted\" | \"MaintenanceCompleted\";\n /** Message returned for the last Maintenance Operation. */\n lastOperationMessage?: string;\n}\n\n/** The instance view of the disk. */\nexport interface DiskInstanceView {\n /** The disk name. */\n name?: string;\n /** Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15 */\n encryptionSettings?: Array<DiskEncryptionSettings>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Describes a Encryption Settings for a Disk */\nexport interface DiskEncryptionSettings {\n /** Specifies the location of the disk encryption key, which is a Key Vault Secret. */\n diskEncryptionKey?: KeyVaultSecretReference;\n /** Specifies the location of the key encryption key in Key Vault. */\n keyEncryptionKey?: KeyVaultKeyReference;\n /** Specifies whether disk encryption should be enabled on the virtual machine. */\n enabled?: boolean;\n}\n\n/** Describes a reference to Key Vault Key */\nexport interface KeyVaultKeyReference {\n /** The URL referencing a key encryption key in Key Vault. */\n keyUrl: string;\n /** The relative URL of the Key Vault containing the key. */\n sourceVault: SubResource;\n}\n\n/** The health status of the VM. */\nexport interface VirtualMachineHealthStatus {}\n\n/** The instance view of a virtual machine boot diagnostics. */\nexport interface BootDiagnosticsInstanceView {}\n\n/** Specifies the hardware settings for the virtual machine. */\nexport interface HardwareProfile {\n /** Specifies the size of the virtual machine. <br><br> The enum data type is currently deprecated and will be removed by December 23rd 2023. <br><br> Recommended way to get the list of available sizes is using these APIs: <br><br> [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) <br><br> [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list) <br><br> [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). <br><br> The available VM sizes depend on region and availability set. */\n vmSize?:\n | \"Basic_A0\"\n | \"Basic_A1\"\n | \"Basic_A2\"\n | \"Basic_A3\"\n | \"Basic_A4\"\n | \"Standard_A0\"\n | \"Standard_A1\"\n | \"Standard_A2\"\n | \"Standard_A3\"\n | \"Standard_A4\"\n | \"Standard_A5\"\n | \"Standard_A6\"\n | \"Standard_A7\"\n | \"Standard_A8\"\n | \"Standard_A9\"\n | \"Standard_A10\"\n | \"Standard_A11\"\n | \"Standard_A1_v2\"\n | \"Standard_A2_v2\"\n | \"Standard_A4_v2\"\n | \"Standard_A8_v2\"\n | \"Standard_A2m_v2\"\n | \"Standard_A4m_v2\"\n | \"Standard_A8m_v2\"\n | \"Standard_B1s\"\n | \"Standard_B1ms\"\n | \"Standard_B2s\"\n | \"Standard_B2ms\"\n | \"Standard_B4ms\"\n | \"Standard_B8ms\"\n | \"Standard_D1\"\n | \"Standard_D2\"\n | \"Standard_D3\"\n | \"Standard_D4\"\n | \"Standard_D11\"\n | \"Standard_D12\"\n | \"Standard_D13\"\n | \"Standard_D14\"\n | \"Standard_D1_v2\"\n | \"Standard_D2_v2\"\n | \"Standard_D3_v2\"\n | \"Standard_D4_v2\"\n | \"Standard_D5_v2\"\n | \"Standard_D2_v3\"\n | \"Standard_D4_v3\"\n | \"Standard_D8_v3\"\n | \"Standard_D16_v3\"\n | \"Standard_D32_v3\"\n | \"Standard_D64_v3\"\n | \"Standard_D2s_v3\"\n | \"Standard_D4s_v3\"\n | \"Standard_D8s_v3\"\n | \"Standard_D16s_v3\"\n | \"Standard_D32s_v3\"\n | \"Standard_D64s_v3\"\n | \"Standard_D11_v2\"\n | \"Standard_D12_v2\"\n | \"Standard_D13_v2\"\n | \"Standard_D14_v2\"\n | \"Standard_D15_v2\"\n | \"Standard_DS1\"\n | \"Standard_DS2\"\n | \"Standard_DS3\"\n | \"Standard_DS4\"\n | \"Standard_DS11\"\n | \"Standard_DS12\"\n | \"Standard_DS13\"\n | \"Standard_DS14\"\n | \"Standard_DS1_v2\"\n | \"Standard_DS2_v2\"\n | \"Standard_DS3_v2\"\n | \"Standard_DS4_v2\"\n | \"Standard_DS5_v2\"\n | \"Standard_DS11_v2\"\n | \"Standard_DS12_v2\"\n | \"Standard_DS13_v2\"\n | \"Standard_DS14_v2\"\n | \"Standard_DS15_v2\"\n | \"Standard_DS13-4_v2\"\n | \"Standard_DS13-2_v2\"\n | \"Standard_DS14-8_v2\"\n | \"Standard_DS14-4_v2\"\n | \"Standard_E2_v3\"\n | \"Standard_E4_v3\"\n | \"Standard_E8_v3\"\n | \"Standard_E16_v3\"\n | \"Standard_E32_v3\"\n | \"Standard_E64_v3\"\n | \"Standard_E2s_v3\"\n | \"Standard_E4s_v3\"\n | \"Standard_E8s_v3\"\n | \"Standard_E16s_v3\"\n | \"Standard_E32s_v3\"\n | \"Standard_E64s_v3\"\n | \"Standard_E32-16_v3\"\n | \"Standard_E32-8s_v3\"\n | \"Standard_E64-32s_v3\"\n | \"Standard_E64-16s_v3\"\n | \"Standard_F1\"\n | \"Standard_F2\"\n | \"Standard_F4\"\n | \"Standard_F8\"\n | \"Standard_F16\"\n | \"Standard_F1s\"\n | \"Standard_F2s\"\n | \"Standard_F4s\"\n | \"Standard_F8s\"\n | \"Standard_F16s\"\n | \"Standard_F2s_v2\"\n | \"Standard_F4s_v2\"\n | \"Standard_F8s_v2\"\n | \"Standard_F16s_v2\"\n | \"Standard_F32s_v2\"\n | \"Standard_F64s_v2\"\n | \"Standard_F72s_v2\"\n | \"Standard_G1\"\n | \"Standard_G2\"\n | \"Standard_G3\"\n | \"Standard_G4\"\n | \"Standard_G5\"\n | \"Standard_GS1\"\n | \"Standard_GS2\"\n | \"Standard_GS3\"\n | \"Standard_GS4\"\n | \"Standard_GS5\"\n | \"Standard_GS4-8\"\n | \"Standard_GS4-4\"\n | \"Standard_GS5-16\"\n | \"Standard_GS5-8\"\n | \"Standard_H8\"\n | \"Standard_H16\"\n | \"Standard_H8m\"\n | \"Standard_H16m\"\n | \"Standard_H16r\"\n | \"Standard_H16mr\"\n | \"Standard_L4s\"\n | \"Standard_L8s\"\n | \"Standard_L16s\"\n | \"Standard_L32s\"\n | \"Standard_M64s\"\n | \"Standard_M64ms\"\n | \"Standard_M128s\"\n | \"Standard_M128ms\"\n | \"Standard_M64-32ms\"\n | \"Standard_M64-16ms\"\n | \"Standard_M128-64ms\"\n | \"Standard_M128-32ms\"\n | \"Standard_NC6\"\n | \"Standard_NC12\"\n | \"Standard_NC24\"\n | \"Standard_NC24r\"\n | \"Standard_NC6s_v2\"\n | \"Standard_NC12s_v2\"\n | \"Standard_NC24s_v2\"\n | \"Standard_NC24rs_v2\"\n | \"Standard_NC6s_v3\"\n | \"Standard_NC12s_v3\"\n | \"Standard_NC24s_v3\"\n | \"Standard_NC24rs_v3\"\n | \"Standard_ND6s\"\n | \"Standard_ND12s\"\n | \"Standard_ND24s\"\n | \"Standard_ND24rs\"\n | \"Standard_NV6\"\n | \"Standard_NV12\"\n | \"Standard_NV24\";\n /** Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. <br><br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */\n vmSizeProperties?: VMSizeProperties;\n}\n\n/** Specifies the storage settings for the virtual machine disks. */\nexport interface StorageProfile {\n /** 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. */\n imageReference?: ImageReference;\n /** Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n osDisk?: OSDisk;\n /** Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n dataDisks?: Array<DataDisk>;\n /** Specifies the disk controller type configured for the VM. <br><br>NOTE: This property will be set to the default disk controller type if not specified provided virtual machine is being created as a hyperVGeneration: V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. <br>You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. <br><br> Minimum api-version: 2022-08-01 */\n diskControllerType?: \"SCSI\" | \"NVMe\";\n}\n\n/** Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\nexport interface OSDisk {\n /** 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. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType?: \"Windows\" | \"Linux\";\n /** Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15 */\n encryptionSettings?: DiskEncryptionSettings;\n /** The disk name. */\n name?: string;\n /** The virtual hard disk. */\n vhd?: VirtualHardDisk;\n /** 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. */\n image?: VirtualHardDisk;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None** for Standard storage. **ReadOnly** for Premium storage. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */\n diffDiskSettings?: DiffDiskSettings;\n /** Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The managed disk parameters. */\n managedDisk?: ManagedDiskParameters;\n /** Specifies whether OS Disk should be deleted or detached upon VM deletion. <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the os disk is retained after VM is deleted. <br><br> The default value is set to **detach**. For an ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for ephemeral OS Disk. */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** The parameters of a managed disk. */\nexport interface ManagedDiskParameters extends SubResource {\n /** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */\n storageAccountType?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n /** Specifies the customer managed disk encryption set resource id for the managed disk. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n /** Specifies the security profile for the managed disk. */\n securityProfile?: VMDiskSecurityProfile;\n}\n\n/** Describes a data disk. */\nexport interface DataDisk {\n /** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */\n lun: number;\n /** The disk name. */\n name?: string;\n /** The virtual hard disk. */\n vhd?: VirtualHardDisk;\n /** 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. */\n image?: VirtualHardDisk;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */\n writeAcceleratorEnabled?: boolean;\n /** Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */\n createOption: \"FromImage\" | \"Empty\" | \"Attach\";\n /** Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */\n diskSizeGB?: number;\n /** The managed disk parameters. */\n managedDisk?: ManagedDiskParameters;\n /** Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset */\n toBeDetached?: boolean;\n /** 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: **ForceDetach**. <br><br> 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. <br><br> 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'. */\n detachOption?: \"ForceDetach\";\n /** Specifies whether data disk should be deleted or detached upon VM deletion.<br><br> Possible values: <br><br> **Delete** If this value is used, the data disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the data disk is retained after VM is deleted.<br><br> The default value is set to **detach** */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. */\nexport interface OSProfile {\n /** Specifies the host OS name of the virtual machine. <br><br> This name cannot be updated after the VM is created. <br><br> **Max-length (Windows):** 15 characters <br><br> **Max-length (Linux):** 64 characters. <br><br> For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). */\n computerName?: string;\n /** Specifies the name of the administrator account. <br><br> This property cannot be updated after the VM is created. <br><br> **Windows-only restriction:** Cannot end in \".\" <br><br> **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters. */\n adminUsername?: string;\n /** Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\\W_]) <br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */\n adminPassword?: string;\n /** Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> **Note: Do not pass any secrets or passwords in customData property** <br><br> This property cannot be updated after the VM is created. <br><br> customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/) <br><br> For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) */\n customData?: string;\n /** Specifies Windows operating system settings on the virtual machine. */\n windowsConfiguration?: WindowsConfiguration;\n /** Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */\n linuxConfiguration?: LinuxConfiguration;\n /** Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */\n secrets?: Array<VaultSecretGroup>;\n /** Specifies whether extension operations should be allowed on the virtual machine. <br><br>This may only be set to False when no extensions are present on the virtual machine. */\n allowExtensionOperations?: boolean;\n /** Optional property which must either be set to True or omitted. */\n requireGuestProvisionSignal?: boolean;\n}\n\n/** Specifies the network interfaces or the networking configuration of the virtual machine. */\nexport interface NetworkProfile {\n /** Specifies the list of resource Ids for the network interfaces associated with the virtual machine. */\n networkInterfaces?: Array<NetworkInterfaceReference>;\n /** specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations */\n networkApiVersion?: \"2020-11-01\";\n /** Specifies the networking configurations that will be used to create the virtual machine networking resources. */\n networkInterfaceConfigurations?: Array<VirtualMachineNetworkInterfaceConfiguration>;\n}\n\n/** Describes a network interface reference. */\nexport interface NetworkInterfaceReference extends SubResource {\n /** Describes a network interface reference properties. */\n properties?: NetworkInterfaceReferenceProperties;\n}\n\n/** Describes a network interface reference properties. */\nexport interface NetworkInterfaceReferenceProperties {\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n}\n\n/** Describes a virtual machine network interface configurations. */\nexport interface VirtualMachineNetworkInterfaceConfiguration {\n /** The network interface configuration name. */\n name: string;\n /** Describes a virtual machine network profile's IP configuration. */\n properties?: VirtualMachineNetworkInterfaceConfigurationProperties;\n}\n\n/** Describes a virtual machine network profile's IP configuration. */\nexport interface VirtualMachineNetworkInterfaceConfigurationProperties {\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** Specify what happens to the network interface when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n /** Specifies whether the network interface is accelerated networking-enabled. */\n enableAcceleratedNetworking?: boolean;\n /** Specifies whether the network interface is disabled for tcp state tracking. */\n disableTcpStateTracking?: boolean;\n /** Specifies whether the network interface is FPGA networking-enabled. */\n enableFpga?: boolean;\n /** Whether IP forwarding enabled on this NIC. */\n enableIPForwarding?: boolean;\n /** The network security group. */\n networkSecurityGroup?: SubResource;\n /** The dns settings to be applied on the network interfaces. */\n dnsSettings?: VirtualMachineNetworkInterfaceDnsSettingsConfiguration;\n /** Specifies the IP configurations of the network interface. */\n ipConfigurations: Array<VirtualMachineNetworkInterfaceIPConfiguration>;\n dscpConfiguration?: SubResource;\n}\n\n/** Describes a virtual machines network configuration's DNS settings. */\nexport interface VirtualMachineNetworkInterfaceDnsSettingsConfiguration {\n /** List of DNS servers IP addresses */\n dnsServers?: Array<string>;\n}\n\n/** Describes a virtual machine network profile's IP configuration. */\nexport interface VirtualMachineNetworkInterfaceIPConfiguration {\n /** The IP configuration name. */\n name: string;\n /** Describes a virtual machine network interface IP configuration properties. */\n properties?: VirtualMachineNetworkInterfaceIPConfigurationProperties;\n}\n\n/** Describes a virtual machine network interface IP configuration properties. */\nexport interface VirtualMachineNetworkInterfaceIPConfigurationProperties {\n /** Specifies the identifier of the subnet. */\n subnet?: SubResource;\n /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */\n primary?: boolean;\n /** The publicIPAddressConfiguration. */\n publicIPAddressConfiguration?: VirtualMachinePublicIPAddressConfiguration;\n /** 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'. */\n privateIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specifies an array of references to application security group. */\n applicationSecurityGroups?: Array<SubResource>;\n /** Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. */\n applicationGatewayBackendAddressPools?: Array<SubResource>;\n /** Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. */\n loadBalancerBackendAddressPools?: Array<SubResource>;\n}\n\n/** Describes a virtual machines IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachinePublicIPAddressConfiguration {\n /** The publicIP address configuration name. */\n name: string;\n /** Describes a virtual machines IP Configuration's PublicIPAddress configuration */\n properties?: VirtualMachinePublicIPAddressConfigurationProperties;\n /** Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */\n sku?: PublicIPAddressSku;\n}\n\n/** Describes a virtual machines IP Configuration's PublicIPAddress configuration */\nexport interface VirtualMachinePublicIPAddressConfigurationProperties {\n /** The idle timeout of the public IP address. */\n idleTimeoutInMinutes?: number;\n /** Specify what happens to the public IP address when the VM is deleted */\n deleteOption?: \"Delete\" | \"Detach\";\n /** The dns settings to be applied on the publicIP addresses . */\n dnsSettings?: VirtualMachinePublicIPAddressDnsSettingsConfiguration;\n /** The list of IP tags associated with the public IP address. */\n ipTags?: Array<VirtualMachineIpTag>;\n /** The PublicIPPrefix from which to allocate publicIP addresses. */\n publicIPPrefix?: SubResource;\n /** 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'. */\n publicIPAddressVersion?: \"IPv4\" | \"IPv6\";\n /** Specify the public IP allocation type */\n publicIPAllocationMethod?: \"Dynamic\" | \"Static\";\n}\n\n/** Describes a virtual machines network configuration's DNS settings. */\nexport interface VirtualMachinePublicIPAddressDnsSettingsConfiguration {\n /** The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. */\n domainNameLabel: string;\n}\n\n/** Contains the IP tag associated with the public IP address. */\nexport interface VirtualMachineIpTag {\n /** IP tag type. Example: FirstPartyUsage. */\n ipTagType?: string;\n /** IP tag associated with the public IP. Example: SQL, Storage etc. */\n tag?: string;\n}\n\n/** Describes a virtual machine scale set VM network profile. */\nexport interface VirtualMachineScaleSetVMNetworkProfileConfiguration {\n /** The list of network configurations. */\n networkInterfaceConfigurations?: Array<VirtualMachineScaleSetNetworkConfiguration>;\n}\n\n/** The protection policy of a virtual machine scale set VM. */\nexport interface VirtualMachineScaleSetVMProtectionPolicy {\n /** Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. */\n protectFromScaleIn?: boolean;\n /** Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. */\n protectFromScaleSetActions?: boolean;\n}\n\n/** Describes a Virtual Machine Extension. */\nexport interface VirtualMachineExtension extends ResourceWithOptionalLocation {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionProperties;\n}\n\n/** The Resource model definition with location property as optional. */\nexport interface ResourceWithOptionalLocation {\n /** Resource location */\n location?: string;\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Identity for the virtual machine. */\nexport interface VirtualMachineIdentity {\n /** The type of identity used for the virtual machine. 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. */\n type?: \"SystemAssigned\" | \"UserAssigned\" | \"SystemAssigned, UserAssigned\" | \"None\";\n /** The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */\n userAssignedIdentities?: Record<string, UserAssignedIdentitiesValue>;\n}\n\n/** Describes a Virtual Machine Extension. */\nexport interface VirtualMachineExtensionUpdate extends UpdateResource {\n /** Describes the properties of a Virtual Machine Extension. */\n properties?: VirtualMachineExtensionUpdateProperties;\n}\n\n/** Describes a Virtual Machine. */\nexport interface VirtualMachine extends Resource {\n /** 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**. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine. */\n properties?: VirtualMachineProperties;\n /** The identity of the virtual machine, if configured. */\n identity?: VirtualMachineIdentity;\n /** The virtual machine zones. */\n zones?: Array<string>;\n /** The extended location of the Virtual Machine. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** Describes the properties of a Virtual Machine. */\nexport interface VirtualMachineProperties {\n /** Specifies the hardware settings for the virtual machine. */\n hardwareProfile?: HardwareProfile;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: StorageProfile;\n /** Specifies additional capabilities enabled or disabled on the virtual machine. */\n additionalCapabilities?: AdditionalCapabilities;\n /** Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. */\n osProfile?: OSProfile;\n /** Specifies the network interfaces of the virtual machine. */\n networkProfile?: NetworkProfile;\n /** Specifies the Security related profile settings for the virtual machine. */\n securityProfile?: SecurityProfile;\n /** Specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. <br><br>This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. */\n availabilitySet?: SubResource;\n /** Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. <br><br>This property cannot exist along with a non-null properties.availabilitySet reference. <br><br>Minimum api‐version: 2019‐03‐01 */\n virtualMachineScaleSet?: SubResource;\n /** Specifies information about the proximity placement group that the virtual machine should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n /** Specifies the priority for the virtual machine. <br><br>Minimum api-version: 2019-03-01 */\n priority?: \"Regular\" | \"Low\" | \"Spot\";\n /** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. <br><br>For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. <br><br>For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */\n evictionPolicy?: \"Deallocate\" | \"Delete\";\n /** Specifies the billing related details of a Azure Spot virtual machine. <br><br>Minimum api-version: 2019-03-01. */\n billingProfile?: BillingProfile;\n /** Specifies information about the dedicated host that the virtual machine resides in. <br><br>Minimum api-version: 2018-10-01. */\n host?: SubResource;\n /** Specifies information about the dedicated host group that the virtual machine resides in. <br><br>Minimum api-version: 2020-06-01. <br><br>NOTE: User cannot specify both host and hostGroup properties. */\n hostGroup?: SubResource;\n /** Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) <br><br> [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) <br><br> Minimum api-version: 2015-06-15 */\n licenseType?: string;\n /** Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). <br><br> Minimum api-version: 2020-06-01 */\n extensionsTimeBudget?: string;\n /** Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.<br><li>This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.<li>The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' &gt; 1.<li>This property cannot be updated once the Virtual Machine is created.<li>Fault domain assignment can be viewed in the Virtual Machine Instance View.<br><br>Minimum api‐version: 2020‐12‐01 */\n platformFaultDomain?: number;\n /** Specifies Scheduled Event related configurations. */\n scheduledEventsProfile?: ScheduledEventsProfile;\n /** UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. <br><br>Minimum api-version: 2021-03-01 */\n userData?: string;\n /** Specifies information about the capacity reservation that is used to allocate virtual machine. <br><br>Minimum api-version: 2021-04-01. */\n capacityReservation?: CapacityReservationProfile;\n /** Specifies the gallery applications that should be made available to the VM/VMSS */\n applicationProfile?: ApplicationProfile;\n}\n\n/** The instance view of a virtual machine. */\nexport interface VirtualMachineInstanceView {\n /** Specifies the update domain of the virtual machine. */\n platformUpdateDomain?: number;\n /** Specifies the fault domain of the virtual machine. */\n platformFaultDomain?: number;\n /** The computer name assigned to the virtual machine. */\n computerName?: string;\n /** The Operating System running on the virtual machine. */\n osName?: string;\n /** The version of Operating System running on the virtual machine. */\n osVersion?: string;\n /** Specifies the HyperVGeneration Type associated with a resource */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** The Remote desktop certificate thumbprint. */\n rdpThumbPrint?: string;\n /** The VM Agent running on the virtual machine. */\n vmAgent?: VirtualMachineAgentInstanceView;\n /** The Maintenance Operation status on the virtual machine. */\n maintenanceRedeployStatus?: MaintenanceRedeployStatus;\n /** The virtual machine disk information. */\n disks?: Array<DiskInstanceView>;\n /** The extensions information. */\n extensions?: Array<VirtualMachineExtensionInstanceView>;\n /** Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor. */\n bootDiagnostics?: BootDiagnosticsInstanceView;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n /** [Preview Feature] The status of virtual machine patch operations. */\n patchStatus?: VirtualMachinePatchStatus;\n}\n\n/** The status of virtual machine patch operations. */\nexport interface VirtualMachinePatchStatus {\n /** The available patch summary of the latest assessment operation for the virtual machine. */\n availablePatchSummary?: AvailablePatchSummary;\n /** The installation summary of the latest installation operation for the virtual machine. */\n lastPatchInstallationSummary?: LastPatchInstallationSummary;\n}\n\n/** Describes the properties of an virtual machine instance view for available patch summary. */\nexport interface AvailablePatchSummary {}\n\n/** Describes the properties of the last installed patch summary. */\nexport interface LastPatchInstallationSummary {}\n\n/** Capture Virtual Machine parameters. */\nexport interface VirtualMachineCaptureParameters {\n /** The captured virtual hard disk's name prefix. */\n vhdPrefix: string;\n /** The destination container name. */\n destinationContainerName: string;\n /** Specifies whether to overwrite the destination virtual hard disk, in case of conflict. */\n overwriteVhds: boolean;\n}\n\n/** Output of virtual machine capture operation. */\nexport interface VirtualMachineCaptureResult extends SubResource {}\n\n/** Describes a Virtual Machine Update. */\nexport interface VirtualMachineUpdate extends UpdateResource {\n /** 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**. */\n plan?: Plan;\n /** Describes the properties of a Virtual Machine. */\n properties?: VirtualMachineProperties;\n /** The identity of the virtual machine, if configured. */\n identity?: VirtualMachineIdentity;\n /** The virtual machine zones. */\n zones?: Array<string>;\n}\n\n/** Input for InstallPatches as directly received by the API */\nexport interface VirtualMachineInstallPatchesParameters {\n /** Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) */\n maximumDuration?: string;\n /** Defines when it is acceptable to reboot a VM during a software update operation. */\n rebootSetting: \"IfRequired\" | \"Never\" | \"Always\";\n /** Input for InstallPatches on a Windows VM, as directly received by the API */\n windowsParameters?: WindowsParameters;\n /** Input for InstallPatches on a Linux VM, as directly received by the API */\n linuxParameters?: LinuxParameters;\n}\n\n/** Input for InstallPatches on a Windows VM, as directly received by the API */\nexport interface WindowsParameters {\n /** The update classifications to select when installing patches for Windows. */\n classificationsToInclude?: Array<\n | \"Critical\"\n | \"Security\"\n | \"UpdateRollUp\"\n | \"FeaturePack\"\n | \"ServicePack\"\n | \"Definition\"\n | \"Tools\"\n | \"Updates\"\n >;\n /** Kbs to include in the patch operation */\n kbNumbersToInclude?: Array<string>;\n /** Kbs to exclude in the patch operation */\n kbNumbersToExclude?: Array<string>;\n /** Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. */\n excludeKbsRequiringReboot?: boolean;\n /** This is used to install patches that were published on or before this given max published date. */\n maxPatchPublishDate?: Date | string;\n}\n\n/** Input for InstallPatches on a Linux VM, as directly received by the API */\nexport interface LinuxParameters {\n /** The update classifications to select when installing patches for Linux. */\n classificationsToInclude?: Array<\"Critical\" | \"Security\" | \"Other\">;\n /** packages to include in the patch operation. Format: packageName_packageVersion */\n packageNameMasksToInclude?: Array<string>;\n /** packages to exclude in the patch operation. Format: packageName_packageVersion */\n packageNameMasksToExclude?: Array<string>;\n /** This is used as a maintenance run identifier for Auto VM Guest Patching in Linux. */\n maintenanceRunId?: string;\n}\n\n/** Describes a Virtual Machine Image. */\nexport interface VirtualMachineImage extends VirtualMachineImageResource {\n /** Describes the properties of a Virtual Machine Image. */\n properties?: VirtualMachineImageProperties;\n}\n\n/** Describes the properties of a Virtual Machine Image. */\nexport interface VirtualMachineImageProperties {\n /** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */\n plan?: PurchasePlan;\n /** Contains the os disk image information. */\n osDiskImage?: OSDiskImage;\n dataDiskImages?: Array<DataDiskImage>;\n /** Describes automatic OS upgrade properties on the image. */\n automaticOSUpgradeProperties?: AutomaticOSUpgradeProperties;\n /** Specifies the HyperVGeneration Type */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** Specifies disallowed configuration for the VirtualMachine created from the image */\n disallowed?: DisallowedConfiguration;\n features?: Array<VirtualMachineImageFeature>;\n /** Specifies the Architecture Type */\n architecture?: \"x64\" | \"Arm64\";\n}\n\n/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */\nexport interface PurchasePlan {\n /** The publisher ID. */\n publisher: string;\n /** The plan ID. */\n name: string;\n /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */\n product: string;\n}\n\n/** Contains the os disk image information. */\nexport interface OSDiskImage {\n /** The operating system of the osDiskImage. */\n operatingSystem: \"Windows\" | \"Linux\";\n}\n\n/** Contains the data disk images information. */\nexport interface DataDiskImage {}\n\n/** Describes automatic OS upgrade properties on the image. */\nexport interface AutomaticOSUpgradeProperties {\n /** Specifies whether automatic OS upgrade is supported on the image. */\n automaticOSUpgradeSupported: boolean;\n}\n\n/** Specifies the disallowed configuration for a virtual machine image. */\nexport interface DisallowedConfiguration {\n /** VM disk types which are disallowed. */\n vmDiskType?: \"None\" | \"Unmanaged\";\n}\n\n/** Specifies additional capabilities supported by the image */\nexport interface VirtualMachineImageFeature {\n /** The name of the feature. */\n name?: string;\n /** The corresponding value for the feature. */\n value?: string;\n}\n\n/** Virtual machine image resource information. */\nexport interface VirtualMachineImageResource extends SubResource {\n /** The name of the resource. */\n name: string;\n /** The supported Azure location of the resource. */\n location: string;\n /** Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md). */\n tags?: Record<string, string>;\n /** The extended location of the Virtual Machine. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** Describes a Virtual Machine Extension Image. */\nexport interface VirtualMachineExtensionImage extends Resource {\n /** Describes the properties of a Virtual Machine Extension Image. */\n properties?: VirtualMachineExtensionImageProperties;\n}\n\n/** Describes the properties of a Virtual Machine Extension Image. */\nexport interface VirtualMachineExtensionImageProperties {\n /** The operating system this extension supports. */\n operatingSystem: string;\n /** The type of role (IaaS or PaaS) this extension supports. */\n computeRole: string;\n /** The schema defined by publisher, where extension consumers should provide settings in a matching schema. */\n handlerSchema: string;\n /** Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS. */\n vmScaleSetEnabled?: boolean;\n /** Whether the handler can support multiple extensions. */\n supportsMultipleExtensions?: boolean;\n}\n\n/** 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](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). <br><br> For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. */\nexport interface AvailabilitySet extends Resource {\n /** The instance view of a resource. */\n properties?: AvailabilitySetProperties;\n /** Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. */\n sku?: Sku;\n}\n\n/** The instance view of a resource. */\nexport interface AvailabilitySetProperties {\n /** Update Domain count. */\n platformUpdateDomainCount?: number;\n /** Fault Domain count. */\n platformFaultDomainCount?: number;\n /** A list of references to all virtual machines in the availability set. */\n virtualMachines?: Array<SubResource>;\n /** Specifies information about the proximity placement group that the availability set should be assigned to. <br><br>Minimum api-version: 2018-04-01. */\n proximityPlacementGroup?: SubResource;\n}\n\n/** Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated. */\nexport interface AvailabilitySetUpdate extends UpdateResource {\n /** The instance view of a resource. */\n properties?: AvailabilitySetProperties;\n /** Sku of the availability set */\n sku?: Sku;\n}\n\n/** Specifies information about the proximity placement group. */\nexport interface ProximityPlacementGroup extends Resource {\n /** Describes the properties of a Proximity Placement Group. */\n properties?: ProximityPlacementGroupProperties;\n /** Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created. */\n zones?: Array<string>;\n}\n\n/** Describes the properties of a Proximity Placement Group. */\nexport interface ProximityPlacementGroupProperties {\n /** Specifies the type of the proximity placement group. <br><br> Possible values are: <br><br> **Standard** : Co-locate resources within an Azure region or Availability Zone. <br><br> **Ultra** : For future use. */\n proximityPlacementGroupType?: \"Standard\" | \"Ultra\";\n /** Describes colocation status of the Proximity Placement Group. */\n colocationStatus?: InstanceViewStatus;\n /** Specifies the user intent of the proximity placement group. */\n intent?: ProximityPlacementGroupPropertiesIntent;\n}\n\nexport interface SubResourceWithColocationStatus extends SubResource {\n /** Describes colocation status of a resource in the Proximity Placement Group. */\n colocationStatus?: InstanceViewStatus;\n}\n\n/** Specifies the user intent of the proximity placement group. */\nexport interface ProximityPlacementGroupPropertiesIntent {\n /** Specifies possible sizes of virtual machines that can be created in the proximity placement group. */\n vmSizes?: Array<string>;\n}\n\n/** Specifies information about the proximity placement group. */\nexport interface ProximityPlacementGroupUpdate extends UpdateResource {}\n\n/** Specifies information about the dedicated host group that the dedicated hosts should be assigned to. <br><br> 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. */\nexport interface DedicatedHostGroup extends Resource {\n /** Dedicated Host Group Properties. */\n properties?: DedicatedHostGroupProperties;\n /** Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. */\n zones?: Array<string>;\n}\n\n/** Dedicated Host Group Properties. */\nexport interface DedicatedHostGroupProperties {\n /** Number of fault domains that the host group can span. */\n platformFaultDomainCount: number;\n /** Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. <br><br>Minimum api-version: 2020-06-01. */\n supportAutomaticPlacement?: boolean;\n /** Enables or disables a capability on the dedicated host group.<br><br>Minimum api-version: 2022-03-01. */\n additionalCapabilities?: DedicatedHostGroupPropertiesAdditionalCapabilities;\n}\n\nexport interface DedicatedHostGroupInstanceView {\n /** List of instance view of the dedicated hosts under the dedicated host group. */\n hosts?: Array<DedicatedHostInstanceViewWithName>;\n}\n\n/** 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. */\nexport interface DedicatedHostInstanceViewWithName extends DedicatedHostInstanceView {}\n\n/** The instance view of a dedicated host. */\nexport interface DedicatedHostInstanceView {\n /** Unutilized capacity of the dedicated host. */\n availableCapacity?: DedicatedHostAvailableCapacity;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Dedicated host unutilized capacity. */\nexport interface DedicatedHostAvailableCapacity {\n /** The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. */\n allocatableVMs?: Array<DedicatedHostAllocatableVM>;\n}\n\n/** Represents the dedicated host unutilized capacity in terms of a specific VM size. */\nexport interface DedicatedHostAllocatableVM {\n /** VM size in terms of which the unutilized capacity is represented. */\n vmSize?: string;\n /** Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. */\n count?: number;\n}\n\n/** Enables or disables a capability on the dedicated host group.<br><br>Minimum api-version: 2022-03-01. */\nexport interface DedicatedHostGroupPropertiesAdditionalCapabilities {\n /** The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. <br><br>NOTE: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. <br><br>Minimum api-version: 2022-03-01. */\n ultraSSDEnabled?: boolean;\n}\n\n/** Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated. */\nexport interface DedicatedHostGroupUpdate extends UpdateResource {\n /** Dedicated Host Group Properties. */\n properties?: DedicatedHostGroupProperties;\n /** Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone. */\n zones?: Array<string>;\n}\n\n/** Specifies information about the Dedicated host. */\nexport interface DedicatedHost extends Resource {\n /** Properties of the dedicated host. */\n properties?: DedicatedHostProperties;\n /** SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values. */\n sku: Sku;\n}\n\n/** Properties of the dedicated host. */\nexport interface DedicatedHostProperties {\n /** Fault domain of the dedicated host within a dedicated host group. */\n platformFaultDomain?: number;\n /** Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. */\n autoReplaceOnFailure?: boolean;\n /** Specifies the software license type that will be applied to the VMs deployed on the dedicated host. <br><br> Possible values are: <br><br> **None** <br><br> **Windows_Server_Hybrid** <br><br> **Windows_Server_Perpetual** <br><br> Default: **None** */\n licenseType?: \"None\" | \"Windows_Server_Hybrid\" | \"Windows_Server_Perpetual\";\n}\n\n/** Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated. */\nexport interface DedicatedHostUpdate extends UpdateResource {\n /** Properties of the dedicated host. */\n properties?: DedicatedHostProperties;\n}\n\n/** Specifies information about the SSH public key. */\nexport interface SshPublicKeyResource extends Resource {\n /** Properties of the SSH public key. */\n properties?: SshPublicKeyResourceProperties;\n}\n\n/** Properties of the SSH public key. */\nexport interface SshPublicKeyResourceProperties {\n /** SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. */\n publicKey?: string;\n}\n\n/** Specifies information about the SSH public key. */\nexport interface SshPublicKeyUpdateResource extends UpdateResource {\n /** Properties of the SSH public key. */\n properties?: SshPublicKeyResourceProperties;\n}\n\n/** 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. */\nexport interface Image extends Resource {\n /** Describes the properties of an Image. */\n properties?: ImageProperties;\n /** The extended location of the Image. */\n extendedLocation?: ExtendedLocation;\n}\n\n/** Describes the properties of an Image. */\nexport interface ImageProperties {\n /** The source virtual machine from which Image is created. */\n sourceVirtualMachine?: SubResource;\n /** Specifies the storage settings for the virtual machine disks. */\n storageProfile?: ImageStorageProfile;\n /** Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource. */\n hyperVGeneration?: \"V1\" | \"V2\";\n}\n\n/** Describes a storage profile. */\nexport interface ImageStorageProfile {\n /** Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n osDisk?: ImageOSDisk;\n /** Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */\n dataDisks?: Array<ImageDataDisk>;\n /** Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). */\n zoneResilient?: boolean;\n}\n\n/** Describes an Operating System disk. */\nexport interface ImageOSDisk extends ImageDisk {\n /** This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType: \"Windows\" | \"Linux\";\n /** The OS State. For managed images, use Generalized. */\n osState: \"Generalized\" | \"Specialized\";\n}\n\n/** Describes a image disk. */\nexport interface ImageDisk {\n /** The snapshot. */\n snapshot?: SubResource;\n /** The managedDisk. */\n managedDisk?: SubResource;\n /** The Virtual Hard Disk. */\n blobUri?: string;\n /** Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage** */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB */\n diskSizeGB?: number;\n /** Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */\n storageAccountType?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n /** Specifies the customer managed disk encryption set resource id for the managed image disk. */\n diskEncryptionSet?: DiskEncryptionSetParameters;\n}\n\n/** Describes a data disk. */\nexport interface ImageDataDisk extends ImageDisk {\n /** Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */\n lun: number;\n}\n\n/** The source user image virtual hard disk. Only tags may be updated. */\nexport interface ImageUpdate extends UpdateResource {\n /** Describes the properties of an Image. */\n properties?: ImageProperties;\n}\n\n/** Create or update Restore Point collection parameters. */\nexport interface RestorePointCollection extends Resource {\n /** The restore point collection properties. */\n properties?: RestorePointCollectionProperties;\n}\n\n/** The restore point collection properties. */\nexport interface RestorePointCollectionProperties {\n /** The properties of the source resource that this restore point collection is created from. */\n source?: RestorePointCollectionSourceProperties;\n}\n\n/** The properties of the source resource that this restore point collection is created from. */\nexport interface RestorePointCollectionSourceProperties {\n /** Resource Id of the source resource used to create this restore point collection */\n id?: string;\n}\n\n/** Restore Point details. */\nexport interface RestorePoint extends ProxyResource {\n /** The restore point properties. */\n properties?: RestorePointProperties;\n}\n\n/** The restore point properties. */\nexport interface RestorePointProperties {\n /** List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. */\n excludeDisks?: Array<ApiEntityReference>;\n /** 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. */\n consistencyMode?: \"CrashConsistent\" | \"FileSystemConsistent\" | \"ApplicationConsistent\";\n /** Gets the creation time of the restore point. */\n timeCreated?: Date | string;\n /** Resource Id of the source restore point from which a copy needs to be created. */\n sourceRestorePoint?: ApiEntityReference;\n}\n\n/** 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. */\nexport interface RestorePointSourceMetadata {\n /** Gets the hardware profile. */\n hardwareProfile?: HardwareProfile;\n /** Gets the storage profile. */\n storageProfile?: RestorePointSourceVMStorageProfile;\n /** Gets the OS profile. */\n osProfile?: OSProfile;\n /** Gets the diagnostics profile. */\n diagnosticsProfile?: DiagnosticsProfile;\n /** Gets the license type, which is for bring your own license scenario. */\n licenseType?: string;\n /** Gets the virtual machine unique id. */\n vmId?: string;\n /** Gets the security profile. */\n securityProfile?: SecurityProfile;\n /** Location of the VM from which the restore point was created. */\n location?: string;\n}\n\n/** Describes the storage profile. */\nexport interface RestorePointSourceVMStorageProfile {\n /** Gets the OS disk of the VM captured at the time of the restore point creation. */\n osDisk?: RestorePointSourceVmosDisk;\n /** Gets the data disks of the VM captured at the time of the restore point creation. */\n dataDisks?: Array<RestorePointSourceVMDataDisk>;\n}\n\n/** Describes an Operating System disk. */\nexport interface RestorePointSourceVmosDisk {\n /** Gets the Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** Gets the disk encryption settings. */\n encryptionSettings?: DiskEncryptionSettings;\n /** Gets the disk name. */\n name?: string;\n /** Gets the caching type. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Gets the disk size in GB. */\n diskSizeGB?: number;\n /** Gets the managed disk details */\n managedDisk?: ManagedDiskParameters;\n /** Gets the disk restore point Id. */\n diskRestorePoint?: ApiEntityReference;\n}\n\n/** Describes a data disk. */\nexport interface RestorePointSourceVMDataDisk {\n /** Gets the logical unit number. */\n lun?: number;\n /** Gets the disk name. */\n name?: string;\n /** Gets the caching type. */\n caching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. */\n diskSizeGB?: number;\n /** Gets the managed disk details */\n managedDisk?: ManagedDiskParameters;\n /** Gets the disk restore point Id. */\n diskRestorePoint?: ApiEntityReference;\n}\n\n/** The instance view of a restore point. */\nexport interface RestorePointInstanceView {\n /** The disk restore points information. */\n diskRestorePoints?: Array<DiskRestorePointInstanceView>;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** The instance view of a disk restore point. */\nexport interface DiskRestorePointInstanceView {\n /** Disk restore point Id. */\n id?: string;\n /** The disk restore point replication status information. */\n replicationStatus?: DiskRestorePointReplicationStatus;\n}\n\n/** The instance view of a disk restore point. */\nexport interface DiskRestorePointReplicationStatus {\n /** The resource status information. */\n status?: InstanceViewStatus;\n /** Replication completion percentage. */\n completionPercent?: number;\n}\n\n/** The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location */\nexport interface ProxyResource {}\n\n/** Update Restore Point collection parameters. */\nexport interface RestorePointCollectionUpdate extends UpdateResource {\n /** The restore point collection properties. */\n properties?: RestorePointCollectionProperties;\n}\n\n/** Specifies information about the capacity reservation group that the capacity reservations should be assigned to. <br><br> 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. */\nexport interface CapacityReservationGroup extends Resource {\n /** capacity reservation group Properties. */\n properties?: CapacityReservationGroupProperties;\n /** Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. */\n zones?: Array<string>;\n}\n\n/** capacity reservation group Properties. */\nexport interface CapacityReservationGroupProperties {}\n\nexport interface CapacityReservationGroupInstanceView {}\n\n/** 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. */\nexport interface CapacityReservationInstanceViewWithName extends CapacityReservationInstanceView {}\n\n/** 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. */\nexport interface CapacityReservationInstanceView {\n /** Unutilized capacity of the capacity reservation. */\n utilizationInfo?: CapacityReservationUtilization;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Represents the capacity reservation utilization in terms of resources allocated. */\nexport interface CapacityReservationUtilization {}\n\n/** Specifies information about the capacity reservation group. Only tags can be updated. */\nexport interface CapacityReservationGroupUpdate extends UpdateResource {\n /** capacity reservation group Properties. */\n properties?: CapacityReservationGroupProperties;\n}\n\n/** Specifies information about the capacity reservation. */\nexport interface CapacityReservation extends Resource {\n /** Properties of the Capacity reservation. */\n properties?: CapacityReservationProperties;\n /** SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. */\n sku: Sku;\n /** Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. */\n zones?: Array<string>;\n}\n\n/** Properties of the Capacity reservation. */\nexport interface CapacityReservationProperties {}\n\n/** Specifies information about the capacity reservation. Only tags and sku.capacity can be updated. */\nexport interface CapacityReservationUpdate extends UpdateResource {\n /** Properties of the Capacity reservation. */\n properties?: CapacityReservationProperties;\n /** SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. */\n sku?: Sku;\n}\n\n/** Api request input for LogAnalytics getRequestRateByInterval Api. */\nexport interface RequestRateByIntervalInput extends LogAnalyticsInputBase {\n /** Interval value in minutes used to create LogAnalytics call rate logs. */\n intervalLength: \"ThreeMins\" | \"FiveMins\" | \"ThirtyMins\" | \"SixtyMins\";\n}\n\n/** Api input base class for LogAnalytics Api. */\nexport interface LogAnalyticsInputBase {\n /** SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. */\n blobContainerSasUri: string;\n /** From time of the query */\n fromTime: Date | string;\n /** To time of the query */\n toTime: Date | string;\n /** Group query result by Throttle Policy applied. */\n groupByThrottlePolicy?: boolean;\n /** Group query result by Operation Name. */\n groupByOperationName?: boolean;\n /** Group query result by Resource Name. */\n groupByResourceName?: boolean;\n /** Group query result by Client Application ID. */\n groupByClientApplicationId?: boolean;\n /** Group query result by User Agent. */\n groupByUserAgent?: boolean;\n}\n\n/** Api request input for LogAnalytics getThrottledRequests Api. */\nexport interface ThrottledRequestsInput extends LogAnalyticsInputBase {}\n\n/** Capture Virtual Machine parameters. */\nexport interface RunCommandInput {\n /** The run command id. */\n commandId: string;\n /** Optional. The script to be executed. When this value is given, the given script will override the default script of the command. */\n script?: Array<string>;\n /** The run command parameters. */\n parameters?: Array<RunCommandInputParameter>;\n}\n\n/** Describes the properties of a run command parameter. */\nexport interface RunCommandInputParameter {\n /** The run command parameter name. */\n name: string;\n /** The run command parameter value. */\n value: string;\n}\n\n/** Describes a Virtual Machine run command. */\nexport interface VirtualMachineRunCommand extends Resource {\n /** Describes the properties of a Virtual Machine run command. */\n properties?: VirtualMachineRunCommandProperties;\n}\n\n/** Describes the properties of a Virtual Machine run command. */\nexport interface VirtualMachineRunCommandProperties {\n /** The source of the run command script. */\n source?: VirtualMachineRunCommandScriptSource;\n /** The parameters used by the script. */\n parameters?: Array<RunCommandInputParameter>;\n /** The parameters used by the script. */\n protectedParameters?: Array<RunCommandInputParameter>;\n /** Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete. */\n asyncExecution?: boolean;\n /** Specifies the user account on the VM when executing the run command. */\n runAsUser?: string;\n /** Specifies the user account password on the VM when executing the run command. */\n runAsPassword?: string;\n /** The timeout in seconds to execute the run command. */\n timeoutInSeconds?: number;\n /** Specifies the Azure storage blob where script output stream will be uploaded. */\n outputBlobUri?: string;\n /** Specifies the Azure storage blob where script error stream will be uploaded. */\n errorBlobUri?: string;\n}\n\n/** Describes the script sources for run command. */\nexport interface VirtualMachineRunCommandScriptSource {\n /** Specifies the script content to be executed on the VM. */\n script?: string;\n /** Specifies the script download location. */\n scriptUri?: string;\n /** Specifies a commandId of predefined built-in script. */\n commandId?: string;\n}\n\n/** The instance view of a virtual machine run command. */\nexport interface VirtualMachineRunCommandInstanceView {\n /** Script execution status. */\n executionState?:\n | \"Unknown\"\n | \"Pending\"\n | \"Running\"\n | \"Failed\"\n | \"Succeeded\"\n | \"TimedOut\"\n | \"Canceled\";\n /** Communicate script configuration errors or execution messages. */\n executionMessage?: string;\n /** Exit code returned from script execution. */\n exitCode?: number;\n /** Script output stream. */\n output?: string;\n /** Script error stream. */\n error?: string;\n /** Script start time. */\n startTime?: Date | string;\n /** Script end time. */\n endTime?: Date | string;\n /** The resource status information. */\n statuses?: Array<InstanceViewStatus>;\n}\n\n/** Describes a Virtual Machine run command. */\nexport interface VirtualMachineRunCommandUpdate extends UpdateResource {\n /** Describes the properties of a Virtual Machine run command. */\n properties?: VirtualMachineRunCommandProperties;\n}\n\n/** Disk resource. */\nexport interface Disk extends Resource {\n /** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */\n sku?: DiskSku;\n /** The Logical zone list for Disk. */\n zones?: Array<string>;\n /** The extended location where the disk will be created. Extended location cannot be changed. */\n extendedLocation?: ExtendedLocation;\n /** Disk resource properties. */\n properties?: DiskProperties;\n}\n\n/** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */\nexport interface DiskSku {\n /** The sku name. */\n name?:\n | \"Standard_LRS\"\n | \"Premium_LRS\"\n | \"StandardSSD_LRS\"\n | \"UltraSSD_LRS\"\n | \"Premium_ZRS\"\n | \"StandardSSD_ZRS\"\n | \"PremiumV2_LRS\";\n}\n\n/** Disk resource properties. */\nexport interface DiskProperties {\n /** The Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} */\n purchasePlan?: PurchasePlanAutoGenerated;\n /** List of supported capabilities for the image from which the OS disk was created. */\n supportedCapabilities?: SupportedCapabilities;\n /** Disk source information. CreationData information cannot be changed after the disk has been created. */\n creationData: CreationData;\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadWrite?: number;\n /** The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadWrite?: number;\n /** The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadOnly?: number;\n /** The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadOnly?: number;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. */\n maxShares?: number;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. */\n tier?: string;\n /** Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. */\n burstingEnabled?: boolean;\n /** Indicates the OS on a disk supports hibernation. */\n supportsHibernation?: boolean;\n /** Contains the security related information for the resource. */\n securityProfile?: DiskSecurityProfile;\n /** Percentage complete for the background copy when a resource is created via the CopyStart operation. */\n completionPercent?: number;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n /** Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. */\n optimizedForFrequentAttach?: boolean;\n}\n\n/** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */\nexport interface PurchasePlanAutoGenerated {\n /** The plan ID. */\n name: string;\n /** The publisher ID. */\n publisher: string;\n /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */\n product: string;\n /** The Offer Promotion Code. */\n promotionCode?: string;\n}\n\n/** List of supported capabilities persisted on the disk resource for VM use. */\nexport interface SupportedCapabilities {\n /** The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. */\n diskControllerTypes?: string;\n /** True if the image from which the OS disk is created supports accelerated networking. */\n acceleratedNetwork?: boolean;\n /** CPU architecture supported by an OS disk. */\n architecture?: \"x64\" | \"Arm64\";\n}\n\n/** Data used when creating a disk. */\nexport interface CreationData {\n /** This enumerates the possible sources of a disk's creation. */\n createOption:\n | \"Empty\"\n | \"Attach\"\n | \"FromImage\"\n | \"Import\"\n | \"Copy\"\n | \"Restore\"\n | \"Upload\"\n | \"CopyStart\"\n | \"ImportSecure\"\n | \"UploadPreparedSecure\";\n /** Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. */\n storageAccountId?: string;\n /** Disk source information for PIR or user images. */\n imageReference?: ImageDiskReference;\n /** Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. */\n galleryImageReference?: ImageDiskReference;\n /** If createOption is Import, this is the URI of a blob to be imported into a managed disk. */\n sourceUri?: string;\n /** If createOption is Copy, this is the ARM id of the source snapshot or disk. */\n sourceResourceId?: string;\n /** If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer). */\n uploadSizeBytes?: number;\n /** Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. */\n logicalSectorSize?: number;\n /** If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. */\n securityDataUri?: string;\n /** Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled. */\n performancePlus?: boolean;\n}\n\n/** The source image used for creating the disk. */\nexport interface ImageDiskReference {\n /** A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. */\n id?: string;\n /** A relative uri containing a direct shared Azure Compute Gallery image reference. */\n sharedGalleryImageId?: string;\n /** A relative uri containing a community Azure Compute Gallery image reference. */\n communityGalleryImageId?: string;\n /** If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null. */\n lun?: number;\n}\n\n/** Encryption settings for disk or snapshot */\nexport interface EncryptionSettingsCollection {\n /** Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged. */\n enabled: boolean;\n /** A collection of encryption settings, one for each disk volume. */\n encryptionSettings?: Array<EncryptionSettingsElement>;\n /** Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption. */\n encryptionSettingsVersion?: string;\n}\n\n/** Encryption settings for one disk volume. */\nexport interface EncryptionSettingsElement {\n /** Key Vault Secret Url and vault id of the disk encryption key */\n diskEncryptionKey?: KeyVaultAndSecretReference;\n /** Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. */\n keyEncryptionKey?: KeyVaultAndKeyReference;\n}\n\n/** Key Vault Secret Url and vault id of the encryption key */\nexport interface KeyVaultAndSecretReference {\n /** Resource id of the KeyVault containing the key or secret */\n sourceVault: SourceVault;\n /** Url pointing to a key or secret in KeyVault */\n secretUrl: string;\n}\n\n/** The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} */\nexport interface SourceVault {\n /** Resource Id */\n id?: string;\n}\n\n/** Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey */\nexport interface KeyVaultAndKeyReference {\n /** Resource id of the KeyVault containing the key or secret */\n sourceVault: SourceVault;\n /** Url pointing to a key or secret in KeyVault */\n keyUrl: string;\n}\n\n/** Encryption at rest settings for disk or snapshot */\nexport interface Encryption {\n /** ResourceId of the disk encryption set to use for enabling encryption at rest. */\n diskEncryptionSetId?: string;\n /** The type of key used to encrypt the data of the disk. */\n type?:\n | \"EncryptionAtRestWithPlatformKey\"\n | \"EncryptionAtRestWithCustomerKey\"\n | \"EncryptionAtRestWithPlatformAndCustomerKeys\";\n}\n\nexport interface ShareInfoElement {}\n\n/** Properties of the disk for which update is pending. */\nexport interface PropertyUpdatesInProgress {\n /** The target performance tier of the disk if a tier change operation is in progress. */\n targetTier?: string;\n}\n\n/** Contains the security related information for the resource. */\nexport interface DiskSecurityProfile {\n /** Specifies the SecurityType of the VM. Applicable for OS disks only. */\n securityType?:\n | \"TrustedLaunch\"\n | \"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey\"\n | \"ConfidentialVM_DiskEncryptedWithPlatformKey\"\n | \"ConfidentialVM_DiskEncryptedWithCustomerKey\";\n /** ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key */\n secureVMDiskEncryptionSetId?: string;\n}\n\n/** Disk update resource. */\nexport interface DiskUpdate {\n /** Disk resource update properties. */\n properties?: DiskUpdateProperties;\n /** Resource tags */\n tags?: Record<string, string>;\n /** The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */\n sku?: DiskSku;\n}\n\n/** Disk resource update properties. */\nexport interface DiskUpdateProperties {\n /** the Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadWrite?: number;\n /** The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadWrite?: number;\n /** The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes. */\n diskIOPSReadOnly?: number;\n /** The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. */\n diskMBpsReadOnly?: number;\n /** The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time. */\n maxShares?: number;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks. */\n tier?: string;\n /** Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks. */\n burstingEnabled?: boolean;\n /** Purchase plan information to be added on the OS disk */\n purchasePlan?: PurchasePlanAutoGenerated;\n /** List of supported capabilities to be added on the OS disk. */\n supportedCapabilities?: SupportedCapabilities;\n /** Indicates the OS on a disk supports hibernation. */\n supportsHibernation?: boolean;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n /** Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine. */\n optimizedForFrequentAttach?: boolean;\n}\n\n/** Data used for requesting a SAS. */\nexport interface GrantAccessData {\n access: \"None\" | \"Read\" | \"Write\";\n /** Time duration in seconds until the SAS access expires. */\n durationInSeconds: number;\n /** Set this flag to true to get additional SAS for VM guest state */\n getSecureVMGuestStateSAS?: boolean;\n}\n\n/** disk access resource. */\nexport interface DiskAccess extends Resource {\n properties?: DiskAccessProperties;\n /** The extended location where the disk access will be created. Extended location cannot be changed. */\n extendedLocation?: ExtendedLocation;\n}\n\nexport interface DiskAccessProperties {}\n\n/** The Private Endpoint Connection resource. */\nexport interface PrivateEndpointConnection {\n /** Resource properties. */\n properties?: PrivateEndpointConnectionProperties;\n}\n\n/** Properties of the PrivateEndpointConnectProperties. */\nexport interface PrivateEndpointConnectionProperties {\n /** A collection of information about the state of the connection between DiskAccess and Virtual Network. */\n privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;\n}\n\n/** The Private Endpoint resource. */\nexport interface PrivateEndpoint {}\n\n/** A collection of information about the state of the connection between service consumer and provider. */\nexport interface PrivateLinkServiceConnectionState {\n /** Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */\n status?: \"Pending\" | \"Approved\" | \"Rejected\";\n /** The reason for approval/rejection of the connection. */\n description?: string;\n /** A message indicating if changes on the service provider require any updates on the consumer. */\n actionsRequired?: string;\n}\n\n/** Used for updating a disk access resource. */\nexport interface DiskAccessUpdate {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** disk encryption set resource. */\nexport interface DiskEncryptionSet extends Resource {\n /** 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. */\n identity?: EncryptionSetIdentity;\n properties?: EncryptionSetProperties;\n}\n\n/** 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. */\nexport interface EncryptionSetIdentity {\n /** 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. */\n type?: \"SystemAssigned\" | \"UserAssigned\" | \"SystemAssigned, UserAssigned\" | \"None\";\n /** The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */\n userAssignedIdentities?: Record<string, UserAssignedIdentitiesValue>;\n}\n\nexport interface EncryptionSetProperties {\n /** The type of key used to encrypt the data of the disk. */\n encryptionType?:\n | \"EncryptionAtRestWithCustomerKey\"\n | \"EncryptionAtRestWithPlatformAndCustomerKeys\"\n | \"ConfidentialVmEncryptedWithCustomerKey\";\n /** The key vault key which is currently used by this disk encryption set. */\n activeKey?: KeyForDiskEncryptionSet;\n /** Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. */\n rotationToLatestKeyVersionEnabled?: boolean;\n /** Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. */\n federatedClientId?: string;\n}\n\n/** Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */\nexport interface KeyForDiskEncryptionSet {\n /** Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. */\n sourceVault?: SourceVault;\n /** Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. */\n keyUrl: string;\n}\n\n/** disk encryption set update resource. */\nexport interface DiskEncryptionSetUpdate {\n /** disk encryption set resource update properties. */\n properties?: DiskEncryptionSetUpdateProperties;\n /** Resource tags */\n tags?: Record<string, string>;\n /** 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. */\n identity?: EncryptionSetIdentity;\n}\n\n/** disk encryption set resource update properties. */\nexport interface DiskEncryptionSetUpdateProperties {\n /** The type of key used to encrypt the data of the disk. */\n encryptionType?:\n | \"EncryptionAtRestWithCustomerKey\"\n | \"EncryptionAtRestWithPlatformAndCustomerKeys\"\n | \"ConfidentialVmEncryptedWithCustomerKey\";\n /** Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */\n activeKey?: KeyForDiskEncryptionSet;\n /** Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. */\n rotationToLatestKeyVersionEnabled?: boolean;\n /** Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. */\n federatedClientId?: string;\n}\n\n/** Snapshot resource. */\nexport interface Snapshot extends Resource {\n /** 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 */\n sku?: SnapshotSku;\n /** The extended location where the snapshot will be created. Extended location cannot be changed. */\n extendedLocation?: ExtendedLocation;\n /** Snapshot resource properties. */\n properties?: SnapshotProperties;\n}\n\n/** 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 */\nexport interface SnapshotSku {\n /** The sku name. */\n name?: \"Standard_LRS\" | \"Premium_LRS\" | \"Standard_ZRS\";\n}\n\n/** Snapshot resource properties. */\nexport interface SnapshotProperties {\n /** The Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** Purchase plan information for the image from which the source disk for the snapshot was originally created. */\n purchasePlan?: PurchasePlanAutoGenerated;\n /** List of supported capabilities for the image from which the source disk from the snapshot was originally created. */\n supportedCapabilities?: SupportedCapabilities;\n /** Disk source information. CreationData information cannot be changed after the disk has been created. */\n creationData: CreationData;\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. */\n incremental?: boolean;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Contains the security related information for the resource. */\n securityProfile?: DiskSecurityProfile;\n /** Indicates the OS on a snapshot supports hibernation. */\n supportsHibernation?: boolean;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Percentage complete for the background copy when a resource is created via the CopyStart operation. */\n completionPercent?: number;\n /** Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */\n copyCompletionError?: CopyCompletionError;\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n}\n\n/** Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */\nexport interface CopyCompletionError {\n /** Indicates the error code if the background copy of a resource created via the CopyStart operation fails. */\n errorCode: \"CopySourceNotFound\";\n /** Indicates the error message if the background copy of a resource created via the CopyStart operation fails. */\n errorMessage: string;\n}\n\n/** Snapshot update resource. */\nexport interface SnapshotUpdate {\n /** Snapshot resource update properties. */\n properties?: SnapshotUpdateProperties;\n /** Resource tags */\n tags?: Record<string, string>;\n /** 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 */\n sku?: SnapshotSku;\n}\n\n/** Snapshot resource update properties. */\nexport interface SnapshotUpdateProperties {\n /** the Operating System type. */\n osType?: \"Windows\" | \"Linux\";\n /** If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size. */\n diskSizeGB?: number;\n /** Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. */\n encryptionSettingsCollection?: EncryptionSettingsCollection;\n /** Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. */\n encryption?: Encryption;\n /** Policy for accessing the disk via network. */\n networkAccessPolicy?: \"AllowAll\" | \"AllowPrivate\" | \"DenyAll\";\n /** ARM id of the DiskAccess resource for using private endpoints on disks. */\n diskAccessId?: string;\n /** Indicates the OS on a snapshot supports hibernation. */\n supportsHibernation?: boolean;\n /** Policy for controlling export on the disk. */\n publicNetworkAccess?: \"Enabled\" | \"Disabled\";\n /** Additional authentication requirements when exporting or uploading to a disk or snapshot. */\n dataAccessAuthMode?: \"AzureActiveDirectory\" | \"None\";\n /** List of supported capabilities for the image from which the OS disk was created. */\n supportedCapabilities?: SupportedCapabilities;\n}\n\n/** Specifies information about the Shared Image Gallery that you want to create or update. */\nexport interface Gallery extends Resource {\n /** Describes the properties of a Shared Image Gallery. */\n properties?: GalleryProperties;\n}\n\n/** Describes the properties of a Shared Image Gallery. */\nexport interface GalleryProperties {\n /** The description of this Shared Image Gallery resource. This property is updatable. */\n description?: string;\n /** Describes the gallery unique name. */\n identifier?: GalleryIdentifier;\n /** Profile for gallery sharing to subscription or tenant */\n sharingProfile?: SharingProfile;\n /** Contains information about the soft deletion policy of the gallery. */\n softDeletePolicy?: SoftDeletePolicy;\n}\n\n/** Describes the gallery unique name. */\nexport interface GalleryIdentifier {}\n\n/** Profile for gallery sharing to subscription or tenant */\nexport interface SharingProfile {\n /** This property allows you to specify the permission of sharing gallery. <br><br> Possible values are: <br><br> **Private** <br><br> **Groups** <br><br> **Community** */\n permissions?: \"Private\" | \"Groups\" | \"Community\";\n /** Information of community gallery if current gallery is shared to community. */\n communityGalleryInfo?: CommunityGalleryInfo;\n}\n\n/** Group of the gallery sharing profile */\nexport interface SharingProfileGroup {\n /** This property allows you to specify the type of sharing group. <br><br> Possible values are: <br><br> **Subscriptions** <br><br> **AADTenants** */\n type?: \"Subscriptions\" | \"AADTenants\";\n /** A list of subscription/tenant ids the gallery is aimed to be shared to. */\n ids?: Array<string>;\n}\n\n/** Information of community gallery if current gallery is shared to community */\nexport interface CommunityGalleryInfo {\n /** The link to the publisher website. Visible to all users. */\n publisherUri?: string;\n /** Community gallery publisher support email. The email address of the publisher. Visible to all users. */\n publisherContact?: string;\n /** End-user license agreement for community gallery image. */\n eula?: string;\n /** The prefix of the gallery name that will be displayed publicly. Visible to all users. */\n publicNamePrefix?: string;\n}\n\n/** Contains information about the soft deletion policy of the gallery. */\nexport interface SoftDeletePolicy {\n /** Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. */\n isSoftDeleteEnabled?: boolean;\n}\n\n/** Sharing status of current gallery. */\nexport interface SharingStatus {\n /** Summary of all regional sharing status. */\n summary?: Array<RegionalSharingStatus>;\n}\n\n/** Gallery regional sharing status */\nexport interface RegionalSharingStatus {\n /** Region name */\n region?: string;\n /** Details of gallery regional sharing failure. */\n details?: string;\n}\n\n/** Specifies information about the Shared Image Gallery that you want to update. */\nexport interface GalleryUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a Shared Image Gallery. */\n properties?: GalleryProperties;\n}\n\n/** The Update Resource model definition. */\nexport interface UpdateResourceDefinition {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Specifies information about the gallery image definition that you want to create or update. */\nexport interface GalleryImage extends Resource {\n /** Describes the properties of a gallery image definition. */\n properties?: GalleryImageProperties;\n}\n\n/** Describes the properties of a gallery image definition. */\nexport interface GalleryImageProperties {\n /** The description of this gallery image definition resource. This property is updatable. */\n description?: string;\n /** The Eula agreement for the gallery image definition. */\n eula?: string;\n /** The privacy statement uri. */\n privacyStatementUri?: string;\n /** The release note uri. */\n releaseNoteUri?: string;\n /** This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n osType: \"Windows\" | \"Linux\";\n /** This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. */\n osState: \"Generalized\" | \"Specialized\";\n /** The hypervisor generation of the Virtual Machine. Applicable to OS disks only. */\n hyperVGeneration?: \"V1\" | \"V2\";\n /** The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. */\n endOfLifeDate?: Date | string;\n /** This is the gallery image definition identifier. */\n identifier: GalleryImageIdentifier;\n /** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */\n recommended?: RecommendedMachineConfiguration;\n /** Describes the disallowed disk types. */\n disallowed?: Disallowed;\n /** Describes the gallery image definition purchase plan. This is used by marketplace images. */\n purchasePlan?: ImagePurchasePlan;\n /** A list of gallery image features. */\n features?: Array<GalleryImageFeature>;\n /** The architecture of the image. Applicable to OS disks only. */\n architecture?: \"x64\" | \"Arm64\";\n}\n\n/** This is the gallery image definition identifier. */\nexport interface GalleryImageIdentifier {\n /** The name of the gallery image definition publisher. */\n publisher: string;\n /** The name of the gallery image definition offer. */\n offer: string;\n /** The name of the gallery image definition SKU. */\n sku: string;\n}\n\n/** The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */\nexport interface RecommendedMachineConfiguration {\n /** Describes the resource range. */\n vCPUs?: ResourceRange;\n /** Describes the resource range. */\n memory?: ResourceRange;\n}\n\n/** Describes the resource range. */\nexport interface ResourceRange {\n /** The minimum number of the resource. */\n min?: number;\n /** The maximum number of the resource. */\n max?: number;\n}\n\n/** Describes the disallowed disk types. */\nexport interface Disallowed {\n /** A list of disk types. */\n diskTypes?: Array<string>;\n}\n\n/** Describes the gallery image definition purchase plan. This is used by marketplace images. */\nexport interface ImagePurchasePlan {\n /** The plan ID. */\n name?: string;\n /** The publisher ID. */\n publisher?: string;\n /** The product ID. */\n product?: string;\n}\n\n/** A feature for gallery image. */\nexport interface GalleryImageFeature {\n /** The name of the gallery image feature. */\n name?: string;\n /** The value of the gallery image feature. */\n value?: string;\n}\n\n/** Specifies information about the gallery image definition that you want to update. */\nexport interface GalleryImageUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery image definition. */\n properties?: GalleryImageProperties;\n}\n\n/** Specifies information about the gallery image version that you want to create or update. */\nexport interface GalleryImageVersion extends Resource {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryImageVersionProperties;\n}\n\n/** Describes the properties of a gallery image version. */\nexport interface GalleryImageVersionProperties {\n /** The publishing profile of a gallery image Version. */\n publishingProfile?: GalleryImageVersionPublishingProfile;\n /** This is the storage profile of a Gallery Image Version. */\n storageProfile: GalleryImageVersionStorageProfile;\n}\n\n/** The publishing profile of a gallery image Version. */\nexport interface GalleryImageVersionPublishingProfile extends GalleryArtifactPublishingProfileBase {}\n\n/** Describes the basic gallery artifact publishing profile. */\nexport interface GalleryArtifactPublishingProfileBase {\n /** The target regions where the Image Version is going to be replicated to. This property is updatable. */\n targetRegions?: Array<TargetRegion>;\n /** The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. */\n replicaCount?: number;\n /** If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */\n excludeFromLatest?: boolean;\n /** The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. */\n endOfLifeDate?: Date | string;\n /** Specifies the storage account type to be used to store the image. This property is not updatable. */\n storageAccountType?: \"Standard_LRS\" | \"Standard_ZRS\" | \"Premium_LRS\";\n /** Optional parameter which specifies the mode to be used for replication. This property is not updatable. */\n replicationMode?: \"Full\" | \"Shallow\";\n /** The target extended locations where the Image Version is going to be replicated to. This property is updatable. */\n targetExtendedLocations?: Array<GalleryTargetExtendedLocation>;\n}\n\n/** Describes the target region information. */\nexport interface TargetRegion {\n /** The name of the region. */\n name: string;\n /** The number of replicas of the Image Version to be created per region. This property is updatable. */\n regionalReplicaCount?: number;\n /** Specifies the storage account type to be used to store the image. This property is not updatable. */\n storageAccountType?: \"Standard_LRS\" | \"Standard_ZRS\" | \"Premium_LRS\";\n /** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */\n encryption?: EncryptionImages;\n}\n\n/** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */\nexport interface EncryptionImages {\n /** Contains encryption settings for an OS disk image. */\n osDiskImage?: OSDiskImageEncryption;\n /** A list of encryption specifications for data disk images. */\n dataDiskImages?: Array<DataDiskImageEncryption>;\n}\n\n/** Contains encryption settings for an OS disk image. */\nexport interface OSDiskImageEncryption extends DiskImageEncryption {\n /** This property specifies the security profile of an OS disk image. */\n securityProfile?: OSDiskImageSecurityProfile;\n}\n\n/** Contains security profile for an OS disk image. */\nexport interface OSDiskImageSecurityProfile {\n /** confidential VM encryption types */\n confidentialVMEncryptionType?:\n | \"EncryptedVMGuestStateOnlyWithPmk\"\n | \"EncryptedWithPmk\"\n | \"EncryptedWithCmk\";\n /** secure VM disk encryption set id */\n secureVMDiskEncryptionSetId?: string;\n}\n\n/** This is the disk image encryption base class. */\nexport interface DiskImageEncryption {\n /** A relative URI containing the resource ID of the disk encryption set. */\n diskEncryptionSetId?: string;\n}\n\n/** Contains encryption settings for a data disk image. */\nexport interface DataDiskImageEncryption extends DiskImageEncryption {\n /** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */\n lun: number;\n}\n\nexport interface GalleryTargetExtendedLocation {\n /** The name of the region. */\n name?: string;\n /** The name of the extended location. */\n extendedLocation?: GalleryExtendedLocation;\n /** The number of replicas of the Image Version to be created per extended location. This property is updatable. */\n extendedLocationReplicaCount?: number;\n /** Specifies the storage account type to be used to store the image. This property is not updatable. */\n storageAccountType?: \"Standard_LRS\" | \"Standard_ZRS\" | \"Premium_LRS\";\n /** Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */\n encryption?: EncryptionImages;\n}\n\n/** The name of the extended location. */\nexport interface GalleryExtendedLocation {\n name?: string;\n /** It is type of the extended location. */\n type?: \"EdgeZone\" | \"Unknown\";\n}\n\n/** This is the storage profile of a Gallery Image Version. */\nexport interface GalleryImageVersionStorageProfile {\n /** The gallery artifact version source. */\n source?: GalleryArtifactVersionSource;\n /** This is the OS disk image. */\n osDiskImage?: GalleryOSDiskImage;\n /** A list of data disk images. */\n dataDiskImages?: Array<GalleryDataDiskImage>;\n}\n\n/** The gallery artifact version source. */\nexport interface GalleryArtifactVersionSource {\n /** The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource. */\n id?: string;\n /** The uri of the gallery artifact version source. Currently used to specify vhd/blob source. */\n uri?: string;\n}\n\n/** This is the OS disk image. */\nexport interface GalleryOSDiskImage extends GalleryDiskImage {}\n\n/** This is the disk image base class. */\nexport interface GalleryDiskImage {\n /** The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' */\n hostCaching?: \"None\" | \"ReadOnly\" | \"ReadWrite\";\n /** The gallery artifact version source. */\n source?: GalleryArtifactVersionSource;\n}\n\n/** This is the data disk image. */\nexport interface GalleryDataDiskImage extends GalleryDiskImage {\n /** This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */\n lun: number;\n}\n\n/** This is the replication status of the gallery image version. */\nexport interface ReplicationStatus {}\n\n/** This is the regional replication status. */\nexport interface RegionalReplicationStatus {}\n\n/** Specifies information about the gallery image version that you want to update. */\nexport interface GalleryImageVersionUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryImageVersionProperties;\n}\n\n/** Specifies information about the gallery Application Definition that you want to create or update. */\nexport interface GalleryApplication extends Resource {\n /** Describes the properties of a gallery Application Definition. */\n properties?: GalleryApplicationProperties;\n}\n\n/** Describes the properties of a gallery Application Definition. */\nexport interface GalleryApplicationProperties {\n /** The description of this gallery Application Definition resource. This property is updatable. */\n description?: string;\n /** The Eula agreement for the gallery Application Definition. */\n eula?: string;\n /** The privacy statement uri. */\n privacyStatementUri?: string;\n /** The release note uri. */\n releaseNoteUri?: string;\n /** The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. */\n endOfLifeDate?: Date | string;\n /** This property allows you to specify the supported type of the OS that application is built for. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux** */\n supportedOSType: \"Windows\" | \"Linux\";\n}\n\n/** Specifies information about the gallery Application Definition that you want to update. */\nexport interface GalleryApplicationUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery Application Definition. */\n properties?: GalleryApplicationProperties;\n}\n\n/** Specifies information about the gallery Application Version that you want to create or update. */\nexport interface GalleryApplicationVersion extends Resource {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryApplicationVersionProperties;\n}\n\n/** Describes the properties of a gallery image version. */\nexport interface GalleryApplicationVersionProperties {\n /** The publishing profile of a gallery image version. */\n publishingProfile: GalleryApplicationVersionPublishingProfile;\n}\n\n/** The publishing profile of a gallery image version. */\nexport interface GalleryApplicationVersionPublishingProfile extends GalleryArtifactPublishingProfileBase {\n /** The source image from which the Image Version is going to be created. */\n source: UserArtifactSource;\n manageActions?: UserArtifactManage;\n /** 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. */\n settings?: UserArtifactSettings;\n /** Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. */\n advancedSettings?: Record<string, string>;\n /** Optional. Whether or not this application reports health. */\n enableHealthCheck?: boolean;\n}\n\n/** The source image from which the Image Version is going to be created. */\nexport interface UserArtifactSource {\n /** Required. The mediaLink of the artifact, must be a readable storage page blob. */\n mediaLink: string;\n /** Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. */\n defaultConfigurationLink?: string;\n}\n\nexport interface UserArtifactManage {\n /** Required. The path and arguments to install the gallery application. This is limited to 4096 characters. */\n install: string;\n /** Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. */\n remove: string;\n /** Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. */\n update?: string;\n}\n\n/** 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. */\nexport interface UserArtifactSettings {\n /** Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. */\n packageFileName?: string;\n /** Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with \"_config\". */\n configFileName?: string;\n}\n\n/** Specifies information about the gallery Application Version that you want to update. */\nexport interface GalleryApplicationVersionUpdate extends UpdateResourceDefinition {\n /** Describes the properties of a gallery image version. */\n properties?: GalleryApplicationVersionProperties;\n}\n\n/** Specifies information about the gallery sharing profile update. */\nexport interface SharingUpdate {\n /** This property allows you to specify the operation type of gallery sharing update. <br><br> Possible values are: <br><br> **Add** <br><br> **Remove** <br><br> **Reset** */\n operationType: \"Add\" | \"Remove\" | \"Reset\" | \"EnableCommunity\";\n /** A list of sharing profile groups. */\n groups?: Array<SharingProfileGroup>;\n}\n\n/** Describes the cloud service role sku. */\nexport interface CloudServiceRoleSku {\n /** The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku. */\n name?: string;\n /** Specifies the tier of the cloud service. Possible Values are <br /><br /> **Standard** <br /><br /> **Basic** */\n tier?: string;\n /** Specifies the number of role instances in the cloud service. */\n capacity?: number;\n}\n\n/** Describes the cloud service. */\nexport interface CloudService {\n /** Resource location. */\n location: string;\n /** Resource tags. */\n tags?: Record<string, string>;\n /** Cloud service properties */\n properties?: CloudServiceProperties;\n /** The system meta data relating to this resource. */\n systemData?: SystemData;\n}\n\n/** Cloud service properties */\nexport interface CloudServiceProperties {\n /**\n * Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\n * This is a write-only property and is not returned in GET calls.\n */\n packageUrl?: string;\n /** Specifies the XML service configuration (.cscfg) for the cloud service. */\n configuration?: string;\n /**\n * Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\n * This is a write-only property and is not returned in GET calls.\n */\n configurationUrl?: string;\n /**\n * (Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.\n * If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.\n */\n startCloudService?: boolean;\n /**\n * (Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.\n * The default value is `false`.\n */\n allowModelOverride?: boolean;\n /**\n * Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains.\n * Possible Values are <br /><br />**Auto**<br /><br />**Manual** <br /><br />**Simultaneous**<br /><br />\n * If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.\n */\n upgradeMode?: \"Auto\" | \"Manual\" | \"Simultaneous\";\n /** Describes the role profile for the cloud service. */\n roleProfile?: CloudServiceRoleProfile;\n /** Describes the OS profile for the cloud service. */\n osProfile?: CloudServiceOsProfile;\n /** Network Profile for the cloud service. */\n networkProfile?: CloudServiceNetworkProfile;\n /** Describes a cloud service extension profile. */\n extensionProfile?: CloudServiceExtensionProfile;\n}\n\n/** Describes the role profile for the cloud service. */\nexport interface CloudServiceRoleProfile {\n /** List of roles for the cloud service. */\n roles?: Array<CloudServiceRoleProfileProperties>;\n}\n\n/** Describes the role properties. */\nexport interface CloudServiceRoleProfileProperties {\n /** Resource name. */\n name?: string;\n /** Describes the cloud service role sku. */\n sku?: CloudServiceRoleSku;\n}\n\n/** Describes the OS profile for the cloud service. */\nexport interface CloudServiceOsProfile {\n /** Specifies set of certificates that should be installed onto the role instances. */\n secrets?: Array<CloudServiceVaultSecretGroup>;\n}\n\n/** Describes a set of certificates which are all in the same Key Vault. */\nexport interface CloudServiceVaultSecretGroup {\n /** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */\n sourceVault?: SubResource;\n /** The list of key vault references in SourceVault which contain certificates. */\n vaultCertificates?: Array<CloudServiceVaultCertificate>;\n}\n\n/** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance. */\nexport interface CloudServiceVaultCertificate {\n /** This is the URL of a certificate that has been uploaded to Key Vault as a secret. */\n certificateUrl?: string;\n}\n\n/** Network Profile for the cloud service. */\nexport interface CloudServiceNetworkProfile {\n /** List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer. */\n loadBalancerConfigurations?: Array<LoadBalancerConfiguration>;\n /**\n * Slot type for the cloud service.\n * Possible values are <br /><br />**Production**<br /><br />**Staging**<br /><br />\n * If not specified, the default value is Production.\n */\n slotType?: \"Production\" | \"Staging\";\n /** The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown. */\n swappableCloudService?: SubResource;\n}\n\n/** Describes the load balancer configuration. */\nexport interface LoadBalancerConfiguration {\n /** Resource Id */\n id?: string;\n /** The name of the Load balancer */\n name: string;\n /** Properties of the load balancer configuration. */\n properties: LoadBalancerConfigurationProperties;\n}\n\n/** Describes the properties of the load balancer configuration. */\nexport interface LoadBalancerConfigurationProperties {\n /** 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. */\n frontendIPConfigurations: Array<LoadBalancerFrontendIPConfiguration>;\n}\n\n/** 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. */\nexport interface LoadBalancerFrontendIPConfiguration {\n /** The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. */\n name: string;\n /** Properties of load balancer frontend ip configuration. */\n properties: LoadBalancerFrontendIPConfigurationProperties;\n}\n\n/** Describes a cloud service IP Configuration */\nexport interface LoadBalancerFrontendIPConfigurationProperties {\n /** The reference to the public ip address resource. */\n publicIPAddress?: SubResource;\n /** The reference to the virtual network subnet resource. */\n subnet?: SubResource;\n /** The virtual network private IP address of the IP configuration. */\n privateIPAddress?: string;\n}\n\n/** Describes a cloud service extension profile. */\nexport interface CloudServiceExtensionProfile {\n /** List of extensions for the cloud service. */\n extensions?: Array<Extension>;\n}\n\n/** Describes a cloud service Extension. */\nexport interface Extension {\n /** The name of the extension. */\n name?: string;\n /** Extension Properties. */\n properties?: CloudServiceExtensionProperties;\n}\n\n/** Extension Properties. */\nexport interface CloudServiceExtensionProperties {\n /** The name of the extension handler publisher. */\n publisher?: string;\n /** Specifies the type of the extension. */\n type?: string;\n /** Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance. */\n typeHandlerVersion?: string;\n /** Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. */\n autoUpgradeMinorVersion?: boolean;\n /** Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension. */\n settings?: any;\n /** Protected settings for the extension which are encrypted before sent to the role instance. */\n protectedSettings?: any;\n /** Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. */\n protectedSettingsFromKeyVault?: CloudServiceVaultAndSecretReference;\n /**\n * Tag to force apply the provided public and protected settings.\n * Changing the tag value allows for re-running the extension without changing any of the public or protected settings.\n * If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.\n * If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and\n * it is up to handler implementation whether to re-run it or not\n */\n forceUpdateTag?: string;\n /** Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service. */\n rolesAppliedTo?: Array<string>;\n}\n\n/** Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. */\nexport interface CloudServiceVaultAndSecretReference {\n /** The ARM Resource ID of the Key Vault */\n sourceVault?: SubResource;\n /** Secret URL which contains the protected settings of the extension */\n secretUrl?: string;\n}\n\n/** The system meta data relating to this resource. */\nexport interface SystemData {}\n\nexport interface CloudServiceUpdate {\n /** Resource tags */\n tags?: Record<string, string>;\n}\n\n/** Specifies a list of role instances from the cloud service. */\nexport interface RoleInstances {\n /** List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service. */\n roleInstances: Array<string>;\n}\n\n/** Defines an update domain for the cloud service. */\nexport interface UpdateDomain {}\n"]}