Update-AzVMwarePrivateCloud

Reference

Module:: Az.VMware

Update a PrivateCloud

Syntax

Update-AzVMwarePrivateCloud
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DnsZoneType <String>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-EncryptionStatus <String>]
      [-ExtendedNetworkBlock <String[]>]
      [-IdentitySource <IIdentitySource[]>]
      [-Internet <String>]
      [-KeyVaultPropertyKeyName <String>]
      [-KeyVaultPropertyKeyVaultUrl <String>]
      [-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>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVMwarePrivateCloud
      -InputObject <IVMwareIdentity>
      [-DnsZoneType <String>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-EncryptionStatus <String>]
      [-ExtendedNetworkBlock <String[]>]
      [-IdentitySource <IIdentitySource[]>]
      [-Internet <String>]
      [-KeyVaultPropertyKeyName <String>]
      [-KeyVaultPropertyKeyVaultUrl <String>]
      [-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>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update a PrivateCloud

Examples

Example 1: Update size of private cloud by name

Update-AzVMwarePrivateCloud -Name azps_test_cloud -ResourceGroupName azps_test_group

Location      Name            Type                        ResourceGroupName
--------      ----            ----                        -----------------
australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group

Update size of private cloud by name

Example 2: Update size of private cloud

Get-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud | Update-AzVMwarePrivateCloud

Location      Name            Type                        ResourceGroupName
--------      ----            ----                        -----------------
australiaeast azps_test_cloud Microsoft.AVS/privateClouds azps_test_group

Update size of private cloud

Parameters

-AsJob

Run the command as a job

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DnsZoneType

The type of DNS zone to use.

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

-EnableSystemAssignedIdentity

Decides if enable a system assigned identity for the resource.

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionStatus

Status of customer managed encryption key

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

-ExtendedNetworkBlock

Array of additional networks noncontiguous with networkBlock. Networks must beunique and non-overlapping across VNet in your subscription, on-premise, andthis privateCloud networkBlock attribute. Make sure the CIDR format conforms to(A.B.C.D/X).

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentitySource

vCenter Single Sign On Identity Sources

Type:	IIdentitySource[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter

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

-Internet

Connectivity to internet is enabled or disabled

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

-KeyVaultPropertyKeyName

The name of the key.

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

-KeyVaultPropertyKeyVaultUrl

The URL of the vault.

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

-KeyVaultPropertyKeyVersion

The version of the key.

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

-ManagementClusterHost

The hosts

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagementClusterSize

The cluster size

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

-ManagementClusterVsanDatastoreName

Name of the vsan datastore associated with the cluster

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

-Name

Name of the private cloud

Type:	String
Aliases:	PrivateCloudName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NetworkBlock

The block of addresses should be unique across VNet in your subscription aswell as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) whereA,B,C,D are between 0 and 255, and X is between 0 and 22

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

-NoWait

Run the command asynchronously

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

-NsxtPassword

Optionally, set the NSX-T Manager password when the private cloud is created

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SkuCapacity

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

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

-SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

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

-SkuName

The name of the SKU. E.g. P3. It is typically a letter+number code

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

-SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

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

-SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

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

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Resource tags.

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

-VcenterPassword

Optionally, set the vCenter admin password when the private cloud is created

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IVMwareIdentity

Outputs

IPrivateCloud

Share via