Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az mysql flexible-server parameter

Commands for managing server parameter values for flexible server.

Commands

Name Description Type Status
az mysql flexible-server parameter list

List the parameter values for a flexible server.

 Core GA
az mysql flexible-server parameter set

Update the parameter of a flexible server.

 Core GA
az mysql flexible-server parameter set-batch

Batch update parameters of a flexible server.

 Core GA
az mysql flexible-server parameter show

Get the parameter for a flexible server.".

 Core GA

az mysql flexible-server parameter list

List the parameter values for a flexible server.

az mysql flexible-server parameter list --resource-group
 --server-name
 [--keyword]
 [--page]
 [--page-size]
 [--tags]

Examples

List the parameter values for a flexible server.

az mysql flexible-server parameter list --resource-group testGroup --server-name testserver

List the parameter values for a flexible server in table format.

az mysql flexible-server parameter list --resource-group testGroup --server-name testserver --output table

Required Parameters

--resource-group -g

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

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--keyword

The keyword of the server configuration. Default value is None.

--page

The page of the server configuration. Default value is None.

--page-size

The pageSize of the server configuration. Default value is None.

--tags

The tags of the server configuration. Default value is None.

az mysql flexible-server parameter set

Update the parameter of a flexible server.

az mysql flexible-server parameter set [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--resource-group]
 [--server-name]
 [--source]
 [--subscription]
 [--value]

Examples

Set a new parameter value.

az mysql flexible-server parameter set --resource-group testGroup --server-name testserver --name parameterName --value parameterValue

Set a parameter value to its default.

az mysql flexible-server parameter set --resource-group testGroup --server-name testserver --name parameterName

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the server configuration.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Property Value
Parameter group: Resource Id Arguments
--source

Source of the configuration.

--subscription

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

Property Value
Parameter group: Resource Id Arguments
--value -v

Value of the configuration.

az mysql flexible-server parameter set-batch

Batch update parameters of a flexible server.

az mysql flexible-server parameter set-batch --args
 [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--resource-group]
 [--server-name]
 [--source]
 [--subscription]

Examples

Batch set parameters.

az mysql flexible-server parameter set-batch --resource-group testGroup --server-name testserver --source "user-override" --args key1="value1" key2="value2"

Required Parameters

--args

List of the configuration key-value pair.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Property Value
Parameter group: Resource Id Arguments
--source

Source of the configuration.

--subscription

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

Property Value
Parameter group: Resource Id Arguments

az mysql flexible-server parameter show

Get the parameter for a flexible server.".

az mysql flexible-server parameter show [--ids]
 [--name]
 [--resource-group]
 [--server-name]
 [--subscription]

Examples

Get the parameter for a server.

az mysql flexible-server parameter show --resource-group testGroup --server-name testserver --name parameterName

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the server configuration.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?