@azure/arm-compute

import * as coreClient from "@azure/core-client"; /** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */ export interface OperationListResult { /** * List of operations supported by the resource provider * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: Operation[]; /** * URL to get the next set of operation list results (if there are any). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly nextLink?: string; } /** Details of a REST API operation, returned from the Resource Provider Operations API */ export interface Operation { /** * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly isDataAction?: boolean; /** Localized display information for this particular operation. */ display?: OperationDisplay; /** * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly origin?: Origin; /** * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly actionType?: ActionType; } /** Localized display information for this particular operation. */ export interface OperationDisplay { /** * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly provider?: string; /** * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly resource?: string; /** * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly operation?: string; /** * The short, localized friendly description of the operation; suitable for tool tips and detailed views. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly description?: string; } /** An error response from the Compute service. */ export interface CloudError { /** Api error. */ error?: ApiError; } /** Api error. */ export interface ApiError { /** The Api error details */ details?: ApiErrorBase[]; /** The Api inner error */ innererror?: InnerError; /** The error code. */ code?: string; /** The target of the particular error. */ target?: string; /** The error message. */ message?: string; } /** Api error base. */ export interface ApiErrorBase { /** The error code. */ code?: string; /** The target of the particular error. */ target?: string; /** The error message. */ message?: string; } /** Inner error details. */ export interface InnerError { /** The exception type. */ exceptiontype?: string; /** The internal error message or exception dump. */ errordetail?: string; } /** The List Availability Set operation response. */ export interface AvailabilitySetListResult { /** The list of availability sets. */ value: AvailabilitySet[]; /** The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets. */ nextLink?: string; } export interface SubResource { /** Resource Id */ id?: string; } /** Instance view status. */ export interface InstanceViewStatus { /** The status code. */ code?: string; /** The level code. */ level?: StatusLevelTypes; /** The short localizable label for the status. */ displayStatus?: string; /** The detailed status message, including for alerts and error messages. */ message?: string; /** The time of the status. */ time?: Date; } /** Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. */ export interface ScheduledEventsPolicy { /** The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. */ userInitiatedRedeploy?: UserInitiatedRedeploy; /** The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. */ userInitiatedReboot?: UserInitiatedReboot; /** The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. */ scheduledEventsAdditionalPublishingTargets?: ScheduledEventsAdditionalPublishingTargets; } /** Specifies Redeploy related Scheduled Event related configurations. */ export interface UserInitiatedRedeploy { /** Specifies Redeploy Scheduled Event related configurations. */ automaticallyApprove?: boolean; } /** Specifies Reboot related Scheduled Event related configurations. */ export interface UserInitiatedReboot { /** Specifies Reboot Scheduled Event related configurations. */ automaticallyApprove?: boolean; } export interface ScheduledEventsAdditionalPublishingTargets { /** The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. */ eventGridAndResourceGraph?: EventGridAndResourceGraph; } /** Specifies eventGridAndResourceGraph related Scheduled Event related configurations. */ export interface EventGridAndResourceGraph { /** Specifies if event grid and resource graph is enabled for Scheduled event related configurations. */ enable?: boolean; } /** Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set. */ export interface VirtualMachineScaleSetMigrationInfo { /** * Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly defaultVirtualMachineScaleSetInfo?: DefaultVirtualMachineScaleSetInfo; /** * Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly migrateToVirtualMachineScaleSet?: SubResource; } /** Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. */ export interface DefaultVirtualMachineScaleSetInfo { /** * Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly constrainedMaximumCapacity?: boolean; /** * The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly defaultVirtualMachineScaleSet?: SubResource; } /** 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 Sku { /** 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; } /** Common fields that are returned in the response for all Azure Resource Manager resources */ export interface Resource { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly id?: string; /** * The name of the resource * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly type?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly systemData?: SystemData; } /** Metadata pertaining to creation and last modification of the resource. */ export interface SystemData { /** The identity that created the resource. */ createdBy?: string; /** The type of identity that created the resource. */ createdByType?: CreatedByType; /** The timestamp of resource creation (UTC). */ createdAt?: Date; /** The identity that last modified the resource. */ lastModifiedBy?: string; /** The type of identity that last modified the resource. */ lastModifiedByType?: CreatedByType; /** The timestamp of resource last modification (UTC) */ lastModifiedAt?: Date; } /** The List capacity reservation group with resource group response. */ export interface CapacityReservationGroupListResult { /** The list of capacity reservation groups. */ value: CapacityReservationGroup[]; /** The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups. */ nextLink?: string; } export interface SubResourceReadOnly { /** * Resource Id * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly id?: string; } export interface CapacityReservationGroupInstanceView { /** * List of instance view of the capacity reservations under the capacity reservation group. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly capacityReservations?: CapacityReservationInstanceViewWithName[]; /** * List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly sharedSubscriptionIds?: SubResourceReadOnly[]; } /** 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. */ export interface CapacityReservationInstanceView { /** Unutilized capacity of the capacity reservation. */ utilizationInfo?: CapacityReservationUtilization; /** The resource status information. */ statuses?: InstanceViewStatus[]; } /** Represents the capacity reservation utilization in terms of resources allocated. */ export interface CapacityReservationUtilization { /** * The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly currentCapacity?: number; /** * A list of all virtual machines resource ids allocated against the capacity reservation. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly virtualMachinesAllocated?: SubResourceReadOnly[]; } export interface ResourceSharingProfile { /** Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. */ subscriptionIds?: SubResource[]; } /** The List Dedicated Host Group with resource group response. */ export interface DedicatedHostGroupListResult { /** The list of dedicated host groups. */ value: DedicatedHostGroup[]; /** The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups. */ nextLink?: string; } export interface DedicatedHostGroupInstanceView { /** List of instance view of the dedicated hosts under the dedicated host group. */ hosts?: DedicatedHostInstanceViewWithName[]; } /** The instance view of a dedicated host. */ export interface DedicatedHostInstanceView { /** * Specifies the unique id of the dedicated physical machine on which the dedicated host resides. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly assetId?: string; /** Unutilized capacity of the dedicated host. */ availableCapacity?: DedicatedHostAvailableCapacity; /** The resource status information. */ statuses?: InstanceViewStatus[]; } /** Dedicated host unutilized capacity. */ export interface DedicatedHostAvailableCapacity { /** The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. */ allocatableVMs?: DedicatedHostAllocatableVM[]; } /** Represents the dedicated host unutilized capacity in terms of a specific VM size. */ export interface DedicatedHostAllocatableVM { /** VM size in terms of which the unutilized capacity is represented. */ vmSize?: string; /** Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. */ count?: number; } /** Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. */ export interface DedicatedHostGroupPropertiesAdditionalCapabilities { /** 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. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. */ ultraSSDEnabled?: boolean; } /** The List Image operation response. */ export interface ImageListResult { /** The list of Images */ value: Image[]; /** The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images. */ nextLink?: string; } /** Describes a storage profile. */ export interface ImageStorageProfile { /** Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: ImageOSDisk; /** Specifies the parameters that are used to add a data disk to a virtual machine. 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?: ImageDataDisk[]; /** 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). */ zoneResilient?: boolean; } /** Describes a image disk. */ export interface ImageDisk { /** The snapshot. */ snapshot?: SubResource; /** The managedDisk. */ managedDisk?: SubResource; /** The Virtual Hard Disk. */ blobUri?: string; /** Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: CachingTypes; /** 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. This value cannot be larger than 1023 GB. */ diskSizeGB?: number; /** 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?: StorageAccountTypes; /** Specifies the customer managed disk encryption set resource id for the managed image disk. */ diskEncryptionSet?: DiskEncryptionSetParameters; } /** The complex type of the extended location. */ export interface ExtendedLocation { /** The name of the extended location. */ name?: string; /** The type of the extended location. */ type?: ExtendedLocationTypes; } /** Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */ export interface PurchasePlan { /** The publisher ID. */ publisher: string; /** The plan ID. */ name: string; /** Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */ product: string; } /** Contains the os disk image information. */ export interface OSDiskImage { /** The operating system of the osDiskImage. */ operatingSystem: OperatingSystemTypes; } /** Contains the data disk images information. */ export interface DataDiskImage { /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly lun?: number; } /** Describes automatic OS upgrade properties on the image. */ export interface AutomaticOSUpgradeProperties { /** Specifies whether automatic OS upgrade is supported on the image. */ automaticOSUpgradeSupported: boolean; } /** Specifies the disallowed configuration for a virtual machine image. */ export interface DisallowedConfiguration { /** VM disk types which are disallowed. */ vmDiskType?: VmDiskTypes; } /** Specifies additional capabilities supported by the image */ export interface VirtualMachineImageFeature { /** The name of the feature. */ name?: string; /** The corresponding value for the feature. */ value?: string; } /** Describes image deprecation status properties on the image. */ export interface ImageDeprecationStatus { /** Describes the state of the image. */ imageState?: ImageState; /** The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher. */ scheduledDeprecationTime?: Date; /** Describes the alternative option specified by the Publisher for this image when this image is deprecated. */ alternativeOption?: AlternativeOption; } /** Describes the alternative option specified by the Publisher for this image when this image is deprecated. */ export interface AlternativeOption { /** Describes the type of the alternative option. */ type?: AlternativeType; /** Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan. */ value?: string; } /** The List VmImages in EdgeZone operation response. */ export interface VmImagesInEdgeZoneListResult { /** The list of VMImages in EdgeZone */ value?: VirtualMachineImageResource[]; /** The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages. */ nextLink?: string; } /** Api input base class for LogAnalytics Api. */ export interface LogAnalyticsInputBase { /** SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to. */ blobContainerSasUri: string; /** From time of the query */ fromTime: Date; /** To time of the query */ toTime: Date; /** Group query result by Throttle Policy applied. */ groupByThrottlePolicy?: boolean; /** Group query result by Operation Name. */ groupByOperationName?: boolean; /** Group query result by Resource Name. */ groupByResourceName?: boolean; /** Group query result by Client Application ID. */ groupByClientApplicationId?: boolean; /** Group query result by User Agent. */ groupByUserAgent?: boolean; } /** LogAnalytics operation status response */ export interface LogAnalyticsOperationResult { /** * LogAnalyticsOutput * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly properties?: LogAnalyticsOutput; } /** LogAnalytics output properties */ export interface LogAnalyticsOutput { /** * Output file Uri path to blob container. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly output?: string; } /** The List Virtual Machine operation response. */ export interface RunCommandListResult { /** The list of virtual machine run commands. */ value: RunCommandDocumentBase[]; /** The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands. */ nextLink?: string; } /** Describes the properties of a Run Command metadata. */ export interface RunCommandDocumentBase { /** The VM run command schema. */ schema: string; /** The VM run command id. */ id: string; /** The Operating System type. */ osType: OperatingSystemTypes; /** The VM run command label. */ label: string; /** The VM run command description. */ description: string; } /** Describes the properties of a run command parameter. */ export interface RunCommandParameterDefinition { /** The run command parameter name. */ name: string; /** The run command parameter type. */ type: string; /** The run command parameter default value. */ defaultValue?: string; /** The run command parameter required. */ required?: boolean; } /** The List Usages operation response. */ export interface ListUsagesResult { /** The list of compute resource usages. */ value: Usage[]; /** 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 Usage { /** 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: UsageName; } /** The Usage Names. */ export interface UsageName { /** The name of the resource. */ value?: string; /** The localized name of the resource. */ localizedValue?: string; } /** The List Virtual Machine operation response. */ export interface VirtualMachineScaleSetListResult { /** The list of virtual machine scale sets. */ value: VirtualMachineScaleSet[]; /** 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; } /** 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 Plan { /** 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 an upgrade policy - automatic, manual, or rolling. */ export interface UpgradePolicy { /** 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?: UpgradeMode; /** The configuration parameters used while performing a rolling upgrade. */ rollingUpgradePolicy?: RollingUpgradePolicy; /** Configuration parameters used for performing automatic OS Upgrade. */ automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy; } /** The configuration parameters used while performing a rolling upgrade. */ export interface RollingUpgradePolicy { /** 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; /** Rollback failed instances to previous model if the Rolling Upgrade policy is violated. */ rollbackFailedInstancesOnPolicyBreach?: boolean; /** Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. */ maxSurge?: boolean; } /** The configuration parameters used for performing automatic OS upgrade. */ export interface AutomaticOSUpgradePolicy { /** 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; /** Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. */ osRollingUpgradeDeferral?: boolean; } /** Specifies the configuration parameters for automatic repairs on the virtual machine scale set. */ export interface AutomaticRepairsPolicy { /** 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?: RepairAction; } /** Describes a virtual machine scale set virtual machine profile. */ export interface VirtualMachineScaleSetVMProfile { /** Specifies the operating system settings for the virtual machines in the scale set. */ osProfile?: VirtualMachineScaleSetOSProfile; /** Specifies the storage settings for the virtual machine disks. */ storageProfile?: VirtualMachineScaleSetStorageProfile; /** Specifies properties of the network interfaces of the virtual machines in the scale set. */ networkProfile?: VirtualMachineScaleSetNetworkProfile; /** Specifies the Security related profile settings for the virtual machines in the scale set. */ securityProfile?: SecurityProfile; /** Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */ diagnosticsProfile?: DiagnosticsProfile; /** Specifies a collection of settings for extensions installed on virtual machines in the scale set. */ extensionProfile?: VirtualMachineScaleSetExtensionProfile; /** 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?: VirtualMachinePriorityTypes; /** 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?: VirtualMachineEvictionPolicyTypes; /** Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. */ billingProfile?: BillingProfile; /** Specifies Scheduled Event related configurations. */ scheduledEventsProfile?: ScheduledEventsProfile; /** 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?: CapacityReservationProfile; /** Specifies the gallery applications that should be made available to the VM/VMSS */ applicationProfile?: ApplicationProfile; /** Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. */ hardwareProfile?: VirtualMachineScaleSetHardwareProfile; /** Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 */ serviceArtifactReference?: ServiceArtifactReference; /** Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 */ securityPostureReference?: SecurityPostureReference; /** * Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly timeCreated?: Date; } /** Describes a virtual machine scale set OS profile. */ export interface VirtualMachineScaleSetOSProfile { /** 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) * This value contains a credential. Consider obscuring before showing to users */ 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?: WindowsConfiguration; /** 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?: LinuxConfiguration; /** 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?: VaultSecretGroup[]; /** 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; /** Optional property which must either be set to True or omitted. */ requireGuestProvisionSignal?: boolean; } /** Specifies Windows operating system settings on the virtual machine. */ export interface WindowsConfiguration { /** Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. 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?: AdditionalUnattendContent[]; /** [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */ patchSettings?: PatchSettings; /** Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */ winRM?: WinRMConfiguration; /** * Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly 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 AdditionalUnattendContent { /** 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?: SettingNames; /** 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 PatchSettings { /** 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?: WindowsVMGuestPatchMode; /** 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?: WindowsPatchAssessmentMode; /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */ automaticByPlatformSettings?: WindowsVMGuestPatchAutomaticByPlatformSettings; } /** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */ export interface WindowsVMGuestPatchAutomaticByPlatformSettings { /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: WindowsVMGuestPatchAutomaticByPlatformRebootSetting; /** Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; } /** Describes Windows Remote Management configuration of the VM */ export interface WinRMConfiguration { /** The list of Windows Remote Management listeners */ listeners?: WinRMListener[]; } /** Describes Protocol and thumbprint of Windows Remote Management listener */ export interface WinRMListener { /** Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** */ protocol?: ProtocolTypes; /** 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 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 LinuxConfiguration { /** Specifies whether password authentication should be disabled. */ disablePasswordAuthentication?: boolean; /** Specifies the ssh key configuration for a Linux OS. */ ssh?: SshConfiguration; /** 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?: LinuxPatchSettings; /** 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 SshConfiguration { /** The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: SshPublicKey[]; } /** Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ export interface SshPublicKey { /** 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 LinuxPatchSettings { /** 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?: LinuxVMGuestPatchMode; /** 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?: LinuxPatchAssessmentMode; /** Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */ automaticByPlatformSettings?: LinuxVMGuestPatchAutomaticByPlatformSettings; } /** Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */ export interface LinuxVMGuestPatchAutomaticByPlatformSettings { /** Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: LinuxVMGuestPatchAutomaticByPlatformRebootSetting; /** Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; } /** Describes a set of certificates which are all in the same Key Vault. */ export interface VaultSecretGroup { /** The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */ sourceVault?: SubResource; /** The list of key vault references in SourceVault which contain certificates. */ vaultCertificates?: VaultCertificate[]; } /** Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */ export interface VaultCertificate { /** 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 Win