Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@
.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
Create an in-memory object for Vcf5License.
Comment thread
anaarias-msft marked this conversation as resolved.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Vcf5License
Expand All @@ -33,42 +30,49 @@ function New-AzVMwareVcf5LicenseObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Vcf5License')]
[CmdletBinding(PositionalBinding=$false)]
Param(

[Parameter(HelpMessage="The Broadcom contract number associated with the license.")]
[string]
$BroadcomContractNumber,
[Parameter(HelpMessage="The Broadcom site ID associated with the license.")]
[string]
$BroadcomSiteId,
[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="Additional labels passed through for license reporting.")]
[Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ILabel[]]
$Label,
[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
$LicenseKey
)

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('BroadcomContractNumber')) {
$Object.BroadcomContractNumber = $BroadcomContractNumber
}
if ($PSBoundParameters.ContainsKey('BroadcomSiteId')) {
$Object.BroadcomSiteId = $BroadcomSiteId
}
if ($PSBoundParameters.ContainsKey('BroadcomContractNumber')) {
$Object.BroadcomContractNumber = $BroadcomContractNumber
if ($PSBoundParameters.ContainsKey('Core')) {
$Object.Core = $Core
}
if ($PSBoundParameters.ContainsKey('EndDate')) {
$Object.EndDate = $EndDate
}
if ($PSBoundParameters.ContainsKey('Label')) {
$Object.Label = $Label
}
if ($PSBoundParameters.ContainsKey('LicenseKey')) {
$Object.LicenseKey = $LicenseKey
}
return $Object
}
}

3 changes: 3 additions & 0 deletions src/VMware/VMware.Autorest/docs/Az.VMware.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ Create an in-memory object for ScriptSecureStringExecutionParameter.
### [New-AzVMwareScriptStringExecutionParameterObject](New-AzVMwareScriptStringExecutionParameterObject.md)
Create an in-memory object for ScriptStringExecutionParameter.

### [New-AzVMwareVcf5LicenseObject](New-AzVMwareVcf5LicenseObject.md)
Create an in-memory object for Vcf5License.

### [New-AzVMwareVmHostPlacementPolicyPropertyObject](New-AzVMwareVmHostPlacementPolicyPropertyObject.md)
Create an in-memory object for VmHostPlacementPolicyProperties.

Expand Down
20 changes: 19 additions & 1 deletion src/VMware/VMware.Autorest/docs/New-AzVMwarePrivateCloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ New-AzVMwarePrivateCloud -Name <String> -ResourceGroupName <String> -Location <S
[-IdentityType <String>] [-Internet <String>] [-KeyVaultPropertyKeyName <String>]
[-KeyVaultPropertyKeyVaultUrl <String>] [-KeyVaultPropertyKeyVersion <String>]
[-ManagementClusterHost <String[]>] [-NsxtPassword <String>] [-Tag <Hashtable>] [-VcenterPassword <String>]
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
[-VcfLicense <IVcfLicense>] [-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -441,6 +442,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -VcfLicense
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.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVcfLicense
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm
Prompts you for confirmation before running the cmdlet.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ Create a PureStoragePolicy

### Example 1: Create a new Pure Storage policy in a private cloud
```powershell
New-AzVMwarePureStoragePolicy -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -StoragePolicyName azps_test_policy
New-AzVMwarePureStoragePolicy -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -StoragePolicyName storagePolicy1 -StoragePolicyDefinition storagePolicyDefinition1 -StoragePoolId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/PureStorage.Block/storagePools/storagePool1"
```

```output
Name Type ResourceGroupName ProvisioningState StoragePolicyDefinition
---- ---- ----------------- ----------------- ----------------------
azps_test_policy Microsoft.AVS/privateClouds/pureStoragePolicies azps_test_group Succeeded azps_test_policy_definition
storagePolicy1 Microsoft.AVS/privateClouds/pureStoragePolicies azps_test_group Succeeded storagePolicyDefinition1
```

reates a new Pure Storage policy in the specified private cloud and resource group.
Creates a new Pure Storage policy in the specified private cloud and resource group.

## PARAMETERS

Expand Down
142 changes: 142 additions & 0 deletions src/VMware/VMware.Autorest/docs/New-AzVMwareVcf5LicenseObject.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
---
external help file:
Module Name: Az.VMware
online version: https://learn.microsoft.com/powershell/module/Az.VMware/new-azvmwarevcf5licenseobject
schema: 2.0.0
---

# New-AzVMwareVcf5LicenseObject

## SYNOPSIS
Create an in-memory object for Vcf5License.

## SYNTAX

```
New-AzVMwareVcf5LicenseObject -Core <Int32> -EndDate <DateTime> [-BroadcomContractNumber <String>]
[-BroadcomSiteId <String>] [-Label <ILabel[]>] [-LicenseKey <SecureString>] [<CommonParameters>]
```

## DESCRIPTION
Create an in-memory object for Vcf5License.

## EXAMPLES

### Example 1: Create an in-memory object for Vcf5License.
```powershell
New-AzVMwareVcf5LicenseObject -Core 16 -EndDate (Get-Date "2027-01-01") -LicenseKey (ConvertTo-SecureString "YOUR-LICENSE-KEY" -AsPlainText -Force) -BroadcomSiteId "site123" -BroadcomContractNumber "contract123"
```

```output
Core EndDate Kind
---- ------- ----
16 1/1/2027 12:00:00 AM vcf5
```

Creates an in-memory VMware Cloud Foundation (VCF) 5.0 license object to pass to `New-AzVMwarePrivateCloud` via the `-VcfLicense` parameter.

## PARAMETERS

### -BroadcomContractNumber
The Broadcom contract number associated with the license.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -BroadcomSiteId
The Broadcom site ID associated with the license.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Core
Number of cores included in the license.

```yaml
Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EndDate
UTC datetime when the license expires.

```yaml
Type: System.DateTime
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Label
Additional labels passed through for license reporting.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ILabel[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LicenseKey
License key.

```yaml
Type: System.Security.SecureString
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Vcf5License

## NOTES

## RELATED LINKS

25 changes: 20 additions & 5 deletions src/VMware/VMware.Autorest/docs/Update-AzVMwarePrivateCloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Update-AzVMwarePrivateCloud -Name <String> -ResourceGroupName <String> [-Subscri
[-KeyVaultPropertyKeyVersion <String>] [-ManagementClusterHost <String[]>] [-ManagementClusterSize <Int32>]
[-ManagementClusterVsanDatastoreName <String>] [-NetworkBlock <String>] [-NsxtPassword <SecureString>]
[-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <String>]
[-Tag <Hashtable>] [-VcenterPassword <SecureString>] [-Zone <String[]>] [-DefaultProfile <PSObject>] [-AsJob]
[-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
[-Tag <Hashtable>] [-VcenterPassword <SecureString>] [-VcfLicense <IVcfLicense>] [-Zone <String[]>]
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### UpdateViaIdentityExpanded
Expand All @@ -34,8 +34,8 @@ Update-AzVMwarePrivateCloud -InputObject <IVMwareIdentity> [-DnsZoneType <String
[-ManagementClusterHost <String[]>] [-ManagementClusterSize <Int32>]
[-ManagementClusterVsanDatastoreName <String>] [-NetworkBlock <String>] [-NsxtPassword <SecureString>]
[-SkuCapacity <Int32>] [-SkuFamily <String>] [-SkuName <String>] [-SkuSize <String>] [-SkuTier <String>]
[-Tag <Hashtable>] [-VcenterPassword <SecureString>] [-Zone <String[]>] [-DefaultProfile <PSObject>] [-AsJob]
[-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
[-Tag <Hashtable>] [-VcenterPassword <SecureString>] [-VcfLicense <IVcfLicense>] [-Zone <String[]>]
[-DefaultProfile <PSObject>] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -121,7 +121,7 @@ Accept wildcard characters: False
Determines whether to enable a system-assigned identity for the resource.

```yaml
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameter Sets: (All)
Aliases:

Expand Down Expand Up @@ -502,6 +502,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -VcfLicense
The private cloud license

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVcfLicense
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Zone
The availability zones.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### Example 1: Create an in-memory object for Vcf5License.
```powershell
New-AzVMwareVcf5LicenseObject -Core 16 -EndDate (Get-Date "2027-01-01") -LicenseKey (ConvertTo-SecureString "YOUR-LICENSE-KEY" -AsPlainText -Force) -BroadcomSiteId "site123" -BroadcomContractNumber "contract123"
```

```output
Core EndDate Kind
---- ------- ----
16 1/1/2027 12:00:00 AM vcf5
```

Creates an in-memory VMware Cloud Foundation (VCF) 5.0 license object to pass to `New-AzVMwarePrivateCloud` via the `-VcfLicense` parameter.
2 changes: 1 addition & 1 deletion src/VMware/VMware.Autorest/generate-info.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"generate_Id": "2726e206-da56-4c9d-8b45-65d0a875e579"
"generate_Id": "6b5fd672-539d-49db-a352-643b92fcf814"
}
Loading