az sf managed-cluster

  • Reference

Manage an Azure Service Fabric managed cluster.

Commands

Name Description Type Status
az sf managed-cluster client-certificate

Manage client certificates of a manged cluster.

 Core GA
az sf managed-cluster client-certificate add

Add a new client certificate to the managed cluster.

 Core GA
az sf managed-cluster client-certificate delete

Delete a client certificate from the managed cluster.

 Core GA
az sf managed-cluster create

Delete a managed cluster.

 Core GA
az sf managed-cluster delete

Delete a managed cluster.

 Core GA
az sf managed-cluster list

List managed clusters.

 Core GA
az sf managed-cluster network-security-rule

Network security rule of a manged cluster.

 Core GA
az sf managed-cluster network-security-rule add

Add a network security rule to a manged cluster.

 Core GA
az sf managed-cluster show

Show the properties of an Azure Service Fabric managed cluster.

 Core GA
az sf managed-cluster update

Update a managed cluster.

 Core GA

az sf managed-cluster create

Delete a managed cluster.

az sf managed-cluster create --admin-password
                             --cluster-name
                             --resource-group
                             [--admin-user-name]
                             [--cert-common-name]
                             [--cert-is-admin {false, true}]
                             [--cert-issuer-thumbprint]
                             [--cert-thumbprint]
                             [--client-connection-port]
                             [--cluster-code-version]
                             [--cluster-upgrade-cadence {Wave0, Wave1, Wave2}]
                             [--cluster-upgrade-mode {Automatic, Manual}]
                             [--dns-name]
                             [--gateway-connection-port]
                             [--location]
                             [--sku]
                             [--tags]

Examples

Create cluster with standard sku and client cert by thumbprint.

az sf managed-cluster create -g testRG -c testCluster -l eastus2 --cert-thumbprint XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --cert-is-admin --admin-password PassTest123@ --sku Standard

Create cluster with standard sku and client cert by common name.

az sf managed-cluster create -g testRG -c testCluster -l eastus2 --cert-common-name Contoso.com --cert-issuer-thumbprint XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --cert-is-admin --admin-password PassTest123@ --sku Standard

Required Parameters

--admin-password

Admin password used for the virtual machines.

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

--admin-user-name

Admin user used for the virtual machines.

default value: vmadmin
--cert-common-name --client-cert-common-name

Client certificate common name.

--cert-is-admin --client-cert-is-admin

Client authentication type.

accepted values: false, true
--cert-issuer-thumbprint --cert-issuer-tp --client-cert-issuer-thumbprint

Space-separated list of issuer thumbprints.

--cert-thumbprint --client-cert-thumbprint

Client certificate thumbprint.

--client-connection-port --client-port

Port used for client connections to the cluster.

default value: 19000
--cluster-code-version --code-version

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

--cluster-upgrade-cadence --upgrade-cadence

The upgrade mode of the cluster when new Service Fabric runtime version is available Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters.Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters.Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters.

accepted values: Wave0, Wave1, Wave2
--cluster-upgrade-mode --upgrade-mode

The upgrade mode of the cluster when new Service Fabric runtime version is available Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, upgrade_cadence will determine when the upgrade starts after the new version becomes available.Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the code_version property in the cluster resource.

accepted values: Automatic, Manual
--dns-name

Cluster's dns name.

--gateway-connection-port --gateway-port

Port used for http connections to the cluster.

default value: 19080
--location -l

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

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

default value: Basic
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 managed-cluster delete

Delete a managed cluster.

az sf managed-cluster delete --cluster-name
                             --resource-group

Examples

Delete cluster.

az sf managed-cluster delete -g testRG -c testCluster

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 managed-cluster list

List managed clusters.

az sf managed-cluster list [--resource-group]

Examples

List clusters by resource group.

az sf managed-cluster list -g testRG

List clusters by subscription.

az sf managed-cluster list

Optional Parameters

--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 managed-cluster show

Show the properties of an Azure Service Fabric managed cluster.

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

Examples

Get cluster.

az sf managed-cluster show -g testRG -c testCluster

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 managed-cluster update

Update a managed cluster.

az sf managed-cluster update --cluster-name
                             --resource-group
                             [--client-connection-port]
                             [--dns-name]
                             [--gateway-connection-port]
                             [--tags]

Examples

Update cluster client port and dns name.

az sf managed-cluster update -g testRG -c testCluster --client-port 50000 --dns-name testnewdns

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

--client-connection-port --client-port

Port used for client connections to the cluster.

--dns-name

Cluster's dns name.

--gateway-connection-port --gateway-port

Port used for http connections to the cluster.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.