Register-SCAzStackHCI
The Register-SCAzStackHCI creates a Microsoft.AzureStackHCI cloud resource representing the on-premise cluster and registers the on-premise cluster with Azure.
Syntax
Register-SCAzStackHCI
[-SubscriptionId <String>]
[-Region <String>]
[-ResourceName <String>]
[-Tag <Hashtable>]
[-TenantId <String>]
[-ResourceGroupName <String>]
[-VMHostCluster <HostCluster>]
[-ArmAccessToken <String>]
[-GraphAccessToken <String>]
[-AccountId <String>]
[-EnvironmentName <String>]
[-SkipAzureArcForServers]
[-UseDeviceAuthentication]
[<CommonParameters>] Description
The Register-SCAzStackHCI creates a Microsoft.AzureStackHCI cloud resource representing the on-premise cluster and registers the on-premise cluster with Azure.
Parameters
-AccountID
Specifies the ARM access token. Specifying this along with ArmAccessToken and GraphAccessToken will avoid Azure interactive logon.
| Type: | String |
| Position: | 9 |
| 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: | 7 |
| 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: | 10 |
| 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: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Region
Specifies the Region to create the resource. Default is EastUS.
| Type: | String |
| Position: | 2 |
| Default value: | EastUS |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the Azure Resource Group name. If not specified, <LocalClusterName>-rg will be used as resource group name.
| Type: | String |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceName
Specifies the resource name of the resource created in Azure. If not specified, on-premise cluster name is used.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipAzureArcForServers
Skip registering the cluster nodes with Arc for servers.
| Type: | SwitchParameter |
| Position: | named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionID
Specifies the Azure Subscription to create the resource. This is a mandatory parameter.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
Specifies the resource tags for the resource in Azure in the form of key-value pairs in a hash table. For example: @{key0="value0";key1=$null;key2="value2"}
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TenantId
Specifies the Azure TenantId.
| Type: | String |
| Position: | 5 |
| 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 |
-VMHostCluster
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 |