@azure-rest/arm-compute

/** The List Compute Operation operation response. */ export interface ComputeOperationListResultOutput { /** The list of compute operations */ readonly value?: Array<ComputeOperationValueOutput>; } /** Describes the properties of a Compute Operation value. */ export interface ComputeOperationValueOutput { /** The origin of the compute operation. */ readonly origin?: string; /** The name of the compute operation. */ readonly name?: string; /** Describes the properties of a Compute Operation Value Display. */ display?: ComputeOperationValueDisplayOutput; } /** Describes the properties of a Compute Operation Value Display. */ export interface ComputeOperationValueDisplayOutput { /** The display name of the compute operation. */ readonly operation?: string; /** The display name of the resource the operation applies to. */ readonly resource?: string; /** The description of the operation. */ readonly description?: string; /** The resource provider for the operation. */ readonly provider?: string; } /** An error response from the Compute service. */ export interface CloudErrorOutput { /** Api error. */ error?: ApiErrorOutput; } /** Api error. */ export interface ApiErrorOutput { /** The Api error details */ details?: Array<ApiErrorBaseOutput>; /** The Api inner error */ innererror?: InnerErrorOutput; /** The error code. */ code?: string; /** The target of the particular error. */ target?: string; /** The error message. */ message?: string; } /** Api error base. */ export interface ApiErrorBaseOutput { /** The error code. */ code?: string; /** The target of the particular error. */ target?: string; /** The error message. */ message?: string; } /** Inner error details. */ export interface InnerErrorOutput { /** The exception type. */ exceptiontype?: string; /** The internal error message or exception dump. */ errordetail?: string; } /** The List Usages operation response. */ export interface ListUsagesResultOutput { /** The list of compute resource usages. */ value: Array<UsageOutput>; /** The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information. */ nextLink?: string; } /** Describes Compute Resource Usage. */ export interface UsageOutput { /** An enum describing the unit of usage measurement. */ unit: "Count"; /** The current usage of the resource. */ currentValue: number; /** The maximum permitted usage of the resource. */ limit: number; /** The name of the type of usage. */ name: UsageNameOutput; } /** The Usage Names. */ export interface UsageNameOutput { /** The name of the resource. */ value?: string; /** The localized name of the resource. */ localizedValue?: string; } /** The List Virtual Machine operation response. */ export interface VirtualMachineSizeListResultOutput { /** The list of virtual machine sizes. */ value?: Array<VirtualMachineSizeOutput>; } /** Describes the properties of a VM size. */ export interface VirtualMachineSizeOutput { /** The name of the virtual machine size. */ name?: string; /** The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list */ numberOfCores?: number; /** The OS disk size, in MB, allowed by the virtual machine size. */ osDiskSizeInMB?: number; /** The resource disk size, in MB, allowed by the virtual machine size. */ resourceDiskSizeInMB?: number; /** The amount of memory, in MB, supported by the virtual machine size. */ memoryInMB?: number; /** The maximum number of data disks that can be attached to the virtual machine size. */ maxDataDiskCount?: number; } /** The List Virtual Machine operation response. */ export interface VirtualMachineScaleSetListResultOutput { /** The list of virtual machine scale sets. */ value: Array<VirtualMachineScaleSetOutput>; /** The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS. */ nextLink?: string; } /** Describes a Virtual Machine Scale Set. */ export interface VirtualMachineScaleSetOutput extends ResourceOutput { /** The virtual machine scale set sku. */ sku?: SkuOutput; /** 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**. */ plan?: PlanOutput; /** Describes the properties of a Virtual Machine Scale Set. */ properties?: VirtualMachineScaleSetPropertiesOutput; /** The identity of the virtual machine scale set, if configured. */ identity?: VirtualMachineScaleSetIdentityOutput; /** The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set */ zones?: Array<string>; /** The extended location of the Virtual Machine Scale Set. */ extendedLocation?: ExtendedLocationOutput; } /** 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. */ export interface SkuOutput { /** The sku name. */ name?: string; /** Specifies the tier of virtual machines in a scale set. Possible Values: **Standard** **Basic** */ tier?: string; /** Specifies the number of virtual machines in the scale set. */ capacity?: number; } /** 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**. */ export interface PlanOutput { /** The plan ID. */ name?: string; /** The publisher ID. */ publisher?: string; /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */ product?: string; /** The promotion code. */ promotionCode?: string; } /** Describes the properties of a Virtual Machine Scale Set. */ export interface VirtualMachineScaleSetPropertiesOutput { /** The upgrade policy. */ upgradePolicy?: UpgradePolicyOutput; /** Policy for automatic repairs. */ automaticRepairsPolicy?: AutomaticRepairsPolicyOutput; /** The virtual machine profile. */ virtualMachineProfile?: VirtualMachineScaleSetVMProfileOutput; /** The provisioning state, which only appears in the response. */ readonly provisioningState?: string; /** Specifies whether the Virtual Machine Scale Set should be overprovisioned. */ overprovision?: boolean; /** 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. */ doNotRunExtensionsOnOverprovisionedVMs?: boolean; /** Specifies the ID which uniquely identifies a Virtual Machine Scale Set. */ readonly uniqueId?: string; /** 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. */ singlePlacementGroup?: boolean; /** 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. */ zoneBalance?: boolean; /** Fault Domain count for each placement group. */ platformFaultDomainCount?: number; /** Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. */ proximityPlacementGroup?: SubResourceOutput; /** Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01. */ hostGroup?: SubResourceOutput; /** 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. */ additionalCapabilities?: AdditionalCapabilitiesOutput; /** Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. */ scaleInPolicy?: ScaleInPolicyOutput; /** Specifies the orchestration mode for the virtual machine scale set. */ orchestrationMode?: "Uniform" | "Flexible"; /** Specifies the Spot Restore properties for the virtual machine scale set. */ spotRestorePolicy?: SpotRestorePolicyOutput; /** Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. */ priorityMixPolicy?: PriorityMixPolicyOutput; /** Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. */ readonly timeCreated?: string; } /** Describes an upgrade policy - automatic, manual, or rolling. */ export interface UpgradePolicyOutput { /** Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. **Automatic** - All virtual machines in the scale set are automatically updated at the same time. */ mode?: "Automatic" | "Manual" | "Rolling"; /** The configuration parameters used while performing a rolling upgrade. */ rollingUpgradePolicy?: RollingUpgradePolicyOutput; /** Configuration parameters used for performing automatic OS Upgrade. */ automaticOSUpgradePolicy?: AutomaticOSUpgradePolicyOutput; } /** The configuration parameters used while performing a rolling upgrade. */ export interface RollingUpgradePolicyOutput { /** 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%. */ maxBatchInstancePercent?: number; /** 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%. */ maxUnhealthyInstancePercent?: number; /** 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%. */ maxUnhealthyUpgradedInstancePercent?: number; /** 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). */ pauseTimeBetweenBatches?: string; /** Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. */ enableCrossZoneUpgrade?: boolean; /** Upgrade all unhealthy instances in a scale set before any healthy instances. */ prioritizeUnhealthyInstances?: boolean; } /** The configuration parameters used for performing automatic OS upgrade. */ export interface AutomaticOSUpgradePolicyOutput { /** 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. 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. */ enableAutomaticOSUpgrade?: boolean; /** Whether OS image rollback feature should be disabled. Default value is false. */ disableAutomaticRollback?: boolean; /** 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. */ useRollingUpgradePolicy?: boolean; } /** Specifies the configuration parameters for automatic repairs on the virtual machine scale set. */ export interface AutomaticRepairsPolicyOutput { /** Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. */ enabled?: boolean; /** 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). */ gracePeriod?: string; /** Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. */ repairAction?: "Replace" | "Restart" | "Reimage"; } /** Describes a virtual machine scale set virtual machine profile. */ export interface VirtualMachineScaleSetVMProfileOutput { /** Specifies the operating system settings for the virtual machines in the scale set. */ osProfile?: VirtualMachineScaleSetOSProfileOutput; /** Specifies the storage settings for the virtual machine disks. */ storageProfile?: VirtualMachineScaleSetStorageProfileOutput; /** Specifies properties of the network interfaces of the virtual machines in the scale set. */ networkProfile?: VirtualMachineScaleSetNetworkProfileOutput; /** Specifies the Security related profile settings for the virtual machines in the scale set. */ securityProfile?: SecurityProfileOutput; /** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */ diagnosticsProfile?: DiagnosticsProfileOutput; /** Specifies a collection of settings for extensions installed on virtual machines in the scale set. */ extensionProfile?: VirtualMachineScaleSetExtensionProfileOutput; /** Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) [Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) Minimum api-version: 2015-06-15 */ licenseType?: string; /** Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview */ priority?: "Regular" | "Low" | "Spot"; /** Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */ evictionPolicy?: "Deallocate" | "Delete"; /** Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. */ billingProfile?: BillingProfileOutput; /** Specifies Scheduled Event related configurations. */ scheduledEventsProfile?: ScheduledEventsProfileOutput; /** UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01 */ userData?: string; /** Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. */ capacityReservation?: CapacityReservationProfileOutput; /** Specifies the gallery applications that should be made available to the VM/VMSS */ applicationProfile?: ApplicationProfileOutput; /** Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. */ hardwareProfile?: VirtualMachineScaleSetHardwareProfileOutput; } /** Describes a virtual machine scale set OS profile. */ export interface VirtualMachineScaleSetOSProfileOutput { /** 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. */ computerNamePrefix?: string; /** Specifies the name of the administrator account. **Windows-only restriction:** Cannot end in "." **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". **Minimum-length (Linux):** 1 character **Max-length (Linux):** 64 characters **Max-length (Windows):** 20 characters */ adminUsername?: string; /** Specifies the password of the administrator account. **Minimum-length (Windows):** 8 characters **Minimum-length (Linux):** 6 characters **Max-length (Windows):** 123 characters **Max-length (Linux):** 72 characters **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" 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) 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) */ adminPassword?: string; /** 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. 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) */ customData?: string; /** Specifies Windows operating system settings on the virtual machine. */ windowsConfiguration?: WindowsConfigurationOutput; /** Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ linuxConfiguration?: LinuxConfigurationOutput; /** 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). */ secrets?: Array<VaultSecretGroupOutput>; /** Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set. */ allowExtensionOperations?: boolean; } /** Specifies Windows operating system settings on the virtual machine. */ export interface WindowsConfigurationOutput { /** Indicates whether virtual machine agent should be provisioned on the virtual machine. 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. */ provisionVMAgent?: boolean; /** Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. */ enableAutomaticUpdates?: boolean; /** Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". 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). */ timeZone?: string; /** Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. */ additionalUnattendContent?: Array<AdditionalUnattendContentOutput>; /** [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */ patchSettings?: PatchSettingsOutput; /** Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */ winRM?: WinRMConfigurationOutput; /** Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false. */ enableVMAgentPlatformUpdates?: boolean; } /** 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. */ export interface AdditionalUnattendContentOutput { /** The pass name. Currently, the only allowable value is OobeSystem. */ passName?: "OobeSystem"; /** The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. */ componentName?: "Microsoft-Windows-Shell-Setup"; /** Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. */ settingName?: "AutoLogon" | "FirstLogonCommands"; /** 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. */ content?: string; } /** Specifies settings related to VM Guest Patching on Windows. */ export interface PatchSettingsOutput { /** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: **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 **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. **AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true */ patchMode?: "Manual" | "AutomaticByOS" | "AutomaticByPlatform"; /** 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'. */ enableHotpatching?: boolean; /** Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: **ImageDefault** - You control the timing of patch assessments on a virtual machine. **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */ assessmentMode?: "ImageDefault" | "AutomaticByPlatform"; /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */ automaticByPlatformSettings?: WindowsVMGuestPatchAutomaticByPlatformSettingsOutput; } /** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */ export interface WindowsVMGuestPatchAutomaticByPlatformSettingsOutput { /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: "Unknown" | "IfRequired" | "Never" | "Always"; } /** Describes Windows Remote Management configuration of the VM */ export interface WinRMConfigurationOutput { /** The list of Windows Remote Management listeners */ listeners?: Array<WinRMListenerOutput>; } /** Describes Protocol and thumbprint of Windows Remote Management listener */ export interface WinRMListenerOutput { /** Specifies the protocol of WinRM listener. Possible values are: **http** **https** */ protocol?: "Http" | "Https"; /** 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: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } 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). */ certificateUrl?: string; } /** Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ export interface LinuxConfigurationOutput { /** Specifies whether password authentication should be disabled. */ disablePasswordAuthentication?: boolean; /** Specifies the ssh key configuration for a Linux OS. */ ssh?: SshConfigurationOutput; /** Indicates whether virtual machine agent should be provisioned on the virtual machine. 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. */ provisionVMAgent?: boolean; /** [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */ patchSettings?: LinuxPatchSettingsOutput; /** Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. */ enableVMAgentPlatformUpdates?: boolean; } /** SSH configuration for Linux based VMs running on Azure */ export interface SshConfigurationOutput { /** The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: Array<SshPublicKeyOutput>; } /** Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ export interface SshPublicKeyOutput { /** 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 */ path?: string; /** 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. 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). */ keyData?: string; } /** Specifies settings related to VM Guest Patching on Linux. */ export interface LinuxPatchSettingsOutput { /** Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: **ImageDefault** - The virtual machine's default patching configuration is used. **AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true */ patchMode?: "ImageDefault" | "AutomaticByPlatform"; /** Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: **ImageDefault** - You control the timing of patch assessments on a virtual machine. **AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */ assessmentMode?: "ImageDefault" | "AutomaticByPlatform"; /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */ automaticByPlatformSettings?: LinuxVMGuestPatchAutomaticByPlatformSettingsOutput; } /** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */ export interface LinuxVMGuestPatchAutomaticByPlatformSettingsOutput { /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: "Unknown" | "IfRequired" | "Never" | "Always"; } /** Describes a set of certificates which are all in the same Key Vault. */ export interface VaultSecretGroupOutput { /** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */ sourceVault?: SubResourceOutput; /** The list of key vault references in SourceVault which contain certificates. */ vaultCertificates?: Array<VaultCertificateOutput>; } export interface SubResourceOutput { /** Resource Id */ id?: string; } /** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */ export interface VaultCertificateOutput { /** 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: { "data":"<Base64-encoded-certificate>", "dataType":"pfx", "password":"<pfx-file-password>" } 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). */ certificateUrl?: string; /** 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. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. */ certificateStore?: string; } /** Describes a virtual machine scale set storage profile. */ export interface VirtualMachineScaleSetStorageProfileOutput { /** 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. */ imageReference?: ImageReferenceOutput; /** Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: VirtualMachineScaleSetOSDiskOutput; /** Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ dataDisks?: Array<VirtualMachineScaleSetDataDiskOutput>; diskControllerType?: string; } /** 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. */ export interface ImageReferenceOutput extends SubResourceOutput { /** The image publisher. */ publisher?: string; /** Specifies the offer of the platform image or marketplace image used to create the virtual machine. */ offer?: string; /** The image SKU. */ sku?: string; /** 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. */ version?: string; /** Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. */ readonly exactVersion?: string; /** Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. */ sharedGalleryImageId?: string; /** Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. */ communityGalleryImageId?: string; } /** Describes a virtual machine scale set operating system disk. */ export interface VirtualMachineScaleSetOSDiskOutput { /** The disk name. */ name?: string; /** Specifies the caching requirements. Possible values are: **None** **ReadOnly** **ReadWrite** Default: **None for Standard storage. ReadOnly for Premium storage** */ caching?: "None" | "ReadOnly" | "ReadWrite"; /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; /** Specifies how the virtual machines in the scale set should be created. 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. */ createOption: "FromImage" | "Empty" | "Attach"; /** Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. */ diffDiskSettings?: DiffDiskSettingsOutput; /** 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. diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */ diskSizeGB?: number; /** This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows** **Linux** */ osType?: "Windows" | "Linux"; /** Specifies information about the unmanaged user image to base the scale set on. */ image?: VirtualHardDiskOutput; /** Specifies the container urls that are used to store operating system disks for the scale set. */ vhdContainers?: Array<string>; /** The managed disk parameters. */ managedDisk?: VirtualMachineScaleSetManagedDiskParametersOutput; /** Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: **Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. **Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted. 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. */ deleteOption?: "Delete" | "Detach"; } /** Describes the parameters of ephemeral disk settings that can be specified for operating system disk. NOTE: The ephemeral disk settings can only be specified for managed disk. */ export interface DiffDiskSettingsOutput { /** Specifies the ephemeral disk settings for operating system disk. */ option?: "Local"; /** Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk** **ResourceDisk** Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used. 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. */ placement?: "CacheDisk" | "ResourceDisk"; } /** Describes the uri of a disk. */ export interface VirtualHardDiskOutput { /** Specifies the virtual hard disk's uri. */ uri?: string; } /** Describes the parameters of a ScaleSet managed disk. */ export interface VirtualMachineScaleSetManagedDiskParametersOutput { /** 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. */ storageAccountType?: "Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS" | "Premium_ZRS" | "StandardSSD_ZRS" | "PremiumV2_LRS"; /** Specifies the customer managed disk encryption set resource id for the managed disk. */ diskEncryptionSet?: DiskEncryptionSetParametersOutput; /** Specifies the security profile for the managed disk. */ securityProfile?: VMDiskSecurityProfileOutput; } /** Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */ export interface DiskEncryptionSetParametersOutput extends SubResourceOutput { } /** Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs */ export interface VMDiskSecurityProfileOutput { /** Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs. */ securityEncryptionType?: "VMGuestStateOnly" | "DiskWithVMGuestState"; /** 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. */ diskEncryptionSet?: DiskEncryptionSetParametersOutput; } /** Describes a virtual machine scale set data disk. */ export interface VirtualMachineScaleSetDataDiskOutput { /** The disk name. */ name?: string; /** 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. */ lun: number; /** Specifies the caching requirements. Possible values are: **None** **ReadOnly** **ReadWrite** Default: **None for Standard storage. ReadOnly for Premium storage** */ caching?: "None" | "ReadOnly" | "ReadWrite"; /** Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; /** The create option. */ createOption: "FromImage" | "Empty" | "Attach"; /** 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. diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023 */ diskSizeGB?: number; /** The managed disk parameters. */ managedDisk?: VirtualMachineScaleSetManagedDiskParametersOutput; /** 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. */ diskIOPSReadWrite?: number; /** 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. */ diskMBpsReadWrite?: number; /** Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: **Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. **Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to **Delete**. */ deleteOption?: "Delete" | "Detach"; } /** Describes a virtual machine scale set network profile. */ export interface VirtualMachineScaleSetNetworkProfileOutput { /** 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}'. */ healthProbe?: ApiEntityReferenceOutput; /** The list of network configurations. */ networkInterfaceConfigurations?: Array<VirtualMachineScaleSetNetworkConfigurationOutput>; /** 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' */ networkApiVersion?: "2020-11-01"; } /** The API entity reference. */ export interface ApiEntityReferenceOutput { /** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ id?: string; } /** Describes a virtual machine scale set network profile's network configurations. */ export interface VirtualMachineScaleSetNetworkConfigurationOutput extends SubResourceOutput { /** The network configuration name. */ name: string; /** Describes a virtual machine scale set network profile's IP configuration. */ properties?: VirtualMachineScaleSetNetworkConfigurationPropertiesOutput; } /** Describes a virtual machine scale set network profile's IP configuration. */ export interface VirtualMachineScaleSetNetworkConfigurationPropertiesOutput { /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; /** Specifies whether the network interface is accelerated networking-enabled. */ enableAcceleratedNetworking?: boolean; /** Specifies whether the network interface is disabled for tcp state tracking. */ disableTcpStateTracking?: boolean; /** Specifies whether the network interface is FPGA networking-enabled. */ enableFpga?: boolean; /** The network security group. */ networkSecurityGroup?: SubResourceOutput; /** The dns settings to be applied on the network interfaces. */ dnsSettings?: VirtualMachineScaleSetNetworkConfigurationDnsSettingsOutput; /** Specifies the IP configurations of the network interface. */ ipConfigurations: Array<VirtualMachineScaleSetIPConfigurationOutput>; /** Whether IP forwarding enabled on this NIC. */ enableIPForwarding?: boolean; /** Specify what happens to the network interface when the VM is deleted */ deleteOption?: "Delete" | "Detach"; } /** Describes a virtual machines scale sets network configuration's DNS settings. */ export interface VirtualMachineScaleSetNetworkConfigurationDnsSettingsOutput { /** List of DNS servers IP addresses */ dnsServers?: Array<string>; } /** Describes a virtual machine scale set network profile's IP configuration. */ export interface VirtualMachineScaleSetIPConfigurationOutput extends SubResourceOutput { /** The IP configuration name. */ name: string; /** Describes a virtual machine scale set network profile's IP configuration properties. */ properties?: VirtualMachineScaleSetIPConfigurationPropertiesOutput; } /** Describes a virtual machine scale set network profile's IP configuration properties. */ export interface VirtualMachineScaleSetIPConfigurationPropertiesOutput { /** Specifies the identifier of the subnet. */ subnet?: ApiEntityReferenceOutput; /** Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; /** The publicIPAddressConfiguration. */ publicIPAddressConfiguration?: VirtualMachineScaleSetPublicIPAddressConfigurationOutput; /** 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'. */ privateIPAddressVersion?: "IPv4" | "IPv6"; /** 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. */ applicationGatewayBackendAddressPools?: Array<SubResourceOutput>; /** Specifies an array of references to application security group. */ applicationSecurityGroups?: Array<SubResourceOutput>; /** 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. */ loadBalancerBackendAddressPools?: Array<SubResourceOutput>; /** 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. */ loadBalancerInb