Edit

Share via

New-AzServiceFabricManagedCluster

  • Reference
Module:
Az.ServiceFabric

Create new managed cluster.

Syntax

New-AzServiceFabricManagedCluster
   [-ResourceGroupName] <String>
   [-Name] <String>
   -Location <String>
   [-UpgradeMode <ClusterUpgradeMode>]
   [-CodeVersion <String>]
   [-UpgradeCadence <PSClusterUpgradeCadence>]
   [-ClientCertIsAdmin]
   -ClientCertThumbprint <String>
   -AdminPassword <SecureString>
   [-AdminUserName <String>]
   [-HttpGatewayConnectionPort <Int32>]
   [-ClientConnectionPort <Int32>]
   [-DnsName <String>]
   [-Sku <ManagedClusterSku>]
   [-UseTestExtension]
   [-ZonalResiliency]
   [-AsJob]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzServiceFabricManagedCluster
   [-ResourceGroupName] <String>
   [-Name] <String>
   -Location <String>
   [-UpgradeMode <ClusterUpgradeMode>]
   [-CodeVersion <String>]
   [-UpgradeCadence <PSClusterUpgradeCadence>]
   [-ClientCertIsAdmin]
   -ClientCertCommonName <String>
   [-ClientCertIssuerThumbprint <String[]>]
   -AdminPassword <SecureString>
   [-AdminUserName <String>]
   [-HttpGatewayConnectionPort <Int32>]
   [-ClientConnectionPort <Int32>]
   [-DnsName <String>]
   [-Sku <ManagedClusterSku>]
   [-UseTestExtension]
   [-ZonalResiliency]
   [-AsJob]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet will create a managed cluster resource without node types. To bootstrap the cluster A primary node type needs to be added use New-AzServiceFabricManagedNodeType.

Examples

Example 1

$rgName = "testRG"
$clusterName = "testCluster"
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
$tags = @{"test"="tag"}

New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -AdminPassword $password -Tag $tags -Verbose

This command creates a cluster resource with default basic sku.

Example 2

$rgName = "testRG"
$clusterName = "testCluster"
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -ClientCertThumbprint XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -ClientCertIsAdmin -AdminPassword $password -Sku Standard -Verbose

This command creates a cluster resource in centraluseuap with an initial admin client certificate and standard sku.

Example 3

$rgName = "testRG"
$clusterName = "testCluster"
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -AdminPassword $password -Sku Standard -UpgradeMode Automatic -UpgradeCadence Wave1 -ZonalResiliency -Verbose

This command creates a cluster with upgrade cadence in wave1 and zonal resiliency enabled.

Example 4

$rgName = "testRG"
$clusterName = "testCluster"
$password = ConvertTo-SecureString -String "****" -AsPlainText -Force
New-AzServiceFabricManagedCluster -ResourceGroupName $rgName -Location centraluseuap -ClusterName $clusterName -AdminPassword $password -Sku Standard -UpgradeMode Manual -CodeVersion 7.2.477.9590 -Verbose

This command creates a cluster with manual upgrade mode and 7.2.477.9590 code version.

Parameters

-AdminPassword

Admin password used for the virtual machines.

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

-AdminUserName

Admin password used for the virtual machines. Default: vmadmin.

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

-AsJob

Run cmdlet in the background and return a Job to track progress.

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

-ClientCertCommonName

Client certificate common name.

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

-ClientCertIsAdmin

Use to specify if the client certificate has administrator level.

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

-ClientCertIssuerThumbprint

List of Issuer thumbprints for the client certificate. Only use in combination with ClientCertCommonName.

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

-ClientCertThumbprint

Client certificate thumbprint.

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

-ClientConnectionPort

Port used for client connections to the cluster. Default: 19000.

Type:Int32
Position:Named
Default value:19000
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CodeVersion

Cluster service fabric code version. Only use if upgrade mode is Manual.

Type:String
Aliases:ClusterCodeVersion
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 credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DnsName

Cluster's dns name.

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

-HttpGatewayConnectionPort

Port used for http connections to the cluster. Default: 19080.

Type:Int32
Position:Named
Default value:19080
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

The resource location

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

-Name

Specify the name of the cluster.

Type:String
Aliases:ClusterName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specify the name of the resource group.

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

-Sku

Cluster's Sku, the options are Basic: it will have a minimum of 3 seed nodes and only allows 1 node type and Standard: it will have a minimum of 5 seed nodes and allows multiple node types.

Type:ManagedClusterSku
Accepted values:Basic, Standard
Position:Named
Default value:Basic
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Specify the tags as key/value pairs.

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

-UpgradeCadence

Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0.

Type:PSClusterUpgradeCadence
Aliases:ClusterUpgradeCadence
Accepted values:Wave0, Wave1, Wave2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UpgradeMode

Cluster service fabric code version upgrade mode. Automatic or Manual.

Type:ClusterUpgradeMode
Aliases:ClusterUpgradeMode
Accepted values:Automatic, Manual
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseTestExtension

If Specify The cluster will be crated with service test vmss extension.

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

-ZonalResiliency

Indicates if the cluster has zone resiliency.

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

Inputs

String

Outputs

PSManagedCluster