az mariadb server

Manage MariaDB servers.

Commands

az mariadb server configuration

Manage configuration values for a server.

az mariadb server configuration list

List the configuration values for a server.

az mariadb server configuration set

Update the configuration of a server.

az mariadb server configuration show

Get the configuration for a server.".

az mariadb server create

Create a server.

az mariadb server delete

Delete a server.

az mariadb server firewall-rule

Manage firewall rules for a server.

az mariadb server firewall-rule create

Create a new firewall rule for a server.

az mariadb server firewall-rule delete

Delete a firewall rule.

az mariadb server firewall-rule list

List all firewall rules for a server.

az mariadb server firewall-rule show

Get the details of a firewall rule.

az mariadb server firewall-rule update

Update a firewall rule.

az mariadb server georestore

Geo-restore a server from backup.

az mariadb server list

List available servers.

az mariadb server list-skus

List available sku's in the given region.

az mariadb server private-endpoint-connection

Manage MariaDB server private endpoint connections.

az mariadb server private-endpoint-connection approve

Approve the specified private endpoint connection associated with a MariaDB server.

az mariadb server private-endpoint-connection delete

Delete the specified private endpoint connection associated with a MariaDB server.

az mariadb server private-endpoint-connection reject

Reject the specified private endpoint connection associated with a MariaDB server.

az mariadb server private-endpoint-connection show

Show details of a private endpoint connection associated with a MariaDB server.

az mariadb server private-link-resource

Manage MariaDB server private link resources.

az mariadb server private-link-resource list

List the private link resources supported for a MariaDB server.

az mariadb server replica

Manage read replicas.

az mariadb server replica create

Create a read replica for a server.

az mariadb server replica list

List all read replicas for a given server.

az mariadb server replica stop

Stop replication to a read replica and make it a read/write server.

az mariadb server restart

Restart a server.

az mariadb server restore

Restore a server from backup.

az mariadb server show

Get the details of a server.

az mariadb server show-connection-string

Show the connection strings for a MariaDB server database.

az mariadb server start

Start a stopped server.

az mariadb server stop

Stop a running server.

az mariadb server update

Update a server.

az mariadb server vnet-rule

Manage a server's virtual network rules.

az mariadb server vnet-rule create

Create a virtual network rule to allows access to a MariaDB server.

az mariadb server vnet-rule delete

Deletes the virtual network rule with the given name.

az mariadb server vnet-rule list

Gets a list of virtual network rules in a server.

az mariadb server vnet-rule show

Gets a virtual network rule.

az mariadb server vnet-rule update

Update a virtual network rule.

az mariadb server wait

Wait for server to satisfy certain conditions.

az mariadb server create

Create a server.

az mariadb server create [--admin-password]
                         [--admin-user]
                         [--assign-identity]
                         [--auto-grow {Disabled, Enabled}]
                         [--backup-retention]
                         [--geo-redundant-backup {Disabled, Enabled}]
                         [--infrastructure-encryption {Disabled, Enabled}]
                         [--location]
                         [--minimal-tls-version {TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled}]
                         [--name]
                         [--public]
                         [--resource-group]
                         [--sku-name]
                         [--ssl-enforcement {Disabled, Enabled}]
                         [--storage-size]
                         [--tags]
                         [--version]

Examples

Create a MariaDB server in North Europe with sku GP_Gen5_2 (General Purpose, Gen 5 hardware, 2 vCores).

az mariadb server create -l northeurope -g testgroup -n testsvr -u username -p password \
    --sku-name GP_Gen5_2

Create a MariaDB server with all paramaters set.

az mariadb server create -l northeurope -g testgroup -n testsvr -u username -p password \
    --sku-name B_Gen5_1 --ssl-enforcement Disabled --public-network-access Disabled \
    --backup-retention 10 --geo-redundant-backup Enabled --storage-size 51200 \
    --tags "key=value" --version 10.2

Optional Parameters

--admin-password -p

The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.

--admin-user -u

Administrator username for the server. Once set, it cannot be changed.

default value: entireruffs1
--assign-identity

Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault.

--auto-grow

Enable or disable autogrow of the storage. Default value is Enabled.

