Replicas - List By Server

Serviço:

MySQL

Versão da API:

2024-06-01-preview

Liste todas as réplicas de um determinado servidor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas?api-version=2024-06-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor. Padrão Regex: ^[a-z0-9][-a-z0-9]*(?<!-)$
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	ServerListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

List replicas for a server

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/replicas?api-version=2024-06-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# 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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

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


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-06-01-preview/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

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "administratorLogin": "cloudsa",
        "storage": {
          "storageSizeGB": 20,
          "iops": 360,
          "autoGrow": "Enabled",
          "storageSku": "Premium_LRS"
        },
        "version": "5.7",
        "state": "Ready",
        "fullyQualifiedDomainName": "mysqltestserver-repl.orcabrci-seas1-a.mscds.com",
        "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
        "availabilityZone": "1",
        "maintenancePolicy": {
          "patchStrategy": "Regular"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Replica",
        "replicaCapacity": 0,
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-06-24T08:19:18.00+00:00"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "location": "Southeast Asia",
      "tags": {
        "num": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl",
      "name": "mysqltestserver-repl",
      "type": "Microsoft.DBforMySQL/flexibleServers"
    },
    {
      "sku": {
        "name": "Standard_D2ds_v4",
        "tier": "GeneralPurpose"
      },
      "properties": {
        "administratorLogin": "cloudsa",
        "storage": {
          "storageSizeGB": 20,
          "iops": 360,
          "autoGrow": "Enabled",
          "storageSku": "Premium_LRS"
        },
        "version": "5.7",
        "state": "Ready",
        "fullyQualifiedDomainName": "mysqltestserver-repl2.orcabrci-seas1-a.mscds.com",
        "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
        "availabilityZone": "1",
        "maintenancePolicy": {
          "patchStrategy": "Default"
        },
        "maintenanceWindow": {
          "customWindow": "Disabled",
          "dayOfWeek": 0,
          "startHour": 0,
          "startMinute": 0
        },
        "replicationRole": "Replica",
        "replicaCapacity": 0,
        "network": {
          "publicNetworkAccess": "Enabled"
        },
        "backup": {
          "backupRetentionDays": 7,
          "geoRedundantBackup": "Disabled",
          "earliestRestoreDate": "2021-06-23T08:19:18.00+00:00"
        },
        "highAvailability": {
          "mode": "Disabled",
          "state": "NotEnabled"
        }
      },
      "location": "Southeast Asia",
      "tags": {
        "num": "1"
      },
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl2",
      "name": "mysqltestserver-repl",
      "type": "Microsoft.DBforMySQL/flexibleServers"
    }
  ]
}

Definições

Name	Description
Backup	Propriedades do perfil de armazenamento de um servidor
createdByType	O tipo de identidade que criou o recurso.
CreateMode	O modo para criar um novo servidor MySQL.
DataEncryption	A criptografia de data para cmk.
DataEncryptionType	O tipo de chave, AzureKeyVault para habilitar cmk, SystemManaged para desabilitar cmk.
EnableStatusEnum	Enum para indicar se o valor é 'Enabled' ou 'Disabled'
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HighAvailability	Propriedades de alta disponibilidade de um servidor
HighAvailabilityMode	Modo de alta disponibilidade para um servidor.
HighAvailabilityState	O estado de alta disponibilidade do servidor.
ImportSourceProperties	Importe propriedades relacionadas à fonte.
ImportSourceStorageType	Tipo de armazenamento da fonte de importação.
MaintenancePolicy	Política de manutenção de um servidor.
MaintenanceWindow	Janela de manutenção de um servidor.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
MySQLServerSku	Informações de faturamento relacionadas às propriedades de um servidor.
Network	Propriedades relacionadas à rede de um servidor
PatchStrategy	Enum para indicar a estratégia de patch de um servidor
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
ReplicationRole	A função de replicação.
Server	Representa um servidor.
ServerListResult	Uma lista de servidores.
ServerSkuTier	O nível do SKU específico, por exemplo, GeneralPurpose.
ServerState	O estado de um servidor.
ServerVersion	A versão de um servidor.
Storage	Propriedades do perfil de armazenamento de um servidor
StorageRedundancyEnum	Enum para indicar se o valor de sku de armazenamento é 'ZoneRedundancy' ou 'LocalRedundancy'
systemData	Metadados referentes à criação e última modificação do recurso.

Backup

Propriedades do perfil de armazenamento de um servidor

