New-AzStackHciCluster

  • Reference
Module:
Az.StackHCI

Create an HCI cluster.

Syntax

New-AzStackHciCluster
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AadApplicationObjectId <String>]
   [-AadClientId <String>]
   [-AadServicePrincipalObjectId <String>]
   [-AadTenantId <String>]
   [-CloudManagementEndpoint <String>]
   [-DesiredPropertyDiagnosticLevel <DiagnosticLevel>]
   [-DesiredPropertyWindowsServerSubscription <WindowsServerSubscription>]
   [-IdentityType <ManagedServiceIdentityType>]
   [-IdentityUserAssignedIdentity <Hashtable>]
   [-SoftwareAssurancePropertySoftwareAssuranceIntent <SoftwareAssuranceIntent>]
   [-Tag <Hashtable>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create an HCI cluster.

Examples

Example 1:

New-AzStackHciCluster -Name "myCluster" -ResourceGroupName "test-rg" -AadTenantId "00001111-aaaa-2222-bbbb-3333cccc4444" -AadClientId "24a6e53d-04e5-44d2-b7cc-1b732a847dfc" -Location "eastus"

Location Name      ResourceGroupName
-------- ----      -----------------
eastus   myCluster test-rg

This command creates a Stack HCI cluster

Example 2:

New-AzStackHciCluster -Name "myCluster2" -ResourceGroupName "test-rg" -AadTenantId "00001111-aaaa-2222-bbbb-3333cccc4444" -AadClientId "24a6e53d-04e5-44d2-b7cc-1b732a847dfc" -Location "westeurope" -DesiredPropertyDiagnosticLevel "Off" -DesiredPropertyWindowsServerSubscription "Enabled"

Location    Name      Resource Group
--------    ----      -----------------
westeurope  myCluster test-rg

This command creates a Stack HCI cluster with DiagnosticLevel = "Off" and WindowsServerSubscription = "Enabled". By default, these values are set to "Basic" and "Disabled" respectively.

Parameters

-AadApplicationObjectId

Object id of cluster AAD identity.

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

-AadClientId

App id of cluster AAD identity.

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

-AadServicePrincipalObjectId

Id of cluster identity service principal.

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

-AadTenantId

Tenant id of cluster AAD identity.

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

-CloudManagementEndpoint

Endpoint configured for management from the Azure portal.

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

-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

-DesiredPropertyDiagnosticLevel

Desired level of diagnostic data emitted by the cluster.

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

-DesiredPropertyWindowsServerSubscription

Desired state of Windows Server Subscription.

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

-IdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

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

-IdentityUserAssignedIdentity

The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

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

-Location

The geo-location where the resource lives

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

-Name

The name of the cluster.

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

-SoftwareAssurancePropertySoftwareAssuranceIntent

Customer Intent for Software Assurance Benefit.

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

-Tag

Resource tags.

Type:Hashtable
Position:Named
Default value:None
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

ICluster