accepted values: Disabled, Enabled
default value: Enabled
--backup-retention

The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.

--geo-redundant-backup

Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.

accepted values: Disabled, Enabled
--infrastructure-encryption -i

Add an optional second layer of encryption for data using new encryption algorithm. Default value is Disabled.

accepted values: Disabled, Enabled
--location -l

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

--minimal-tls-version

Set the minimal TLS version for connections to server when SSL is enabled. Default is TLSEnforcementDisabled.

accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled
--name -n

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

--public --public-network-access

Enable or disable public network access to server. When disabled, only connections made through Private Links can reach this server. Allowed values are : Enabled, Disabled, all, 0.0.0.0, , . Default is Enabled.

--resource-group -g

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

--sku-name

The name of the sku. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.

default value: GP_Gen5_2
--ssl-enforcement

Enable or disable ssl enforcement for connections to server. Default is Enabled.

accepted values: Disabled, Enabled
--storage-size

The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 5120.

default value: 5120
--tags

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

--version

Server major version.

az mariadb server delete

Delete a server.

az mariadb server delete [--ids]
                         [--name]
                         [--resource-group]
                         [--yes]

Examples

Delete a server.

az mariadb server delete -g testgroup -n testsvr

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.

--name -n

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

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

az mariadb server georestore

Geo-restore a server from backup.

az mariadb server georestore --location
                             --source-server
                             [--backup-retention]
                             [--geo-redundant-backup]
                             [--ids]
                             [--name]
                             [--no-wait]
                             [--resource-group]
                             [--sku-name]

Examples

Geo-restore 'testsvr' into a new server 'testsvrnew' located in West US 2.

az mariadb server georestore -g testgroup -n testsvrnew --source-server testsvr -l westus2

Geo-restore 'testsvr' into a new server 'testsvrnew' located in West US 2 with sku GP_Gen5_2.

az mariadb server georestore -g testgroup -n testsvrnew --source-server testsvr -l westus2 --sku-name GP_Gen5_2

Geo-restore 'testsvr2' into a new server 'testsvrnew', where 'testsvrnew' is in a different resource group from 'testsvr2'.

az mariadb server georestore -g testgroup -n testsvrnew \
    -s "/subscriptions/${SubID}/resourceGroups/${ResourceGroup}/providers/Microsoft.DBforMariaDB/servers/testsvr2" \
    -l westus2

Required Parameters

--location -l

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

--source-server -s

The name or ID of the source server to restore from.

Optional Parameters

--backup-retention

The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.

--geo-redundant-backup

Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.

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

--name -n

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

--no-wait

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

--resource-group -g

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

--sku-name

The name of the sku. Defaults to sku of the source server. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.

az mariadb server list

List available servers.

az mariadb server list [--resource-group]

Examples

List all MariaDB servers in a subscription.

az mariadb server list

List all MariaDB servers in a resource group.

az mariadb server list -g testgroup

Optional Parameters

--resource-group -g

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

az mariadb server list-skus

List available sku's in the given region.

az mariadb server list-skus --location

Examples

List available sku's in the given region.

az mariadb server list-skus -l eastus

Required Parameters

--location -l

The name of the location.

az mariadb server restart

Restart a server.

az mariadb server restart [--ids]
                          [--name]
                          [--resource-group]

Examples

Restart a server.

az mariadb server restart -g testgroup -n testsvr

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.

--name -n

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

--resource-group -g

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

az mariadb server restore

Restore a server from backup.

az mariadb server restore --pitr-time
                          --source-server
                          [--ids]
                          [--name]
                          [--no-wait]
                          [--resource-group]

Examples

Restore 'testsvr' to a specific point-in-time as a new server 'testsvrnew'.

az mariadb server restore -g testgroup -n testsvrnew --source-server testsvr --restore-point-in-time "2017-06-15T13:10:00Z"

Restore 'testsvr2' to 'testsvrnew', where 'testsvrnew' is in a different resource group from 'testsvr2'.

az mariadb server restore -g testgroup -n testsvrnew \
    -s "/subscriptions/${SubID}/resourceGroups/${ResourceGroup}/providers/Microsoft.DBforMariaDB/servers/testsvr2" \
    --restore-point-in-time "2017-06-15T13:10:00Z"