Name	Tipo	Default value	Description
backupIntervalHours	integer		Horas de intervalo de backup para o servidor.
backupRetentionDays	integer		Dias de retenção de backup para o servidor.
earliestRestoreDate	string		Tempo de criação do ponto de restauração mais antigo (formato ISO8601)
geoRedundantBackup	EnableStatusEnum	Disabled	Se o backup com redundância geográfica está habilitado ou não.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

O modo para criar um novo servidor MySQL.

Name	Tipo	Description
Default	string
GeoRestore	string
PointInTimeRestore	string
Replica	string

DataEncryption

A criptografia de data para cmk.

Name	Tipo	Description
geoBackupKeyURI	string	Uri de chave de backup geográfico como cofre de chaves não pode cruzar região, precisa de cmk na mesma região que o backup geográfico
geoBackupUserAssignedIdentityId	string	ID do recurso de identidade do usuário do backup geográfico, pois a identidade não pode cruzar a região, precisa de identidade na mesma região que o backup geográfico
primaryKeyURI	string	Uri de chave primária
primaryUserAssignedIdentityId	string	ID do recurso de identidade do usuário principal
type	DataEncryptionType	O tipo de chave, AzureKeyVault para habilitar cmk, SystemManaged para desabilitar cmk.

DataEncryptionType

O tipo de chave, AzureKeyVault para habilitar cmk, SystemManaged para desabilitar cmk.

Name	Tipo	Description
AzureKeyVault	string
SystemManaged	string

EnableStatusEnum

Enum para indicar se o valor é 'Enabled' ou 'Disabled'

Name	Tipo	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

HighAvailability

Propriedades de alta disponibilidade de um servidor

Name	Tipo	Description
mode	HighAvailabilityMode	Modo de alta disponibilidade para um servidor.
standbyAvailabilityZone	string	Zona de disponibilidade do servidor em espera.
state	HighAvailabilityState	O estado de alta disponibilidade do servidor.

HighAvailabilityMode

Modo de alta disponibilidade para um servidor.

Name	Tipo	Description
Disabled	string
SameZone	string
ZoneRedundant	string

HighAvailabilityState

O estado de alta disponibilidade do servidor.

Name	Tipo	Description
CreatingStandby	string
FailingOver	string
Healthy	string
NotEnabled	string
RemovingStandby	string

ImportSourceProperties

Importe propriedades relacionadas à fonte.

Name	Tipo	Description
dataDirPath	string	Caminho relativo do diretório de dados no armazenamento.
sasToken	string	Token Sas para acessar o armazenamento de origem. As permissões de leitura e lista são necessárias para o token sas.
storageType	ImportSourceStorageType	Tipo de armazenamento da fonte de importação.
storageUrl	string	Uri do armazenamento de origem de importação.

ImportSourceStorageType

Tipo de armazenamento da fonte de importação.

Name	Tipo	Description
AzureBlob	string

MaintenancePolicy

Política de manutenção de um servidor.

Name	Tipo	Description
patchStrategy	PatchStrategy	A estratégia de patch deste servidor

MaintenanceWindow

Janela de manutenção de um servidor.

Name	Tipo	Description
customWindow	string	Indica se a janela personalizada está habilitada ou desabilitada
dayOfWeek	integer	dia da semana para janela de manutenção
startHour	integer	hora de início para a janela de manutenção
startMinute	integer	Minuto de início para a janela de manutenção

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado.

Name	Tipo	Description
UserAssigned	string

MySQLServerSku

Informações de faturamento relacionadas às propriedades de um servidor.

Name	Tipo	Description
name	string	O nome do sku, por exemplo, Standard_D32s_v3.
tier	ServerSkuTier	O nível do SKU específico, por exemplo, GeneralPurpose.

Network

Propriedades relacionadas à rede de um servidor

Name	Tipo	Description
delegatedSubnetResourceId	string	ID de recurso de sub-rede delegada usada para configurar vnet para um servidor.
privateDnsZoneResourceId	string	ID do recurso da zona DNS privada.
publicNetworkAccess	EnableStatusEnum	Se o acesso à rede pública é permitido ou não para este servidor. O valor é 'Desativado' quando o servidor tem integração VNet.

PatchStrategy

Enum para indicar a estratégia de patch de um servidor

Name	Tipo	Description
Regular	string
VirtualCanary	string

PrivateEndpoint

O recurso de ponto de extremidade privado.

