az sf cluster setting
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 --settings-section-description]
Examples
Remove the `MaxFileOperationTimeout` setting from a cluster.
az sf cluster setting remove -g group-name -c cluster1 --section 'NamingService' --parameter 'MaxFileOperationTimeout'
Remove the `MaxFileOperationTimeout` setting from a cluster using settings file.
az sf cluster setting remove -g group-name -c cluster1 --settings-section '@settings-section.json'
Required Parameters
Specify the name of the cluster, if not given it will be same as resource group name.
Specify the resource group name. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Parameter name.
Section name.
JSON encoded parameters configuration. Use @{file} to load from a file. For example: [{"section": "NamingService","parameter": "MaxOperationTimeout"}].
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az sf cluster setting set
Update the settings of a cluster.
az sf cluster setting set --cluster-name
--resource-group
[--parameter]
[--section]
[--settings-section --settings-section-description]
[--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
Set the `MaxFileOperationTimeout` setting for a cluster to 5 seconds using settings file.
az sf cluster setting set -g group-name -c cluster1 --settings-section '@settings-section.json'
Required Parameters
Specify the name of the cluster, if not given it will be same as resource group name.
Specify the resource group name. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Parameter name.
Section name.
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].
Specify the value.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |