servers

Creates, updates, deletes, gets or lists a servers resource.

Overview

Name	servers
Type	Resource
Id	azure.mysql.servers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	The cmk identity for the server.
location	string	The geo-location where the resource lives
properties	object	Properties of the server.
sku	object	The SKU (pricing tier) of the server.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	The cmk identity for the server.
location	string	The geo-location where the resource lives
properties	object	Properties of the server.
sku	object	The SKU (pricing tier) of the server.
tags	object	Resource tags.

list

Name	Datatype	Description
identity	object	The cmk identity for the server.
location	string	The geo-location where the resource lives
properties	object	Properties of the server.
sku	object	The SKU (pricing tier) of the server.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName		Gets information about a server.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the servers in a given resource group.
list	select	subscriptionId		List all the servers in a given subscription.
create	insert	subscriptionId, resourceGroupName, serverName		Creates a new server or updates an existing server. The update action will overwrite the existing server.
update	update	subscriptionId, resourceGroupName, serverName		Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
delete	delete	subscriptionId, resourceGroupName, serverName		Deletes a server.
failover	exec	subscriptionId, resourceGroupName, serverName		Manual failover a server.
validate_estimate_high_availability	exec	subscriptionId, resourceGroupName, serverName		Validate a deployment of high availability.
restart	exec	subscriptionId, resourceGroupName, serverName		Restarts a server.
start	exec	subscriptionId, resourceGroupName, serverName		Starts a server.
stop	exec	subscriptionId, resourceGroupName, serverName		Stops a server.
reset_gtid	exec	subscriptionId, resourceGroupName, serverName		Resets GTID on a server.
detach_v_net	exec	subscriptionId, resourceGroupName, serverName		Detach VNet on a server.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about a server.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.mysql.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

list_by_resource_group

List all the servers in a given resource group.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.mysql.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

List all the servers in a given subscription.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.mysql.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new server or updates an existing server. The update action will overwrite the existing server.

INSERT INTO azure.mysql.servers (
data__identity,
data__sku,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
serverName
)
SELECT 
'{{ identity }}',
'{{ sku }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: servers
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the servers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the servers resource.
    - name: serverName
      value: string
      description: Required parameter for the servers resource.
    - name: identity
      value: object
      description: |
        The cmk identity for the server.
    - name: sku
      value: object
      description: |
        The SKU (pricing tier) of the server.
    - name: properties
      value: object
      description: |
        Properties of the server.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

UPDATE azure.mysql.servers
SET 
data__identity = '{{ identity }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
RETURNING
identity,
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes a server.

DELETE FROM azure.mysql.servers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
;

Lifecycle Methods

failover

Manual failover a server.

EXEC azure.mysql.servers.failover 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required
;

validate_estimate_high_availability

Validate a deployment of high availability.

EXEC azure.mysql.servers.validate_estimate_high_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required 
@@json=
'{
"expectedStandbyAvailabilityZone": "{{ expectedStandbyAvailabilityZone }}"
}'
;

restart

Restarts a server.

EXEC azure.mysql.servers.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required 
@@json=
'{
"restartWithFailover": "{{ restartWithFailover }}", 
"maxFailoverSeconds": {{ maxFailoverSeconds }}
}'
;

start

Starts a server.

EXEC azure.mysql.servers.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required
;

stop

Stops a server.

EXEC azure.mysql.servers.stop 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required
;

reset_gtid

Resets GTID on a server.

EXEC azure.mysql.servers.reset_gtid 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required 
@@json=
'{
"gtidSet": "{{ gtidSet }}"
}'
;

detach_v_net

Detach VNet on a server.

EXEC azure.mysql.servers.detach_v_net 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required 
@@json=
'{
"publicNetworkAccess": "{{ publicNetworkAccess }}"
}'
;