Skip to main content

replicas

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

Overview

Namereplicas
TypeResource
Idazure.mysql.replicas

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
identityobjectThe cmk identity for the server.
locationstringThe geo-location where the resource lives
propertiesobjectProperties of the server.
skuobjectThe SKU (pricing tier) of the server.
tagsobjectResource tags.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_by_serverselectsubscriptionId, resourceGroupName, serverNameList all the replicas for a given 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.

NameDatatypeDescription
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
serverNamestringThe name of the server.
subscriptionIdstring (uuid)The ID of the target subscription. The value must be an UUID.

SELECT examples

List all the replicas for a given server.

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