az sf cluster

Reference

Manage an Azure Service Fabric cluster.

Commands

Name	Description	Type	Status
az sf cluster client-certificate	Manage the client certificate of a cluster.	Core	GA
az sf cluster client-certificate add	Add a common name or certificate thumbprint to the cluster for client authentication.	Core	GA
az sf cluster client-certificate remove	Remove client certificates or subject names used for authentication.	Core	GA
az sf cluster create	Create a new Azure Service Fabric cluster.	Core	GA
az sf cluster durability	Manage the durability of a cluster.	Core	GA
az sf cluster durability update	Update the durability tier or VM SKU of a node type in the cluster.	Core	GA
az sf cluster list	List cluster resources.	Core	GA
az sf cluster node	Manage the node instance of a cluster.	Core	GA
az sf cluster node-type	Manage the node-type of a cluster.	Core	GA
az sf cluster node-type add	Add a new node type to a cluster.	Core	GA
az sf cluster node add	Add nodes to a node type in a cluster.	Core	GA
az sf cluster node remove	Remove nodes from a node type in a cluster.	Core	GA
az sf cluster reliability	Manage the reliability of a cluster.	Core	GA
az sf cluster reliability update	Update the reliability tier for the primary node in a cluster.	Core	GA
az sf cluster setting	Manage a cluster's settings.	Core	GA
az sf cluster setting remove	Remove settings from a cluster.	Core	GA
az sf cluster setting set	Update the settings of a cluster.	Core	GA
az sf cluster show	Gets a Service Fabric cluster resource.	Core	GA
az sf cluster upgrade-type	Manage the upgrade type of a cluster.	Core	GA
az sf cluster upgrade-type set	Change the upgrade type for a cluster.	Core	GA

az sf cluster create

Create a new Azure Service Fabric cluster.

az sf cluster create --resource-group
                     [--cert-out-folder]
                     [--cert-subject-name]
                     [--certificate-file]
                     [--certificate-password]
                     [--cluster-name]
                     [--cluster-size]
                     [--location]
                     [--os {UbuntuServer1604, WindowsServer1709, WindowsServer1709withContainers, WindowsServer1803withContainers, WindowsServer1809withContainers, WindowsServer2012R2Datacenter, WindowsServer2016Datacenter, WindowsServer2016DatacenterwithContainers, WindowsServer2019Datacenter, WindowsServer2019DatacenterwithContainers}]
                     [--parameter-file]
                     [--secret-identifier]
                     [--template-file]
                     [--vault-name]
                     [--vault-rg]
                     [--vm-password]
                     [--vm-sku]
                     [--vm-user-name]

Examples

Create a cluster with a given size and self-signed certificate that is downloaded locally.

az sf cluster create -g group-name -c cluster1 -l westus --cluster-size 4 --vm-password Password#1234 --certificate-output-folder MyCertificates --certificate-subject-name cluster1

Use a keyvault certificate and custom template to deploy a cluster.

az sf cluster create -g group-name -c cluster1 -l westus --template-file template.json \
    --parameter-file parameter.json --secret-identifier https://{KeyVault}.vault.azure.net:443/secrets/{MyCertificate}

Required Parameters

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--cert-out-folder --certificate-output-folder

The folder of the new certificate file to be created.

--cert-subject-name --certificate-subject-name

The subject name of the certificate to be created.

--certificate-file

The existing certificate file path for the primary cluster certificate.

--certificate-password

The password of the certificate file.

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--cluster-size -s

The number of nodes in the cluster. Default are 5 nodes.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--os --vm-os

The Operating System of the VMs that make up the cluster.

accepted values: UbuntuServer1604, WindowsServer1709, WindowsServer1709withContainers, WindowsServer1803withContainers, WindowsServer1809withContainers, WindowsServer2012R2Datacenter, WindowsServer2016Datacenter, WindowsServer2016DatacenterwithContainers, WindowsServer2019Datacenter, WindowsServer2019DatacenterwithContainers

default value: WindowsServer2016Datacenter

--parameter-file

The path to the template parameter file.

--secret-identifier

The existing Azure key vault secret URL.

--template-file

The path to the template file.

--vault-name

Azure key vault name, it not given it will be the cluster resource group name.

--vault-rg

Key vault resource group name, if not given it will be cluster resource group name.

--vm-password

The password of the Vm.

--vm-sku

VM Sku.

--vm-user-name

The user name for logging to Vm. Default will be adminuser.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf cluster list

List cluster resources.

az sf cluster list [--resource-group]

Optional Parameters

--resource-group -g

The resource group name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf cluster show

Gets a Service Fabric cluster resource.

Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.

az sf cluster show --cluster-name
                   --resource-group

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sf cluster

Commands

az sf cluster create

Examples

Required Parameters

Optional Parameters

az sf cluster list

Optional Parameters

az sf cluster show

Required Parameters

Feedback

Additional resources