Name	Tipo	Description
id	string	O identificador ARM para o ponto de extremidade privado.

PrivateEndpointConnection

O recurso de conexão de ponto de extremidade privado.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.groupIds	string[]	As ids de grupo para o recurso de ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

O status da conexão de ponto de extremidade privado.

Name	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

Name	Tipo	Description
actionsRequired	string	Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

ReplicationRole

A função de replicação.

Name	Tipo	Description
None	string
Replica	string
Source	string

Server

Representa um servidor.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity.principalId	string	ObjectId do KeyVault
identity.tenantId	string	TenantId do KeyVault
identity.type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
identity.userAssignedIdentities	object	Metadados da identidade atribuída pelo utilizador.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.administratorLogin	string	O nome de login do administrador de um servidor. Só pode ser especificado quando o servidor está sendo criado (e é necessário para a criação).
properties.administratorLoginPassword	string	A senha do login do administrador (necessária para a criação do servidor).
properties.availabilityZone	string	disponibilidade Informações da zona do servidor.
properties.backup	Backup	Propriedades relacionadas ao backup de um servidor.
properties.createMode	CreateMode	O modo para criar um novo servidor MySQL.
properties.dataEncryption	DataEncryption	A criptografia de dados para CMK.
properties.databasePort	integer	A porta do banco de dados do servidor. Só pode ser especificado quando o servidor está sendo criado.
properties.fullyQualifiedDomainName	string	O nome de domínio totalmente qualificado de um servidor.
properties.highAvailability	HighAvailability	Propriedades relacionadas à alta disponibilidade de um servidor.
properties.importSourceProperties	ImportSourceProperties	Propriedades de origem para importação do armazenamento.
properties.maintenancePolicy	MaintenancePolicy	Política de manutenção de um servidor.
properties.maintenanceWindow	MaintenanceWindow	Janela de manutenção de um servidor. Problema conhecido: não pode ser definido durante a criação do servidor ou atualizado com outras propriedades durante a atualização do servidor; deve ser atualizado separadamente.
properties.network	Network	Propriedades relacionadas à rede de um servidor.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Propriedades relacionadas a PrivateEndpointConnections de um servidor.
properties.replicaCapacity	integer	O número máximo de réplicas que um servidor primário pode ter.
properties.replicationRole	ReplicationRole	A função de replicação.
properties.restorePointInTime	string	Tempo de criação do ponto de restauração (formato ISO8601), especificando o tempo a partir do qual restaurar.
properties.sourceServerResourceId	string	O ID do servidor MySQL de origem.
properties.state	ServerState	O estado de um servidor.
properties.storage	Storage	Propriedades relacionadas ao armazenamento de um servidor.
properties.version	ServerVersion	Versão do servidor.
sku	MySQLServerSku	O SKU (nível de preço) do servidor.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ServerListResult

Uma lista de servidores.

Name	Tipo	Description
nextLink	string	O link usado para obter a próxima página de operações.
value	Server[]	A lista de servidores

ServerSkuTier

O nível do SKU específico, por exemplo, GeneralPurpose.

Name	Tipo	Description
Burstable	string
GeneralPurpose	string
MemoryOptimized	string

ServerState

O estado de um servidor.

Name	Tipo	Description
Disabled	string
Dropping	string
Ready	string
Starting	string
Stopped	string
Stopping	string
Updating	string

ServerVersion

A versão de um servidor.

Name	Tipo	Description
5.7	string
8.0.21	string

Storage

Propriedades do perfil de armazenamento de um servidor

Name	Tipo	Default value	Description
autoGrow	EnableStatusEnum	Disabled	Habilite o crescimento automático do armazenamento ou não.
autoIoScaling	EnableStatusEnum	Enabled	Habilite o Auto Scaling de E/S ou não.
iops	integer		IOPS de armazenamento para um servidor.
logOnDisk	EnableStatusEnum	Disabled	Habilite o disco de logon ou não.
storageRedundancy	StorageRedundancyEnum	LocalRedundancy	O tipo redundante do armazenamento do servidor. O parâmetro é usado para a criação do servidor.
storageSizeGB	integer		Tamanho máximo de armazenamento permitido para um servidor.
storageSku	string		O nome da sku do armazenamento do servidor.

StorageRedundancyEnum

Enum para indicar se o valor de sku de armazenamento é 'ZoneRedundancy' ou 'LocalRedundancy'

Name	Tipo	Description
LocalRedundancy	string
ZoneRedundancy	string

systemData

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.