Add -VcfLicense parameter to New-AzVMwarePrivateCloud (#29765)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: anaarias-msft

src/VMware/VMware.Autorest/README.md

@@ -152,15 +152,26 @@ directive:
       verb: Update
       subject: HcxEnterpriseSite|ScriptExecution|Addon
     remove: true
+  # Prevent flattening of discriminated union types — these must be passed as full objects.
+  # AddonProperties and PlacementPolicyProperties are polymorphic base types whose subtypes
+  # are constructed via dedicated New-AzVMware*Object cmdlets.
+  # VcfLicense is a discriminated union type (base: VcfLicense, concrete: Vcf5License).
+  # AutoRest cannot safely flatten it, so we keep it as a single -VcfLicense parameter.
   - no-inline:
       - AddonProperties
       - PlacementPolicyProperties
-  # Re-name and custom it
+      - VcfLicense
+  # Generate helper object cmdlets for model types that are discriminated unions and
+  # cannot be flattened into individual cmdlet parameters.
   - model-cmdlet:
       - model-name: VMPlacementPolicyProperties
         cmdlet-name: New-AzVMwareVMPlacementPolicyPropertyObject
       - model-name: VmHostPlacementPolicyProperties
         cmdlet-name: New-AzVMwareVmHostPlacementPolicyPropertyObject
+      # Vcf5License is the only concrete subtype of VcfLicense in the 2025-09-01 API.
+      # The helper cmdlet constructs a Vcf5License object for use with New-AzVMwarePrivateCloud -VcfLicense.
+      - model-name: Vcf5License
+        cmdlet-name: New-AzVMwareVcf5LicenseObject
       # - model-name: ScriptSecureStringExecutionParameter
       # - model-name: ScriptStringExecutionParameter
       # - model-name: PSCredentialExecutionParameter

src/VMware/VMware.Autorest/custom/New-AzVMwarePrivateCloud.ps1

@@ -46,6 +46,9 @@ IDENTITYSOURCE <IIdentitySource[]>: vCenter Single Sign On Identity Sources
   [SecondaryServer <String>]: Secondary server URL
   [Ssl <String?>]: Protect LDAP communication using SSL certificate (LDAPS)
   [Username <String>]: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group
+
+VCFLICENSE <IVcfLicense>: The VMware Cloud Foundation (VCF) license for the private cloud. Use New-AzVMwareVcf5LicenseObject to create the license object.
+  [Kind <String>]: License kind (e.g. vcf5)
 .Link
 https://learn.microsoft.com/powershell/module/az.vmware/new-azvmwareprivatecloud
 #>
@@ -202,6 +205,14 @@ function New-AzVMwarePrivateCloud {
         # Optionally, set the vCenter admin password when the private cloud is created
         ${VcenterPassword},
 
+        [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.VMware.Category('Body')]
+        [Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVcfLicense]
+        # The VMware Cloud Foundation (VCF) license for the private cloud.
+        # To construct, see NOTES section for VCFLICENSE properties and create a hash table,
+        # or use New-AzVMwareVcf5LicenseObject to create a Vcf5License object.
+        ${VcfLicense},
+
         [Parameter()]
         [System.Management.Automation.SwitchParameter]
         # Accept EULA of AVS, legal term will pop up without this parameter provided

src/VMware/VMware.Autorest/custom/autogen-model-cmdlets/New-AzVMwareVcf5LicenseObject.ps1

@@ -0,0 +1,74 @@
+
+# ----------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
+# is regenerated.
+# ----------------------------------------------------------------------------------
+
+<#
+.Synopsis
+Create an in-memory object for Vcf5License.
+.Description
+Create an in-memory object for a VMware Cloud Foundation (VCF) 5.0 license, to be passed to New-AzVMwarePrivateCloud via the -VcfLicense parameter.
+.Example
+$license = New-AzVMwareVcf5LicenseObject -Core 16 -EndDate (Get-Date "2027-01-01") -LicenseKey "12345-12345-12345-12345-12345" -BroadcomSiteId "site123" -BroadcomContractNumber "contract123"
+New-AzVMwarePrivateCloud -Name mycloud -ResourceGroupName myrg -Location eastus -Sku av36 -ManagementClusterSize 3 -NetworkBlock 192.168.48.0/22 -VcfLicense $license -AcceptEULA
+
+.Outputs
+Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Vcf5License
+.Link
+https://learn.microsoft.com/powershell/module/Az.VMware/new-azvmwarevcf5licenseobject
+#>
+function New-AzVMwareVcf5LicenseObject {
+    [Microsoft.Azure.PowerShell.Cmdlets.VMware.ModelCmdletAttribute()]
+    [OutputType('Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Vcf5License')]
+    [CmdletBinding(PositionalBinding=$false)]
+    Param(
+        [Parameter(Mandatory, HelpMessage="Number of cores included in the license.")]
+        [int]
+        $Core,
+
+        [Parameter(Mandatory, HelpMessage="UTC datetime when the license expires.")]
+        [System.DateTime]
+        $EndDate,
+
+        [Parameter(HelpMessage="License key.")]
+        [System.Security.SecureString]
+        $LicenseKey,
+
+        [Parameter(HelpMessage="The Broadcom site ID associated with the license.")]
+        [string]
+        $BroadcomSiteId,
+
+        [Parameter(HelpMessage="The Broadcom contract number associated with the license.")]
+        [string]
+        $BroadcomContractNumber
+    )
+
+    process {
+        $Object = [Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Vcf5License]::New()
+
+        $Object.Core = $Core
+        $Object.EndDate = $EndDate
+
+        if ($PSBoundParameters.ContainsKey('LicenseKey')) {
+            $Object.LicenseKey = $LicenseKey
+        }
+        if ($PSBoundParameters.ContainsKey('BroadcomSiteId')) {
+            $Object.BroadcomSiteId = $BroadcomSiteId
+        }
+        if ($PSBoundParameters.ContainsKey('BroadcomContractNumber')) {
+            $Object.BroadcomContractNumber = $BroadcomContractNumber
+        }
+        return $Object
+    }
+}

src/VMware/VMware/ChangeLog.md

@@ -18,6 +18,8 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added `-VcfLicense` parameter to `New-AzVMwarePrivateCloud` to support setting a VMware Cloud Foundation (VCF) license during private cloud provisioning
+    - Added `New-AzVMwareVcf5LicenseObject` helper cmdlet to construct a VCF 5.0 license object for use with `-VcfLicense`
 
 ## Version 0.9.0
 * Updated the AVS VMware cmdlets api version to `2025-09-01`.