Share via

az sf cluster setting

  • Reference

Manage a cluster's settings.

Commands

Name Description Type Status
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 setting remove

Remove settings from a cluster.

az sf cluster setting remove --cluster-name
                             --resource-group
                             [--parameter]
                             [--section]
                             [--settings-section]

Examples

Remove the `MaxFileOperationTimeout` setting from a cluster.

az sf cluster setting remove -g group-name -c cluster1 --section 'NamingService' --parameter 'MaxFileOperationTimeout'

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

--parameter

Parameter name.

--section

Section name.

--settings-section --settings-section-description

JSON encoded parameters configuration. Use @{file} to load from a file. For example: [{"section": "NamingService","parameter": "MaxOperationTimeout"}].

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

Update the settings of a cluster.

az sf cluster setting set --cluster-name
                          --resource-group
                          [--parameter]
                          [--section]
                          [--settings-section]
                          [--value]

Examples

Set the `MaxFileOperationTimeout` setting for a cluster to 5 seconds.

az sf cluster setting set -g group-name -c cluster1 --section 'NamingService' --parameter 'MaxFileOperationTimeout' --value 5000

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

--parameter

Parameter name.

--section

Section name.

--settings-section --settings-section-description

JSON encoded parameters configuration. Use @{file} to load from a file. For example: [{"section": "NamingService","parameter": "MaxOperationTimeout","value": 1000},{"section": "MaxFileOperationTimeout","parameter": "Max2","value": 1000].

--value

Specify the value.

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.