Required Parameters

--pitr-time --restore-point-in-time

The point in time in UTC to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+08:00.

--source-server -s

The name or resource ID of the source server to restore from.

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.

--name -n

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

--no-wait

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

--resource-group -g

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

az mariadb server show

Get the details of a server.

az mariadb server show [--ids]
                       [--name]
                       [--resource-group]

Examples

Get the details of a server. (autogenerated)

az mariadb server show --name MyServer --resource-group MyResourceGroup

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.

--name -n

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

--resource-group -g

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

az mariadb server show-connection-string

Show the connection strings for a MariaDB server database.

az mariadb server show-connection-string [--admin-password]
                                         [--admin-user]
                                         [--database-name]
                                         [--ids]
                                         [--server-name]

Examples

Show connection strings for cmd and programming languages.

az mariadb server show-connection-string -s testServer -u username -p password -d databasename

Optional Parameters

--admin-password -p

The login password of the administrator.

default value: {password}
--admin-user -u

The login username of the administrator.

default value: {username}
--database-name -d

The name of a database.

default value: {database}
--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.

--server-name -s

Name of the server.

default value: {server}

az mariadb server start

Start a stopped server.

az mariadb server start [--ids]
                        [--name]
                        [--resource-group]

Examples

Start a stopped server. (autogenerated)

az mariadb server start --name testsvr --resource-group testgroup --subscription MySubscription

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.

--name -n

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

--resource-group -g

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

az mariadb server stop

Stop a running server.

az mariadb server stop [--ids]
                       [--name]
                       [--resource-group]

Examples

Stop a running server. (autogenerated)

az mariadb server stop --name testsvr --resource-group testgroup --subscription MySubscription

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.

--name -n

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

--resource-group -g

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

az mariadb server update

Update a server.

az mariadb server update [--add]
                         [--admin-password]
                         [--assign-identity]
                         [--auto-grow {Disabled, Enabled}]
                         [--backup-retention]
                         [--force-string]
                         [--ids]
                         [--minimal-tls-version {TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled}]
                         [--name]
                         [--public]
                         [--remove]
                         [--resource-group]
                         [--set]
                         [--sku-name]
                         [--ssl-enforcement {Disabled, Enabled}]
                         [--storage-size]
                         [--tags]

Examples

Update a server's sku.

az mariadb server update -g testgroup -n testsvrnew --sku-name GP_Gen5_4

Update a server's tags.

az mariadb server update -g testgroup -n testsvrnew --tags "k1=v1" "k2=v2"

Update a server. (autogenerated)

az mariadb server update --admin-password password --name testsvrnew --resource-group testgroup

Update a server. (autogenerated)

az mariadb server update --name testsvrnew --resource-group testgroup --ssl-enforcement Enabled

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--admin-password -p

The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.

--assign-identity

Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault.

--auto-grow

Enable or disable autogrow of the storage. Default value is Enabled.

accepted values: Disabled, Enabled
--backup-retention

The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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

--minimal-tls-version

Set the minimal TLS version for connections to server when SSL is enabled. Default is TLSEnforcementDisabled.

accepted values: TLS1_0, TLS1_1, TLS1_2, TLSEnforcementDisabled
--name -n

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

--public --public-network-access

Enable or disable public network access to server. When disabled, only connections made through Private Links can reach this server. Allowed values are : Enabled, Disabled, all, 0.0.0.0, , . Default is Enabled.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku-name

The name of the sku. Follows the convention {pricing tier}{compute generation}{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.

--ssl-enforcement

Enable or disable ssl enforcement for connections to server. Default is Enabled.

accepted values: Disabled, Enabled
--storage-size

The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 5120.

--tags

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

az mariadb server wait

Wait for server to satisfy certain conditions.

az mariadb server wait [--custom]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--name]
                       [--resource-group]
                       [--timeout]

Optional Parameters

--custom

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

--exists

Wait until the resource exists.

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

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

--resource-group -g

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

--timeout

Maximum wait in seconds.

default value: 3600