تحرير

Remove-AzVMwarePrivateCloud

  • Reference
Module:
Az.VMware

Delete a private cloud

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzVMwarePrivateCloud
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-AzVMwarePrivateCloud
      -InputObject <IVMwareIdentity>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Delete a private cloud

Examples

Example 1: Delete private cloud

PS C:\> Remove-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud

Delete private cloud

Example 2: Delete private cloud

PS C:\> Get-AzVMwarePrivateCloud -ResourceGroupName azps_test_group -Name azps_test_cloud | Remove-AzVMwarePrivateCloud

Delete private cloud

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

Name of the private cloud

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

Run the command asynchronously

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

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IVMwareIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT : Identity Parameter

  • [AddonName <String>]: Name of the addon for the private cloud
  • [AuthorizationName <String>]: Name of the ExpressRoute Circuit Authorization in the private cloud
  • [CloudLinkName <String>]: Name of the cloud link resource
  • [ClusterName <String>]: Name of the cluster in the private cloud
  • [DatastoreName <String>]: Name of the datastore in the private cloud cluster
  • [DhcpId <String>]: NSX DHCP identifier. Generally the same as the DHCP display name
  • [DnsServiceId <String>]: NSX DNS Service identifier. Generally the same as the DNS Service's display name
  • [DnsZoneId <String>]: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name
  • [GatewayId <String>]: NSX Gateway identifier. Generally the same as the Gateway's display name
  • [GlobalReachConnectionName <String>]: Name of the global reach connection in the private cloud
  • [HcxEnterpriseSiteName <String>]: Name of the HCX Enterprise Site in the private cloud
  • [Id <String>]: Resource identity path
  • [Location <String>]: Azure region
  • [PortMirroringId <String>]: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name
  • [PrivateCloudName <String>]: Name of the private cloud
  • [PublicIPId <String>]: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [ScriptCmdletName <String>]: Name of the script cmdlet resource in the script package in the private cloud
  • [ScriptExecutionName <String>]: Name of the user-invoked script execution resource
  • [ScriptPackageName <String>]: Name of the script package in the private cloud
  • [SegmentId <String>]: NSX Segment identifier. Generally the same as the Segment's display name
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [VMGroupId <String>]: NSX VM Group identifier. Generally the same as the VM Group's display name
  • [VirtualMachineId <String>]: Virtual Machine identifier