Share via

az mysql server ad-admin

  • Reference

Manage a MySQL server's Active Directory administrator.

Commands

Name Description Type Status
az mysql server ad-admin create

Create an Active Directory administrator for MySQL server.

 Core GA
az mysql server ad-admin delete

Delete an Active Directory Administrator for MySQL server.

 Core GA
az mysql server ad-admin list

List all Active Directory Administrators for MySQL server.

 Core GA
az mysql server ad-admin show

Get Active Directory Administrator information for a MySQL server.

 Core GA
az mysql server ad-admin wait

Place the CLI in a waiting state until a condition of the MySQL server Active Directory Administrator is met.

 Core GA

az mysql server ad-admin create

Edit

Create an Active Directory administrator for MySQL server.

az mysql server ad-admin create --resource-group
                                --server-name
                                [--display-name]
                                [--no-wait]
                                [--object-id]

Examples

Create Active Directory Administrator [email protected] in the server testsvr.

az mysql server ad-admin create --server-name testsvr -g testgroup --display-name [email protected] --object-id 1FCD6583-267B-4484-BF9B-507E4B62DE79

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

--display-name -u

Display name of the Azure AD administrator user or group.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--object-id -i

The unique ID of the Azure AD administrator.

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 mysql server ad-admin delete

Edit

Delete an Active Directory Administrator for MySQL server.

az mysql server ad-admin delete [--ids]
                                [--resource-group]
                                [--server-name]
                                [--subscription]
                                [--yes]

Examples

Delete Active Directory Administrator in the server testsvr.

az mysql server ad-admin delete --server-name testsvr -g testgroup

Optional Parameters

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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 mysql server ad-admin list

Edit

List all Active Directory Administrators for MySQL server.

az mysql server ad-admin list [--ids]
                              [--resource-group]
                              [--server-name]
                              [--subscription]

Examples

List all Active Directory Administrators in the server testsvr.

az mysql server ad-admin list --server-name testsvr -g testgroup

Optional Parameters

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

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

--subscription

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

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 mysql server ad-admin show

Edit

Get Active Directory Administrator information for a MySQL server.

az mysql server ad-admin show [--ids]
                              [--resource-group]
                              [--server-name]
                              [--subscription]

Examples

Get Active Directory Administrator in the server testsvr.

az mysql server ad-admin show --server-name testsvr -g testgroup

Optional Parameters

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

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

--subscription

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

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 mysql server ad-admin wait

Edit

Place the CLI in a waiting state until a condition of the MySQL server Active Directory Administrator is met.

az mysql server ad-admin wait [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--resource-group]
                              [--server-name]
                              [--subscription]
                              [--timeout]
                              [--updated]

Examples

Place the CLI in a waiting state until a creation of Active Directory Administrator in server testsvr.

az mysql server ad-admin wait --server-name testsvr -g testgroup --created

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--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.

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.