New-AzStackHciArcSetting

Reference

Module:: Az.StackHCI

Create ArcSetting for HCI cluster.

Syntax

New-AzStackHciArcSetting
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-ArcApplicationClientId <String>]
   [-ArcApplicationObjectId <String>]
   [-ArcApplicationTenantId <String>]
   [-ArcInstanceResourceGroup <String>]
   [-ArcServicePrincipalObjectId <String>]
   [-ConnectivityProperty <IAny>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create ArcSetting for HCI cluster.

Examples

Example 1:

New-AzStackHciArcSetting -ResourceGroupName "test-rg" -ClusterName "myCluster"

Resource Group AggregateState
-------------- --------------
test-rg        Connected

This command creates arcSetting for a HCI cluster. The only arcSetting name allowed is "default" and that is provided by default.

Parameters

-ArcApplicationClientId

App id of arc AAD identity.

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

-ArcApplicationObjectId

Object id of arc AAD identity.

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

-ArcApplicationTenantId

Tenant id of arc AAD identity.

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

-ArcInstanceResourceGroup

The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.

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

-ArcServicePrincipalObjectId

Object id of arc AAD service principal.

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

-ClusterName

The name of the cluster.

Type:	String
Position:	Named
Default value:	None
Required:	True
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

-ConnectivityProperty

contains connectivity related configuration for ARC resources

Type:	IAny
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

-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

-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

-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

Outputs

IArcSetting

Share via