@microsoft/terraform-cdk-constructs 1.0.0 → 1.3.0

package/lib/azure-virtualmachine/lib/virtual-machine-schemas.d.ts

@@ -0,0 +1,327 @@
+/**
+ * API schemas for Azure Virtual Machine across all supported versions
+ *
+ * This file defines the complete API schemas for Microsoft.Compute/virtualMachines
+ * across all supported API versions. The schemas are used by the VersionedAzapiResource
+ * framework for validation, transformation, and version management.
+ *
+ * API Versions verified from Azure REST API Specifications:
+ * - 2024-07-01: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01
+ * - 2024-11-01: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-11-01
+ * - 2025-04-01: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01
+ */
+import { ApiSchema, VersionConfig } from "../../core-azure/lib/version-manager/interfaces/version-interfaces";
+/**
+ * Hardware profile for the virtual machine
+ */
+export interface VirtualMachineHardwareProfile {
+    readonly vmSize: string;
+}
+/**
+ * Image reference for OS disk
+ */
+export interface VirtualMachineImageReference {
+    readonly publisher?: string;
+    readonly offer?: string;
+    readonly sku?: string;
+    readonly version?: string;
+    readonly id?: string;
+}
+/**
+ * OS disk configuration
+ */
+export interface VirtualMachineOSDisk {
+    readonly name?: string;
+    readonly createOption: string;
+    readonly caching?: string;
+    readonly diskSizeGB?: number;
+    readonly managedDisk?: VirtualMachineManagedDiskParameters;
+    readonly osType?: string;
+}
+/**
+ * Data disk configuration
+ */
+export interface VirtualMachineDataDisk {
+    readonly lun: number;
+    readonly name?: string;
+    readonly createOption: string;
+    readonly caching?: string;
+    readonly diskSizeGB?: number;
+    readonly managedDisk?: VirtualMachineManagedDiskParameters;
+}
+/**
+ * Managed disk parameters
+ */
+export interface VirtualMachineManagedDiskParameters {
+    readonly storageAccountType?: string;
+    readonly id?: string;
+    readonly diskEncryptionSet?: VirtualMachineDiskEncryptionSetParameters;
+}
+/**
+ * Disk encryption set parameters
+ */
+export interface VirtualMachineDiskEncryptionSetParameters {
+    readonly id?: string;
+}
+/**
+ * Storage profile for the virtual machine
+ */
+export interface VirtualMachineStorageProfile {
+    readonly imageReference?: VirtualMachineImageReference;
+    readonly osDisk: VirtualMachineOSDisk;
+    readonly dataDisks?: VirtualMachineDataDisk[];
+}
+/**
+ * Network interface properties
+ */
+export interface VirtualMachineNetworkInterfaceProperties {
+    readonly primary?: boolean;
+}
+/**
+ * Network interface reference
+ */
+export interface VirtualMachineNetworkInterfaceReference {
+    readonly id: string;
+    readonly properties?: VirtualMachineNetworkInterfaceProperties;
+}
+/**
+ * Network profile for the virtual machine
+ */
+export interface VirtualMachineNetworkProfile {
+    readonly networkInterfaces: VirtualMachineNetworkInterfaceReference[];
+}
+/**
+ * SSH public key
+ */
+export interface VirtualMachineSshPublicKey {
+    readonly path: string;
+    readonly keyData: string;
+}
+/**
+ * SSH configuration
+ */
+export interface VirtualMachineSshConfiguration {
+    readonly publicKeys?: VirtualMachineSshPublicKey[];
+}
+/**
+ * Linux configuration
+ */
+export interface VirtualMachineLinuxConfiguration {
+    readonly disablePasswordAuthentication?: boolean;
+    readonly ssh?: VirtualMachineSshConfiguration;
+    readonly provisionVMAgent?: boolean;
+    readonly patchSettings?: VirtualMachineLinuxPatchSettings;
+}
+/**
+ * Linux patch settings
+ */
+export interface VirtualMachineLinuxPatchSettings {
+    readonly patchMode?: string;
+    readonly assessmentMode?: string;
+}
+/**
+ * Windows configuration
+ */
+export interface VirtualMachineWindowsConfiguration {
+    readonly provisionVMAgent?: boolean;
+    readonly enableAutomaticUpdates?: boolean;
+    readonly timeZone?: string;
+    readonly patchSettings?: VirtualMachineWindowsPatchSettings;
+    readonly winRM?: VirtualMachineWinRMConfiguration;
+}
+/**
+ * Windows patch settings
+ */
+export interface VirtualMachineWindowsPatchSettings {
+    readonly patchMode?: string;
+    readonly assessmentMode?: string;
+    readonly enableHotpatching?: boolean;
+}
+/**
+ * WinRM configuration
+ */
+export interface VirtualMachineWinRMConfiguration {
+    readonly listeners?: VirtualMachineWinRMListener[];
+}
+/**
+ * WinRM listener
+ */
+export interface VirtualMachineWinRMListener {
+    readonly protocol: string;
+    readonly certificateUrl?: string;
+}
+/**
+ * OS profile for the virtual machine
+ */
+export interface VirtualMachineOSProfile {
+    readonly computerName: string;
+    readonly adminUsername: string;
+    readonly adminPassword?: string;
+    readonly customData?: string;
+    readonly linuxConfiguration?: VirtualMachineLinuxConfiguration;
+    readonly windowsConfiguration?: VirtualMachineWindowsConfiguration;
+    readonly secrets?: VirtualMachineSecret[];
+    readonly allowExtensionOperations?: boolean;
+}
+/**
+ * Secret for OS profile
+ */
+export interface VirtualMachineSecret {
+    readonly sourceVault?: VirtualMachineSubResource;
+    readonly vaultCertificates?: VirtualMachineVaultCertificate[];
+}
+/**
+ * Sub-resource reference
+ */
+export interface VirtualMachineSubResource {
+    readonly id?: string;
+}
+/**
+ * Vault certificate
+ */
+export interface VirtualMachineVaultCertificate {
+    readonly certificateUrl?: string;
+    readonly certificateStore?: string;
+}
+/**
+ * Identity configuration for the virtual machine
+ */
+export interface VirtualMachineIdentity {
+    readonly type: string;
+    readonly userAssignedIdentities?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Plan information for marketplace images
+ */
+export interface VirtualMachinePlan {
+    readonly name?: string;
+    readonly publisher?: string;
+    readonly product?: string;
+    readonly promotionCode?: string;
+}
+/**
+ * Additional capabilities
+ */
+export interface VirtualMachineAdditionalCapabilities {
+    readonly ultraSSDEnabled?: boolean;
+    readonly hibernationEnabled?: boolean;
+}
+/**
+ * Boot diagnostics configuration
+ */
+export interface VirtualMachineBootDiagnostics {
+    readonly enabled?: boolean;
+    readonly storageUri?: string;
+}
+/**
+ * Diagnostics profile
+ */
+export interface VirtualMachineDiagnosticsProfile {
+    readonly bootDiagnostics?: VirtualMachineBootDiagnostics;
+}
+/**
+ * Priority and eviction policy for spot VMs
+ */
+export interface VirtualMachinePriorityProfile {
+    readonly priority?: string;
+    readonly evictionPolicy?: string;
+    readonly billingProfile?: VirtualMachineBillingProfile;
+}
+/**
+ * Billing profile for spot VMs
+ */
+export interface VirtualMachineBillingProfile {
+    readonly maxPrice?: number;
+}
+/**
+ * Security profile
+ */
+export interface VirtualMachineSecurityProfile {
+    readonly uefiSettings?: VirtualMachineUefiSettings;
+    readonly encryptionAtHost?: boolean;
+    readonly securityType?: string;
+}
+/**
+ * UEFI settings
+ */
+export interface VirtualMachineUefiSettings {
+    readonly secureBootEnabled?: boolean;
+    readonly vTpmEnabled?: boolean;
+}
+/**
+ * Availability set reference
+ */
+export interface VirtualMachineAvailabilitySetReference {
+    readonly id?: string;
+}
+/**
+ * Virtual machine scale set reference
+ */
+export interface VirtualMachineScaleSetReference {
+    readonly id?: string;
+}
+/**
+ * Proximity placement group reference
+ */
+export interface VirtualMachineProximityPlacementGroupReference {
+    readonly id?: string;
+}
+/**
+ * Host reference
+ */
+export interface VirtualMachineHostReference {
+    readonly id?: string;
+}
+/**
+ * License type
+ */
+export type VirtualMachineLicenseType = "Windows_Client" | "Windows_Server" | "None";
+/**
+ * Configuration options for Virtual Machine monitoring
+ */
+export interface VirtualMachineMonitoringOptions {
+    readonly cpuThreshold?: number;
+    readonly memoryThreshold?: number;
+    readonly diskQueueThreshold?: number;
+    readonly enableCpuAlert?: boolean;
+    readonly enableMemoryAlert?: boolean;
+    readonly enableDiskQueueAlert?: boolean;
+    readonly enableDeletionAlert?: boolean;
+    readonly cpuAlertSeverity?: 0 | 1 | 2 | 3 | 4;
+    readonly memoryAlertSeverity?: 0 | 1 | 2 | 3 | 4;
+    readonly diskQueueAlertSeverity?: 0 | 1 | 2 | 3 | 4;
+}
+/**
+ * API Schema for Virtual Machine version 2024-11-01
+ */
+export declare const VIRTUAL_MACHINE_SCHEMA_2024_11_01: ApiSchema;
+/**
+ * API Schema for Virtual Machine version 2025-04-01
+ */
+export declare const VIRTUAL_MACHINE_SCHEMA_2025_04_01: ApiSchema;
+/**
+ * API Schema for Virtual Machine version 2024-07-01
+ */
+export declare const VIRTUAL_MACHINE_SCHEMA_2024_07_01: ApiSchema;
+/**
+ * Version configuration for Virtual Machine 2024-11-01
+ */
+export declare const VIRTUAL_MACHINE_VERSION_2024_11_01: VersionConfig;
+/**
+ * Version configuration for Virtual Machine 2025-04-01
+ */
+export declare const VIRTUAL_MACHINE_VERSION_2025_04_01: VersionConfig;
+/**
+ * Version configuration for Virtual Machine 2024-07-01
+ */
+export declare const VIRTUAL_MACHINE_VERSION_2024_07_01: VersionConfig;
+/**
+ * All supported Virtual Machine versions for registration
+ */
+export declare const ALL_VIRTUAL_MACHINE_VERSIONS: VersionConfig[];
+/**
+ * Resource type constant
+ */
+export declare const VIRTUAL_MACHINE_TYPE = "Microsoft.Compute/virtualMachines";