Skip to content

Latest commit

 

History

History
238 lines (186 loc) · 4.77 KB

New-AzStackHciArcSetting.md

File metadata and controls

238 lines (186 loc) · 4.77 KB
Raw
external help file Module Name online version schema
Az.StackHCI-help.xml
Az.StackHCI
2.0.0

New-AzStackHciArcSetting

SYNOPSIS

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: System.String
Parameter Sets: (All)
Aliases:

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

-ArcApplicationObjectId

Object id of arc AAD identity.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ArcApplicationTenantId

Tenant id of arc AAD identity.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ArcInstanceResourceGroup

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

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ArcServicePrincipalObjectId

Object id of arc AAD service principal.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ClusterName

The name of the cluster.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ConnectivityProperty

contains connectivity related configuration for ARC resources

Type: Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.IAny
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
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: System.String
Parameter Sets: (All)
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20230301.IArcSetting

NOTES

RELATED LINKS