@microsoft/terraform-cdk-constructs 1.0.0 → 1.2.0

package/lib/azure-vmss/lib/virtual-machine-scale-set.d.ts

@@ -0,0 +1,258 @@
+/**
+ * Unified Azure Virtual Machine Scale Set implementation using AzapiResource framework
+ *
+ * This class provides a single, version-aware implementation for Azure Virtual Machine Scale Sets
+ * that automatically handles version management, schema validation, and property transformation
+ * across all supported API versions.
+ *
+ * Supported API Versions:
+ * - 2025-01-02 (Active)
+ * - 2025-02-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 VMSS features (scaling, upgrades, orchestration)
+ * - Code reuse from VM implementation for common profiles
+ */
+import * as cdktf from "cdktf";
+import { Construct } from "constructs";
+import { VirtualMachineScaleSetSku, OrchestrationMode, VirtualMachineScaleSetProps, VmssMonitoringOptions } from "./vmss-schemas";
+import { AzapiResource, MonitoringConfig } from "../../core-azure/lib/azapi/azapi-resource";
+import { ApiSchema } from "../../core-azure/lib/version-manager/interfaces/version-interfaces";
+/**
+ * Unified Azure Virtual Machine Scale Set 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 AzapiResource 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 Uniform VMSS with Linux VMs:
+ * const vmss = new VirtualMachineScaleSet(this, "vmss", {
+ *   name: "my-vmss",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   sku: {
+ *     name: "Standard_D2s_v3",
+ *     capacity: 3
+ *   },
+ *   orchestrationMode: "Uniform",
+ *   upgradePolicy: {
+ *     mode: "Automatic"
+ *   },
+ *   virtualMachineProfile: {
+ *     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: "vmss-vm",
+ *       adminUsername: "azureuser",
+ *       linuxConfiguration: {
+ *         disablePasswordAuthentication: true,
+ *         ssh: {
+ *           publicKeys: [{
+ *             path: "/home/azureuser/.ssh/authorized_keys",
+ *             keyData: "ssh-rsa AAAA..."
+ *           }]
+ *         }
+ *       }
+ *     },
+ *     networkProfile: {
+ *       networkInterfaceConfigurations: [{
+ *         name: "nic-config",
+ *         properties: {
+ *           primary: true,
+ *           ipConfigurations: [{
+ *             name: "ip-config",
+ *             properties: {
+ *               subnet: {
+ *                 id: subnet.id
+ *               }
+ *             }
+ *           }]
+ *         }
+ *       }],
+ *       // networkApiVersion is automatically set to latest when not specified
+ *       // Explicitly set only if you need to pin to a specific version
+ *       // networkApiVersion: "2024-10-01"
+ *     }
+ *   }
+ * });
+ *
+ * @example
+ * // Flexible orchestration mode with rolling upgrades:
+ * const flexibleVmss = new VirtualMachineScaleSet(this, "flexible-vmss", {
+ *   name: "my-flexible-vmss",
+ *   location: "eastus",
+ *   resourceGroupId: resourceGroup.id,
+ *   sku: {
+ *     name: "Standard_D2s_v3",
+ *     capacity: 5
+ *   },
+ *   orchestrationMode: "Flexible",
+ *   upgradePolicy: {
+ *     mode: "Rolling",
+ *     rollingUpgradePolicy: {
+ *       maxBatchInstancePercent: 20,
+ *       maxUnhealthyInstancePercent: 20,
+ *       maxUnhealthyUpgradedInstancePercent: 20,
+ *       pauseTimeBetweenBatches: "PT5S"
+ *     }
+ *   },
+ *   automaticRepairsPolicy: {
+ *     enabled: true,
+ *     gracePeriod: "PT30M"
+ *   }
+ * });
+ *
+ * @stability stable
+ */
+export declare class VirtualMachineScaleSet extends AzapiResource {
+    /**
+     * Returns a production-ready monitoring configuration for Virtual Machine Scale Sets
+     *
+     * This static factory method provides a complete MonitoringConfig with sensible defaults
+     * for VMSS monitoring including CPU, memory, disk queue alerts, and deletion tracking.
+     *
+     * VMSS uses a lower CPU threshold (75%) compared to single VMs (80%) to allow headroom
+     * for scaling operations before reaching saturation.
+     *
+     * @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 VirtualMachineScaleSet props
+     *
+     * @example
+     * // Basic usage with all defaults
+     * const vmss = new VirtualMachineScaleSet(this, "vmss", {
+     *   // ... other properties ...
+     *   monitoring: VirtualMachineScaleSet.defaultMonitoring(actionGroup.id, workspace.id)
+     * });
+     *
+     * @example
+     * // Custom thresholds and severities
+     * const vmss = new VirtualMachineScaleSet(this, "vmss", {
+     *   // ... other properties ...
+     *   monitoring: VirtualMachineScaleSet.defaultMonitoring(
+     *     actionGroup.id,
+     *     workspace.id,
+     *     {
+     *       cpuThreshold: 85,
+     *       memoryThreshold: 536870912, // 512MB
+     *       enableDiskQueueAlert: false,
+     *       cpuAlertSeverity: 1 // Error level
+     *     }
+     *   )
+     * });
+     *
+     * @stability stable
+     */
+    static defaultMonitoring(actionGroupId: string, workspaceId?: string, options?: VmssMonitoringOptions): MonitoringConfig;
+    /**
+     * Static initialization flag to ensure schemas are registered only once
+     */
+    private static schemasRegistered;
+    /**
+     * Ensures that VMSS schemas are registered with the ApiVersionManager
+     * This is called once during the first VirtualMachineScaleSet instantiation
+     */
+    private static ensureSchemasRegistered;
+    /**
+     * The input properties for this VMSS instance
+     */
+    readonly props: VirtualMachineScaleSetProps;
+    readonly idOutput: cdktf.TerraformOutput;
+    readonly locationOutput: cdktf.TerraformOutput;
+    readonly nameOutput: cdktf.TerraformOutput;
+    readonly tagsOutput: cdktf.TerraformOutput;
+    readonly uniqueIdOutput: cdktf.TerraformOutput;
+    readonly id: string;
+    readonly tags: {
+        [key: string]: string;
+    };
+    /**
+     * Creates a new Azure Virtual Machine Scale Set using the AzapiResource 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 Scale Set
+     */
+    constructor(scope: Construct, id: string, props: VirtualMachineScaleSetProps);
+    /**
+     * 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 Machine Scale Sets
+     */
+    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;
+    /**
+     * 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 unique ID (unique identifier assigned by Azure)
+     */
+    get uniqueId(): string;
+    /**
+     * Get the provisioning state of the Virtual Machine Scale Set
+     */
+    get provisioningState(): string;
+    /**
+     * Get the SKU configuration
+     */
+    get sku(): VirtualMachineScaleSetSku;
+    /**
+     * Get the capacity (number of VMs)
+     */
+    get capacity(): number | undefined;
+    /**
+     * Get the orchestration mode
+     */
+    get orchestrationMode(): OrchestrationMode | undefined;
+    /**
+     * Add a tag to the Virtual Machine Scale Set
+     * 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 Scale Set
+     * 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;
+}