@microsoft/terraform-cdk-constructs 1.0.0 → 1.3.0

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

@@ -0,0 +1,368 @@
+/**
+ * Unified Azure Virtual Machine implementation using VersionedAzapiResource framework
+ *
+ * This class provides a single, version-aware implementation for Azure Virtual Machines
+ * that automatically handles version management, schema validation, and property transformation
+ * across all supported API versions.
+ *
+ * Supported API Versions:
+ * - 2024-07-01 (Active)
+ * - 2024-11-01 (Active)
+ * - 2025-04-01 (Active, Latest)
+ *
+ * Features:
+ * - Automatic latest version resolution when no version is specified
+ * - Explicit version pinning for stability requirements
+ * - Schema-driven validation and transformation
+ * - Full JSII compliance for multi-language support
+ * - Comprehensive support for VM features (networking, storage, identity, etc.)
+ */
+import * as cdktf from "cdktf";
+import { Construct } from "constructs";
+import { VirtualMachineHardwareProfile, VirtualMachineStorageProfile, VirtualMachineNetworkProfile, VirtualMachineOSProfile, VirtualMachineIdentity, VirtualMachinePlan, VirtualMachineAdditionalCapabilities, VirtualMachineDiagnosticsProfile, VirtualMachineSecurityProfile, VirtualMachineLicenseType, VirtualMachineAvailabilitySetReference, VirtualMachineScaleSetReference, VirtualMachineProximityPlacementGroupReference, VirtualMachineHostReference, VirtualMachineBillingProfile, VirtualMachineMonitoringOptions } from "./virtual-machine-schemas";
+import { AzapiResource, AzapiResourceProps, MonitoringConfig } from "../../core-azure/lib/azapi/azapi-resource";
+import { ApiSchema } from "../../core-azure/lib/version-manager/interfaces/version-interfaces";
+/**
+ * Properties for the unified Azure Virtual Machine
+ *
+ * Extends AzapiResourceProps with Virtual Machine specific properties
+ */
+export interface VirtualMachineProps extends AzapiResourceProps {
+    /**
+     * The hardware profile for the Virtual Machine (VM size)
+     * @example { vmSize: "Standard_D2s_v3" }
+     */
+    readonly hardwareProfile: VirtualMachineHardwareProfile;
+    /**
+     * The storage profile for the Virtual Machine
+     * Defines the OS disk, data disks, and image reference
+     */
+    readonly storageProfile: VirtualMachineStorageProfile;
+    /**
+     * The network profile for the Virtual Machine
+     * Defines network interfaces attached to the VM
+     */
+    readonly networkProfile: VirtualMachineNetworkProfile;
+    /**
+     * The OS profile for the Virtual Machine
+     * Defines computer name, admin credentials, and OS-specific configuration
+     */
+    readonly osProfile?: VirtualMachineOSProfile;
+    /**
+     * The identity configuration for the Virtual Machine
+     * @example { type: "SystemAssigned" }
+     * @example { type: "UserAssigned", userAssignedIdentities: { "/subscriptions/.../resourceGroups/.../providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {} } }
+     */
+    readonly identity?: VirtualMachineIdentity;
+    /**
+     * Availability zones for the Virtual Machine
+     * @example ["1", "2"]
+     */
+    readonly zones?: string[];
+    /**
+     * Plan information for marketplace images
+     */
+    readonly plan?: VirtualMachinePlan;
+    /**
+     * License type for Windows VMs
+     * @example "Windows_Server"
+     * @example "Windows_Client"
+     */
+    readonly licenseType?: VirtualMachineLicenseType;
+    /**
+     * The priority of the Virtual Machine
+     * @default "Regular"
+     * @example "Regular", "Low", "Spot"
+     */
+    readonly priority?: string;
+    /**
+     * The eviction policy for Spot VMs
+     * @example "Deallocate", "Delete"
+     */
+    readonly evictionPolicy?: string;
+    /**
+     * The billing profile for Spot VMs
+     */
+    readonly billingProfile?: VirtualMachineBillingProfile;
+    /**
+     * The diagnostics profile for boot diagnostics
+     */
+    readonly diagnosticsProfile?: VirtualMachineDiagnosticsProfile;
+    /**
+     * Reference to an availability set
+     */
+    readonly availabilitySet?: VirtualMachineAvailabilitySetReference;
+    /**
+     * Reference to a virtual machine scale set
+     */
+    readonly virtualMachineScaleSet?: VirtualMachineScaleSetReference;
+    /**
+     * Reference to a proximity placement group
+     */
+    readonly proximityPlacementGroup?: VirtualMachineProximityPlacementGroupReference;
+    /**
+     * Reference to a dedicated host
+     */
+    readonly host?: VirtualMachineHostReference;
+    /**
+     * Additional capabilities like Ultra SSD
+     */
+    readonly additionalCapabilities?: VirtualMachineAdditionalCapabilities;
+    /**
+     * Security settings for the Virtual Machine
+     */
+    readonly securityProfile?: VirtualMachineSecurityProfile;
+    /**
+     * The lifecycle rules to ignore changes
+     * Useful for properties that are externally managed or should not trigger updates
+     * @example ["osProfile.adminPassword"]
+     */
+    readonly ignoreChanges?: string[];
+    /**
+     * Resource group ID where the Virtual Machine will be created
+     */
+    readonly resourceGroupId?: string;
+}
+/**
+ * Virtual Machine properties for the request body
+ */
+export interface VirtualMachineBodyProperties {
+    readonly hardwareProfile: VirtualMachineHardwareProfile;
+    readonly storageProfile: VirtualMachineStorageProfile;
+    readonly osProfile?: VirtualMachineOSProfile;
+    readonly networkProfile: VirtualMachineNetworkProfile;
+    readonly diagnosticsProfile?: VirtualMachineDiagnosticsProfile;
+    readonly availabilitySet?: VirtualMachineAvailabilitySetReference;
+    readonly virtualMachineScaleSet?: VirtualMachineScaleSetReference;
+    readonly proximityPlacementGroup?: VirtualMachineProximityPlacementGroupReference;
+    readonly priority?: string;
+    readonly evictionPolicy?: string;
+    readonly billingProfile?: VirtualMachineBillingProfile;
+    readonly host?: VirtualMachineHostReference;
+    readonly licenseType?: VirtualMachineLicenseType;
+    readonly additionalCapabilities?: VirtualMachineAdditionalCapabilities;
+    readonly securityProfile?: VirtualMachineSecurityProfile;
+}
+/**
+ * The resource body interface for Azure Virtual Machine API calls
+ */
+export interface VirtualMachineBody {
+    readonly location: string;
+    readonly tags?: {
+        [key: string]: string;
+    };
+    readonly identity?: VirtualMachineIdentity;
+    readonly zones?: string[];
+    readonly plan?: VirtualMachinePlan;
+    readonly properties: VirtualMachineBodyProperties;
+}
+/**
+ * Unified Azure Virtual Machine implementation
+ *
+ * This class provides a single, version-aware implementation that automatically handles version
+ * resolution, schema validation, and property transformation while maintaining full JSII compliance.
+ *
+ * The class uses the VersionedAzapiResource framework to provide:
+ * - Automatic latest version resolution (2025-04-01 as of this implementation)
+ * - Support for explicit version pinning when stability is required
+ * - Schema-driven property validation and transformation
+ * - Migration analysis and deprecation warnings
+ * - Full JSII compliance for multi-language support
+ *
+ * @example
+ * // Basic Linux VM with SSH authentication:
+ * const vm = new VirtualMachine(this, "vm", {
+ *   name: "my-linux-vm",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   hardwareProfile: {
+ *     vmSize: "Standard_D2s_v3"
+ *   },
+ *   storageProfile: {
+ *     imageReference: {
+ *       publisher: "Canonical",
+ *       offer: "0001-com-ubuntu-server-jammy",
+ *       sku: "22_04-lts-gen2",
+ *       version: "latest"
+ *     },
+ *     osDisk: {
+ *       createOption: "FromImage",
+ *       managedDisk: {
+ *         storageAccountType: "Premium_LRS"
+ *       }
+ *     }
+ *   },
+ *   osProfile: {
+ *     computerName: "myvm",
+ *     adminUsername: "azureuser",
+ *     linuxConfiguration: {
+ *       disablePasswordAuthentication: true,
+ *       ssh: {
+ *         publicKeys: [{
+ *           path: "/home/azureuser/.ssh/authorized_keys",
+ *           keyData: "ssh-rsa AAAA..."
+ *         }]
+ *       }
+ *     }
+ *   },
+ *   networkProfile: {
+ *     networkInterfaces: [{
+ *       id: networkInterface.id
+ *     }]
+ *   },
+ *   identity: {
+ *     type: "SystemAssigned"
+ *   }
+ * });
+ *
+ * @example
+ * // Windows VM with password authentication:
+ * const windowsVm = new VirtualMachine(this, "windows-vm", {
+ *   name: "my-windows-vm",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   hardwareProfile: {
+ *     vmSize: "Standard_D2s_v3"
+ *   },
+ *   storageProfile: {
+ *     imageReference: {
+ *       publisher: "MicrosoftWindowsServer",
+ *       offer: "WindowsServer",
+ *       sku: "2022-datacenter-azure-edition",
+ *       version: "latest"
+ *     },
+ *     osDisk: {
+ *       createOption: "FromImage",
+ *       managedDisk: {
+ *         storageAccountType: "Premium_LRS"
+ *       }
+ *     }
+ *   },
+ *   osProfile: {
+ *     computerName: "mywinvm",
+ *     adminUsername: "azureuser",
+ *     adminPassword: "P@ssw0rd1234!",
+ *     windowsConfiguration: {
+ *       provisionVMAgent: true,
+ *       enableAutomaticUpdates: true
+ *     }
+ *   },
+ *   networkProfile: {
+ *     networkInterfaces: [{
+ *       id: networkInterface.id
+ *     }]
+ *   },
+ *   licenseType: "Windows_Server"
+ * });
+ *
+ * @stability stable
+ */
+export declare class VirtualMachine extends AzapiResource {
+    /**
+     * Returns a production-ready monitoring configuration for Virtual Machines
+     *
+     * This static factory method provides a complete MonitoringConfig with sensible defaults
+     * for VM monitoring including CPU, memory, disk queue alerts, and deletion tracking.
+     *
+     * @param actionGroupId - The resource ID of the action group for alert notifications
+     * @param workspaceId - Optional Log Analytics workspace ID for diagnostic settings
+     * @param options - Optional configuration to customize thresholds and enable/disable specific alerts
+     * @returns A complete MonitoringConfig object ready to use in VirtualMachine props
+     *
+     * @example
+     * // Basic usage with all defaults
+     * const vm = new VirtualMachine(this, "vm", {
+     *   // ... other properties ...
+     *   monitoring: VirtualMachine.defaultMonitoring(actionGroup.id, workspace.id)
+     * });
+     *
+     * @example
+     * // Custom thresholds
+     * const vm = new VirtualMachine(this, "vm", {
+     *   // ... other properties ...
+     *   monitoring: VirtualMachine.defaultMonitoring(
+     *     actionGroup.id,
+     *     workspace.id,
+     *     {
+     *       cpuThreshold: 90,
+     *       memoryThreshold: 536870912, // 512MB
+     *       enableDiskQueueAlert: false
+     *     }
+     *   )
+     * });
+     */
+    static defaultMonitoring(actionGroupId: string, workspaceId?: string, options?: VirtualMachineMonitoringOptions): MonitoringConfig;
+    /**
+     * The input properties for this Virtual Machine instance
+     */
+    readonly props: VirtualMachineProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly locationOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly tagsOutput: cdktf.TerraformOutput;
+    readonly vmIdOutput: cdktf.TerraformOutput;
+    /**
+     * Creates a new Azure Virtual Machine using the VersionedAzapiResource framework
+     *
+     * The constructor automatically handles version resolution, schema registration,
+     * validation, and resource creation.
+     *
+     * @param scope - The scope in which to define this construct
+     * @param id - The unique identifier for this instance
+     * @param props - Configuration properties for the Virtual Machine
+     */
+    constructor(scope: Construct, id: string, props: VirtualMachineProps);
+    /**
+     * Gets the default API version to use when no explicit version is specified
+     * Returns the most recent stable version as the default
+     */
+    protected defaultVersion(): string;
+    /**
+     * Gets the Azure resource type for Virtual Machines
+     */
+    protected resourceType(): string;
+    /**
+     * Gets the API schema for the resolved version
+     * Uses the framework's schema resolution to get the appropriate schema
+     */
+    protected apiSchema(): ApiSchema;
+    /**
+     * Indicates that location is required for Virtual Machines
+     */
+    protected requiresLocation(): boolean;
+    /**
+     * Creates the resource body for the Azure API call
+     * Transforms the input properties into the JSON format expected by Azure REST API
+     */
+    protected createResourceBody(props: any): any;
+    /**
+     * Get the VM ID (unique identifier assigned by Azure)
+     */
+    get vmId(): string;
+    /**
+     * Get the provisioning state of the Virtual Machine
+     */
+    get provisioningState(): string;
+    /**
+     * Get the OS profile computer name
+     */
+    get computerName(): string | undefined;
+    /**
+     * Get the VM size
+     */
+    get vmSize(): string;
+    /**
+     * Add a tag to the Virtual Machine
+     * Note: This modifies the construct props but requires a new deployment to take effect
+     */
+    addTag(key: string, value: string): void;
+    /**
+     * Remove a tag from the Virtual Machine
+     * Note: This modifies the construct props but requires a new deployment to take effect
+     */
+    removeTag(key: string): void;
+    /**
+     * Applies ignore changes lifecycle rules if specified in props
+     */
+    private _applyIgnoreChanges;
+}