Replicas - List By Server

Reference

Service:: MariaDB

API Version:: 2018-06-01

List all the replicas for a given server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ServerListResult	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ReplicasListByServer

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster/replicas?api-version=2018-06-01


/**
 * Samples for Replicas ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ReplicasListByServer.
     * json
     */
    /**
     * Sample code: ReplicasListByServer.
     * 
     * @param manager Entry point to MariaDBManager.
     */
    public static void replicasListByServer(com.azure.resourcemanager.mariadb.MariaDBManager manager) {
        manager.replicas().listByServer("TestGroup", "testmaster", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mariadb import MariaDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python replicas_list_by_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MariaDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.replicas.list_by_server(
        resource_group_name="TestGroup",
        server_name="testmaster",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ReplicasListByServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmariadb_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mariadb/armmariadb"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ReplicasListByServer.json
func ExampleReplicasClient_NewListByServerPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmariadb.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReplicasClient().NewListByServerPager("TestGroup", "testmaster", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServerListResult = armmariadb.ServerListResult{
		// 	Value: []*armmariadb.Server{
		// 		{
		// 			Name: to.Ptr("testserver"),
		// 			Type: to.Ptr("Microsoft.DBforMariaDB/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testserver"),
		// 			Location: to.Ptr("northeurope"),
		// 			Tags: map[string]*string{
		// 				"elasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armmariadb.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-11T23:56:54.300Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver.mariadb.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armmariadb.SSLEnforcementEnumEnabled),
		// 				StorageProfile: &armmariadb.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](35),
		// 					GeoRedundantBackup: to.Ptr(armmariadb.GeoRedundantBackupEnabled),
		// 					StorageMB: to.Ptr[int32](256000),
		// 				},
		// 				UserVisibleState: to.Ptr(armmariadb.ServerStateReady),
		// 				Version: to.Ptr(armmariadb.ServerVersionTen2),
		// 			},
		// 			SKU: &armmariadb.SKU{
		// 				Name: to.Ptr("GP_Gen4_2"),
		// 				Capacity: to.Ptr[int32](2),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armmariadb.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testserver1"),
		// 			Type: to.Ptr("Microsoft.DBforMariaDB/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testserver1"),
		// 			Location: to.Ptr("northeurope"),
		// 			Tags: map[string]*string{
		// 				"elasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armmariadb.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-11T23:56:54.300Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver1.mariadb.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armmariadb.SSLEnforcementEnumEnabled),
		// 				StorageProfile: &armmariadb.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](35),
		// 					GeoRedundantBackup: to.Ptr(armmariadb.GeoRedundantBackupEnabled),
		// 					StorageMB: to.Ptr[int32](256000),
		// 				},
		// 				UserVisibleState: to.Ptr(armmariadb.ServerStateReady),
		// 				Version: to.Ptr(armmariadb.ServerVersionTen2),
		// 			},
		// 			SKU: &armmariadb.SKU{
		// 				Name: to.Ptr("GP_Gen4_2"),
		// 				Capacity: to.Ptr[int32](2),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armmariadb.SKUTierGeneralPurpose),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testserver2"),
		// 			Type: to.Ptr("Microsoft.DBforMariaDB/servers"),
		// 			ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testserver2"),
		// 			Location: to.Ptr("northeurope"),
		// 			Tags: map[string]*string{
		// 				"elasticServer": to.Ptr("1"),
		// 			},
		// 			Properties: &armmariadb.ServerProperties{
		// 				AdministratorLogin: to.Ptr("cloudsa"),
		// 				EarliestRestoreDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-11T23:56:54.300Z"); return t}()),
		// 				FullyQualifiedDomainName: to.Ptr("testserver2.mariadb.database.azure.com"),
		// 				MasterServerID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster"),
		// 				ReplicaCapacity: to.Ptr[int32](0),
		// 				ReplicationRole: to.Ptr("Replica"),
		// 				SSLEnforcement: to.Ptr(armmariadb.SSLEnforcementEnumEnabled),
		// 				StorageProfile: &armmariadb.StorageProfile{
		// 					BackupRetentionDays: to.Ptr[int32](35),
		// 					GeoRedundantBackup: to.Ptr(armmariadb.GeoRedundantBackupEnabled),
		// 					StorageMB: to.Ptr[int32](256000),
		// 				},
		// 				UserVisibleState: to.Ptr(armmariadb.ServerStateReady),
		// 				Version: to.Ptr(armmariadb.ServerVersionTen2),
		// 			},
		// 			SKU: &armmariadb.SKU{
		// 				Name: to.Ptr("GP_Gen4_2"),
		// 				Capacity: to.Ptr[int32](2),
		// 				Family: to.Ptr("Gen4"),
		// 				Tier: to.Ptr(armmariadb.SKUTierGeneralPurpose),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MariaDBManagementClient } = require("@azure/arm-mariadb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all the replicas for a given server.
 *
 * @summary List all the replicas for a given server.
 * x-ms-original-file: specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/ReplicasListByServer.json
 */
async function replicasListByServer() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = "TestGroup";
  const serverName = "testmaster";
  const credential = new DefaultAzureCredential();
  const client = new MariaDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.replicas.listByServer(resourceGroupName, serverName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

replicasListByServer().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testserver",
      "name": "testserver",
      "type": "Microsoft.DBforMariaDB/servers",
      "location": "northeurope",
      "tags": {
        "elasticServer": "1"
      },
      "sku": {
        "name": "GP_Gen4_2",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 2
      },
      "properties": {
        "storageProfile": {
          "storageMB": 256000,
          "backupRetentionDays": 35,
          "geoRedundantBackup": "Enabled"
        },
        "administratorLogin": "cloudsa",
        "sslEnforcement": "Enabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver.mariadb.database.azure.com",
        "version": "10.2",
        "earliestRestoreDate": "2018-06-11T23:56:54.3+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster",
        "replicaCapacity": 0
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testserver1",
      "name": "testserver1",
      "type": "Microsoft.DBforMariaDB/servers",
      "location": "northeurope",
      "tags": {
        "elasticServer": "1"
      },
      "sku": {
        "name": "GP_Gen4_2",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 2
      },
      "properties": {
        "storageProfile": {
          "storageMB": 256000,
          "backupRetentionDays": 35,
          "geoRedundantBackup": "Enabled"
        },
        "administratorLogin": "cloudsa",
        "sslEnforcement": "Enabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver1.mariadb.database.azure.com",
        "version": "10.2",
        "earliestRestoreDate": "2018-06-11T23:56:54.3+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster",
        "replicaCapacity": 0
      }
    },
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testserver2",
      "name": "testserver2",
      "type": "Microsoft.DBforMariaDB/servers",
      "location": "northeurope",
      "tags": {
        "elasticServer": "1"
      },
      "sku": {
        "name": "GP_Gen4_2",
        "tier": "GeneralPurpose",
        "family": "Gen4",
        "capacity": 2
      },
      "properties": {
        "storageProfile": {
          "storageMB": 256000,
          "backupRetentionDays": 35,
          "geoRedundantBackup": "Enabled"
        },
        "administratorLogin": "cloudsa",
        "sslEnforcement": "Enabled",
        "userVisibleState": "Ready",
        "fullyQualifiedDomainName": "testserver2.mariadb.database.azure.com",
        "version": "10.2",
        "earliestRestoreDate": "2018-06-11T23:56:54.3+00:00",
        "replicationRole": "Replica",
        "masterServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/testmaster",
        "replicaCapacity": 0
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the Batch service.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
GeoRedundantBackup	Enable Geo-redundant or not for server backup.
MinimalTlsVersionEnum	Enforce a minimal Tls version for the server.
PrivateEndpointProperty
PrivateEndpointProvisioningState	State of the private endpoint connection.
PrivateLinkServiceConnectionStateActionsRequire	The actions required for private link service connection.
PrivateLinkServiceConnectionStateStatus	The private link service connection status.
PublicNetworkAccessEnum	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
Server	Represents a server.
ServerListResult	A list of servers.
ServerPrivateEndpointConnection	A private endpoint connection under a server
ServerPrivateEndpointConnectionProperties	Properties of a private endpoint connection.
ServerPrivateLinkServiceConnectionStateProperty
ServerState	A state of a server that is visible to user.
ServerVersion	The version of a server.
Sku	Billing information related properties of a server.
SkuTier	The tier of the particular SKU, e.g. Basic.
SslEnforcementEnum	Enable ssl enforcement or not when connect to server.
StorageAutogrow	Enable Storage Auto Grow.
StorageProfile	Storage Profile properties of a server

CloudError

An error response from the Batch service.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

Name	Type	Description
Disabled	string
Enabled	string

MinimalTlsVersionEnum

Enforce a minimal Tls version for the server.

Name	Type	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string
TLSEnforcementDisabled	string

PrivateEndpointProperty

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateEndpointProvisioningState

State of the private endpoint connection.

Name	Type	Description
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.

Name	Type	Description
None	string

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccessEnum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

Name	Type	Description
Disabled	string
Enabled	string

Server

Represents a server.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.administratorLogin	string	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
properties.earliestRestoreDate	string	Earliest restore point creation time (ISO8601 format)
properties.fullyQualifiedDomainName	string	The fully qualified domain name of a server.
properties.masterServerId	string	The master server id of a replica server.
properties.minimalTlsVersion	MinimalTlsVersionEnum	Enforce a minimal Tls version for the server.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	List of private endpoint connections on a server
properties.publicNetworkAccess	PublicNetworkAccessEnum	Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.replicaCapacity	integer	The maximum number of replicas that a master server can have.
properties.replicationRole	string	The replication role of the server.
properties.sslEnforcement	SslEnforcementEnum	Enable ssl enforcement or not when connect to server.
properties.storageProfile	StorageProfile	Storage profile of a server.
properties.userVisibleState	ServerState	A state of a server that is visible to user.
properties.version	ServerVersion	Server version.
sku	Sku	The SKU (pricing tier) of the server.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ServerListResult

A list of servers.

Name	Type	Description
value	Server[]	The list of servers

ServerPrivateEndpointConnection

A private endpoint connection under a server

Name	Type	Description
id	string	Resource Id of the private endpoint connection.
properties	ServerPrivateEndpointConnectionProperties	Private endpoint connection properties

ServerPrivateEndpointConnectionProperties

Properties of a private endpoint connection.

Name	Type	Description
privateEndpoint	PrivateEndpointProperty	Private endpoint which the connection belongs to.
privateLinkServiceConnectionState	ServerPrivateLinkServiceConnectionStateProperty	Connection state of the private endpoint connection.
provisioningState	PrivateEndpointProvisioningState	State of the private endpoint connection.

ServerPrivateLinkServiceConnectionStateProperty

Name	Type	Description
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	The actions required for private link service connection.
description	string	The private link service connection description.
status	PrivateLinkServiceConnectionStateStatus	The private link service connection status.

ServerState

A state of a server that is visible to user.

Name	Type	Description
Disabled	string
Dropping	string
Ready	string

ServerVersion

The version of a server.

Name	Type	Description
10.2	string
10.3	string

Sku

Billing information related properties of a server.

Name	Type	Description
capacity	integer	The scale up/out capacity, representing server's compute units.
family	string	The family of hardware.
name	string	The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
size	string	The size code, to be interpreted by resource as appropriate.
tier	SkuTier	The tier of the particular SKU, e.g. Basic.

SkuTier

The tier of the particular SKU, e.g. Basic.

Name	Type	Description
Basic	string
GeneralPurpose	string
MemoryOptimized	string

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

Name	Type	Description
Disabled	string
Enabled	string

StorageAutogrow

Enable Storage Auto Grow.

Name	Type	Description
Disabled	string
Enabled	string

StorageProfile

Storage Profile properties of a server

Name	Type	Description
backupRetentionDays	integer	Backup retention days for the server.
geoRedundantBackup	GeoRedundantBackup	Enable Geo-redundant or not for server backup.
storageAutogrow	StorageAutogrow	Enable Storage Auto Grow.
storageMB	integer	Max storage allowed for a server.

Share via

Replicas - List By Server

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ReplicasListByServer

Sample request

Sample response

Definitions

CloudError

ErrorAdditionalInfo

ErrorResponse

GeoRedundantBackup

MinimalTlsVersionEnum

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateStatus

PublicNetworkAccessEnum

Server

ServerListResult

ServerPrivateEndpointConnection

ServerPrivateEndpointConnectionProperties

ServerPrivateLinkServiceConnectionStateProperty

ServerState

ServerVersion

Sku

SkuTier

SslEnforcementEnum

StorageAutogrow

StorageProfile

Additional resources