az sf cluster

Manage an Azure Service Fabric cluster.

Commands

az sf cluster certificate

Manage a cluster certificate.

az sf cluster certificate add

Add a secondary cluster certificate to the cluster.

az sf cluster certificate remove

Remove a certificate from a cluster.

az sf cluster client-certificate

Manage the client certificate of a cluster.

az sf cluster client-certificate add

Add a common name or certificate thumbprint to the cluster for client authentication.

az sf cluster client-certificate remove

Remove client certificates or subject names used for authentication.

az sf cluster create

Create a new Azure Service Fabric cluster.

az sf cluster durability

Manage the durability of a cluster.

az sf cluster durability update

Update the durability tier or VM SKU of a node type in the cluster.

az sf cluster list

List cluster resources.

az sf cluster node

Manage the node instance of a cluster.

az sf cluster node add

Add nodes to a node type in a cluster.

az sf cluster node remove

Remove nodes from a node type in a cluster.

az sf cluster node-type

Manage the node-type of a cluster.

az sf cluster node-type add

Add a new node type to a cluster.

az sf cluster reliability

Manage the reliability of a cluster.

az sf cluster reliability update

Update the reliability tier for the primary node in a cluster.

az sf cluster setting

Manage a cluster's settings.

az sf cluster setting remove

Remove settings from a cluster.

az sf cluster setting set

Update the settings of a cluster.

az sf cluster show

Gets a Service Fabric cluster resource.

az sf cluster upgrade-type

Manage the upgrade type of a cluster.

az sf cluster upgrade-type set

Change the upgrade type for a cluster.

az sf cluster create

Create a new Azure Service Fabric cluster.

az sf cluster create --location
                     --resource-group
                     [--cert-out-folder]
                     [--cert-subject-name]
                     [--certificate-file]
                     [--certificate-password]
                     [--cluster-name]
                     [--cluster-size]
                     [--os {UbuntuServer1604, WindowsServer1709, WindowsServer1709withContainers, WindowsServer1803withContainers, WindowsServer1809withContainers, WindowsServer2012R2Datacenter, WindowsServer2016Datacenter, WindowsServer2016DatacenterwithContainers, WindowsServer2019Datacenter, WindowsServer2019DatacenterwithContainers}]
                     [--parameter-file]
                     [--secret-identifier]
                     [--subscription]
                     [--template-file]
                     [--vault-name]
                     [--vault-resource-group]
                     [--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

--location -l

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

--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.

--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.

--subscription

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

--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-resource-group

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.

az sf cluster list

List cluster resources.

az sf cluster list [--query-examples]
                   [--resource-group]
                   [--subscription]

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

The resource group name.

--subscription

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

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
                   [--query-examples]
                   [--subscription]

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>.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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