Unregister-SCAzStackHCI
Unregister-AzStackHCI deletes the Microsoft.AzureStackHCI cloud resource representing the on-premise cluster and unregisters the on-premise cluster with Azure. The registered information available on the cluster is used to unregister the cluster if no parameters are passed.
Syntax
Unregister-SCAzStackHCI
[-SubscriptionId <String>]
[-ResourceName <String>]
[-TenantId <String>]
[-ResourceGroupName <String>]
[-VMHostCluster <HostCluster>]
[-ArmAccessToken <String>]
[-GraphAccessToken <String>]
[-AccountId <String>]
[-EnvironmentName <String>]
[-UseDeviceAuthentication]
[<CommonParameters>]
Description
The Unregister-AzStackHCI deletes the Microsoft.AzureStackHCI cloud resource representing the on-premise cluster and unregisters the on-premise cluster with Azure. The registered information available on the cluster is used to unregister the cluster if no parameters are passed.
Parameters
-AccountID
Specifies the ARM access token. Specifying this along with ArmAccessToken and GraphAccessToken will avoid Azure interactive logon.
Type: | String |
Position: | 6 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ArmAccesstoken
Specifies the ARM access token. Specifying this along with GraphAccessToken and AccountId will avoid Azure interactive logon.
Type: | String |
Position: | 5 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnvironmentName
Specifies the Azure Environment. Default is AzureCloud. Valid values are AzureCloud, AzureChinaCloud, AzureUSGovernment, AzureGermanCloud, and AzurePPE.
Type: | String |
Position: | 8 |
Default value: | $AzureCloud |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GraphAccessToken
Specifies the Graph access token. Specifying this along with ArmAccessToken and AccountId will avoid Azure interactive logon.
Type: | String |
Position: | 6 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the Azure Resource Group name.
Type: | String |
Position: | 4 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceName
Specifies the Azure resource.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionID
Specifies the Azure Subscription.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TenantId
Specifies the Azure TenantId.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UseDeviceAuthentication
Use device code authentication instead of an interactive browser prompt.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMHostCluter
Specifies the VMM Host Cluster object for the Azure Stack HCI cluster. Cluster object can be retrieved using Get-SCVMHostCluster command. This is a Mandatory parameter
Type: | HostCluster |
Position: | named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |