Failover Groups - List By Server

Listas os grupos de ativação pós-falha num servidor.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups?api-version=2021-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.

serverName
path True

string

O nome do servidor que contém o grupo de ativação pós-falha.

subscriptionId
path True

string

O ID da subscrição que identifica uma subscrição do Azure.

api-version
query True

string

A versão da API a utilizar para o pedido.

Respostas

Name Tipo Description
200 OK

FailoverGroupListResult

Os grupos de ativação pós-falha foram obtidos com êxito.

Other Status Codes

Respostas de Erro: ***

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases – os IDs de bases de dados fornecidos não são IDs de recursos de base de dados devidamente construídos. Para obter o exemplo de formatação adequada, veja https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestInvalidPartner – o campo de parceiros especificado na criação ou atualização do corpo do pedido do grupo de ativação pós-falha está vazio ou é inválido. Forneça um valor válido deste campo. Para obter exemplos de pedidos formatados corretamente, veja https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner – um ou mais dos servidores parceiros fornecidos já fazem parte do grupo de ativação pós-falha. Certifique-se de que o servidor primário e todos os servidores de parceiros especificados são exclusivos.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer – uma ou mais das bases de dados fornecidas não existem no servidor primário do grupo de ativação pós-falha. Certifique-se de que todas as bases de dados existem no servidor primário.

  • 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount – só é suportado um servidor parceiro para o Grupo de Ativação Pós-falha. Modifique o pedido em conformidade. Para obter exemplos de pedidos válidos, veja https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint – o campo readWriteEndpoint é necessário para criar ou atualizar pedidos.

  • 400 FailoverGroupCreateOrUpdateRequestInvalid – o corpo do pedido do grupo de ativação pós-falha de criação ou atualização está vazio ou é inválido.

  • 400 FailoverGroupUpdateOrDeleteRequestOnSecondary – as modificações ao grupo de ativação pós-falha não são permitidas num servidor secundário. Execute o pedido no servidor primário.

  • 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues – o valor do período de tolerância para o ponto final de leitura-escrita tem de ser não negativo.

  • 400 FailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues – o valor do período de tolerância para o grupo de ativação pós-falha tem de ser maior ou igual ao período de tolerância mínimo "{0}" minutos

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields – a ativação pós-falha da propriedadeWithDataLossGracePeriodMinutes tem de ser fornecida quando a política de ativação pós-falha Automática está selecionada para o ponto final de leitura-escrita.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy – o campo failoverPolicy para o ponto final de leitura-escrita é necessário para criar ou atualizar pedidos.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy – o valor do período de tolerância não deve ser fornecido quando a política de ativação pós-falha Manual está selecionada para o ponto final de leitura-escrita. Remova-o do pedido.

  • 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified – o corpo do pedido do grupo de ativação pós-falha de criação ou atualização não deve modificar a propriedade só de leitura "{0}".

  • 400 FailoverGroupFailoverRequestOnPrimary – o pedido de ativação pós-falha deve ser iniciado no servidor secundário do grupo de ativação pós-falha.

  • 400 FailoverGroupPartnerServerFromDifferentSubscription – o servidor primário e os servidores parceiros do grupo de ativação pós-falha são de subscrições diferentes. A subscrição cruzada para servidores do grupo de ativação pós-falha não é permitida.

  • 400 InvalidAddSecondaryPermission – o utilizador não tem permissão suficiente para adicionar um servidor secundário no servidor especificado.

  • 400 InvalidSku - O utilizador especificou um SKU inválido.

  • 400 ServerNotFound – o servidor pedido não foi encontrado.

  • 400 FeatureDisabledOnSelectedEdition – o utilizador tentou utilizar uma funcionalidade que está desativada na edição atual da base de dados.

  • 400 TokenTooLong – o token fornecido é demasiado longo.

  • 400 InvalidTargetSubregion – o servidor de destino de uma secundária não legível não está numa região do Azure emparelhada com DR.

  • 400 PartnerServerNotCompatible – o utilizador está a tentar copiar uma base de dados de um servidor SAWA V1 para um servidor Sterling ou vice-versa.

  • 400 IncorrectReplicationLinkState – a operação espera que a base de dados esteja num estado esperado na ligação de replicação.

  • 400 ResourcePoolNotFound – o conjunto elástico especificado não existe no servidor lógico especificado.

  • 400 AzureKeyVaultKeyDisabled – não foi possível concluir a operação no servidor porque a chave de Key Vault do Azure está desativada.

  • 400 AzureKeyVaultInvalidExpirationDate – não foi possível concluir a operação porque a data de expiração da chave de Key Vault do Azure é inválida.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – não foi possível concluir a operação porque o URI de Key Vault do Azure é nulo ou está vazio.

  • 400 AzureKeyVaultNoServerIdentity – a identidade do servidor não está configurada corretamente.

  • 400 AzureKeyVaultInvalidUri – uma resposta inválida do Azure Key Vault. Utilize um URI de Key Vault do Azure válido.

  • 400 AzureKeyVaultMissingPermissions – o servidor tem as permissões necessárias em falta no Key Vault do Azure.

  • 400 SecurityAzureKeyVaultInvalidKeyName – não foi possível concluir a operação devido a um nome de Chave de Servidor inválido.

  • 400 PlannedFailoverTimedOutForDatabase - O utilizador invocou failover planeado, excedeu o limite de tempo e uma base de dados específica parece ser a culpada.

  • 400 PlannedFailoverTimedOut – o utilizador invocou failover planeado e excedeu o limite de tempo ao tentar contactar o serviço de gestão de parceiros.

  • 400 AdalGenericError – não foi possível concluir a operação porque foi encontrado um erro do Azure Active Directory.

  • 400 AdalServicePrincipalNotFound – não foi possível concluir a operação porque não foi encontrado um erro de Principal de Serviço da biblioteca do Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri – o URI de Key Vault fornecido não é válido.

  • 400 CannotUseReservedDatabaseName – não é possível utilizar o nome da base de dados reservada nesta operação.

  • 400 InvalidFailoverGroupRegion – os servidores especificados num Grupo de Ativação Pós-falha têm de residir em regiões diferentes para fornecer isolamento.

  • 400 FailoverGroupDoesNotExist – o grupo de ativação pós-falha não existe num servidor.

  • 400 FailoverGroupNotSecondary – não é possível iniciar a ativação pós-falha a partir do servidor primário num Grupo de Ativação Pós-falha.

  • 400 InvalidServerName – nome de servidor inválido especificado.

  • 400 DatabaseInFailoverGroupNotPrimary – a ligação GeoDR para a base de dados já existe, mas a sua função não é "Primária" ou não é uma ligação de cópia contínua.

  • 400 SecurityAdalPrincipalCertExpiredError – não foi possível concluir a operação porque o certificado principal do Azure Key Vault expirou.

  • 400 UnableToCreateFailoverGroupDueToTableAuditing – Não é possível criar o Grupo de Ativação Pós-falha para o servidor que tenha a auditoria de tabela ativada.

  • 400 InvalidIdentifier – o identificador contém NULL ou um caráter unicode inválido.

  • 400 UnableToAddDbWithTableAuditingToFailoverGroup - A base de dados com a Auditoria de Tabelas ativada não estará acessível através do ponto final do Grupo de Ativação Pós-falha.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – o URI de Key Vault fornecido não é válido.

  • 400 KeyMaterialNotFoundOnRemoteServer – o servidor remoto não tem acesso a material de chave utilizado como protetor de Encriptação de Dados Transparente.

  • 400 LimitOfFailoverGroupsPerServerExceeded - A criação de um novo Grupo de Ativação Pós-falha excederá o número permitido de Grupos de Ativação Pós-falha por servidor.

  • 400 SameKeyUriNotFoundOnRemoteServer – o servidor secundário não tem o material de chave do mesmo cofre de chaves que o protetor de encriptação do servidor primário com a rotação automática de chaves ativada.

  • 400 AzureKeyVaultRsaKeyNotSupported – o cofre de chaves fornecido utiliza o Tamanho ou Tipo de Chave RSA não suportado. O tamanho da chave RSA suportado é 2048 ou 3072 e o Tipo de Chave é RSA ou RSA-HSM.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – o servidor secundário não tem o material de chave do protetor de encriptação do servidor primário.

  • 400 GeoReplicationDatabaseNotSecondary – a operação espera que a base de dados seja um destino de replicação.

  • 400 GeoReplicaLimitReached – o limite de replicação por réplica foi atingido.

  • 400 FailoverGroupWithVirtualNetworkRulesNotSupported – os Grupos de Ativação Pós-falha configurados com uma política de ativação pós-falha automática não são atualmente suportados em servidores configurados com regras de firewall de rede virtual. Configure o grupo de ativação pós-falha com a política de ativação pós-falha manual.

  • 400 UnableToResolveRemoteServer – não foi possível resolver o nome do servidor do parceiro remoto devido a um nome de servidor ou problemas de conectividade DNS inválidos.

  • 400 RemoteDatabaseCopyPermission – o utilizador não tem permissão suficiente para criar uma cópia de base de dados no servidor especificado.

  • 400 SecurityAzureKeyVaultGeoChainError – a criação de uma secundária secundária (um processo conhecido como encadeamento) não é suportada ao ativar a Encriptação de Dados Transparente com o Azure Key Vault (BYOK).

  • 404 ResourceNotFound – o recurso pedido não foi encontrado.

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados.

  • 404 ServerNotInSubscription - O servidor especificado não existe na subscrição especificada.

  • 404 SourceDatabaseNotFound – a base de dados de origem não existe.

  • 405 UnsupportedReplicationOperation – foi iniciada uma operação de replicação não suportada na base de dados.

  • 409 ConflictingServerOperation – está atualmente em curso uma operação para o servidor.

  • 409 SubscriptionDisabled - A subscrição está desativada.

  • 409 ConflictingSystemOperationInProgress – uma operação de manutenção do sistema está em curso na base de dados e as operações adicionais têm de aguardar até que seja concluída.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo – o utilizador tentou efetuar a ativação pós-falha ou forçar o encerramento de uma ligação geográfica enquanto a secundária se encontra num estado em que pode não ser fisicamente consistente e, por isso, não pode introduzir a função primária.

  • 409 ServerKeyNameAlreadyExists – a chave de servidor já existe no servidor.

  • 409 ServerKeyUriAlreadyExists – o URI da chave de servidor já existe no servidor.

  • 409 ServerKeyDoesNotExists – a chave de servidor não existe.

  • 409 UpdateSloInProgress – o utilizador tentou iniciar uma operação incompatível enquanto uma atualização do SLO estava em curso.

  • 409 AzureKeyVaultKeyNameNotFound – não foi possível concluir a operação porque o nome da Chave de Key Vault do Azure não existe.

  • 409 AzureKeyVaultKeyInUse – a chave está atualmente a ser utilizada pelo servidor.

  • 409 FailoverGroupAlreadyExists – o grupo ativação pós-falha já existe num determinado servidor. Utilize um nome de Grupo de Ativação Pós-falha diferente.

  • 409 FailoverGroupBusy – O Grupo de Ativação Pós-falha está ocupado com outra operação.

  • 409 DatabaseBelongsToOtherFailoverGroup - A base de dados pertence a outro Grupo de Ativação Pós-falha e não pode ser considerada parte deste.

  • 409 DatabaseBeingAddedToFailoverGroup – a base de dados está a ser adicionada ao Grupo de Ativação Pós-falha. O cliente tem de aguardar que esta operação termine para emitir a remoção.

  • 409 DatabaseBeingRemovedFromFailoverGroup – a base de dados está a ser removida do grupo de ativação pós-falha. O cliente tem de aguardar que esta operação termine para emitir o suplemento.

  • 409 FailoverGroupDnsRecordInUse – existe um registo DNS duplicado para o ponto final pedido.

  • 409 InvalidFailoverGroupName – foi fornecido um nome de Grupo de Ativação Pós-falha inválido.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship – foi executada uma operação de propagação de replicação numa base de dados que já se encontra numa relação de replicação.

  • 409 InvalidDatabaseStateForOperation – a operação não é permitida na base de dados no estado de replicação atual.

  • 409 DuplicateGeoDrRelation – as bases de dados já estão numa relação de replicação. Este é um pedido duplicado.

  • 409 RemoteDatabaseExists – o nome da base de dados de destino já existe no servidor de destino.

  • 429 SubscriptionTooManyCreateUpdateRequests – pedidos para além do máximo de pedidos que podem ser processados por recursos disponíveis.

  • 429 SubscriptionTooManyRequests – pedidos para além do máximo de pedidos que podem ser processados por recursos disponíveis.

  • 503 TooManyRequests – pedidos para além do máximo de pedidos que podem ser processados por recursos disponíveis.

  • 503 AzureKeyVaultConnectionFailed – Não foi possível concluir a operação no servidor porque as tentativas de ligação ao Azure Key Vault falharam

  • 503 AzureKeyVaultGenericConnectionError – não foi possível concluir a operação porque foi encontrado um erro ao tentar obter Key Vault informações .

  • 503 DatabaseUnavailable - A operação falhou porque a base de dados não está disponível.

  • 504 RequestTimeout – o pedido de serviço excedeu o tempo limite permitido.

Exemplos

List failover group

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups?api-version=2021-11-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test",
      "name": "failover-group-test",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "location": "Japan East",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "databases": []
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-2",
      "name": "failover-group-test-2",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "location": "Japan East",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "databases": []
      }
    }
  ]
}

Definições

Name Description
FailoverGroup

Um grupo de ativação pós-falha.

FailoverGroupListResult

Uma lista de grupos de ativação pós-falha.

FailoverGroupReadOnlyEndpoint

Ponto final só de leitura da instância do grupo de ativação pós-falha.

FailoverGroupReadWriteEndpoint

Ponto final de leitura/escrita da instância do grupo de ativação pós-falha.

FailoverGroupReplicationRole

Função de replicação local da instância do grupo de ativação pós-falha.

PartnerInfo

Informações do servidor de parceiros para o grupo de ativação pós-falha.

ReadOnlyEndpointFailoverPolicy

Política de ativação pós-falha do ponto final só de leitura para o grupo de ativação pós-falha.

ReadWriteEndpointFailoverPolicy

Política de ativação pós-falha do ponto final de leitura-escrita para o grupo de ativação pós-falha. Se failoverPolicy for Automático, é necessária a ativação pós-falhaWithDataLossGracePeriodMinutes.

FailoverGroup

Um grupo de ativação pós-falha.

Name Tipo Description
id

string

ID do Recurso.

location

string

Localização do recurso.

name

string

Nome do recurso.

properties.databases

string[]

Lista de bases de dados no grupo de ativação pós-falha.

properties.partnerServers

PartnerInfo[]

Lista de informações do servidor de parceiros para o grupo de ativação pós-falha.

properties.readOnlyEndpoint

FailoverGroupReadOnlyEndpoint

Ponto final só de leitura da instância do grupo de ativação pós-falha.

properties.readWriteEndpoint

FailoverGroupReadWriteEndpoint

Ponto final de leitura/escrita da instância do grupo de ativação pós-falha.

properties.replicationRole

FailoverGroupReplicationRole

Função de replicação local da instância do grupo de ativação pós-falha.

properties.replicationState

string

Estado de replicação da instância do grupo de ativação pós-falha.

tags

object

Etiquetas de recursos.

type

string

Tipo de recurso.

FailoverGroupListResult

Uma lista de grupos de ativação pós-falha.

Name Tipo Description
nextLink

string

Ligação para obter a página seguinte dos resultados.

value

FailoverGroup[]

Matriz de resultados.

FailoverGroupReadOnlyEndpoint

Ponto final só de leitura da instância do grupo de ativação pós-falha.

Name Tipo Description
failoverPolicy

ReadOnlyEndpointFailoverPolicy

Política de ativação pós-falha do ponto final só de leitura para o grupo de ativação pós-falha.

FailoverGroupReadWriteEndpoint

Ponto final de leitura/escrita da instância do grupo de ativação pós-falha.

Name Tipo Description
failoverPolicy

ReadWriteEndpointFailoverPolicy

Política de ativação pós-falha do ponto final de leitura-escrita para o grupo de ativação pós-falha. Se failoverPolicy for Automático, é necessária a ativação pós-falhaWithDataLossGracePeriodMinutes.

failoverWithDataLossGracePeriodMinutes

integer

Período de tolerância antes da ativação pós-falha com a perda de dados ser tentada para o ponto final de leitura-escrita. Se failoverPolicy for Automático, é necessária a ativação pós-falhaWithDataLossGracePeriodMinutes.

FailoverGroupReplicationRole

Função de replicação local da instância do grupo de ativação pós-falha.

Name Tipo Description
Primary

string

Secondary

string

PartnerInfo

Informações do servidor de parceiros para o grupo de ativação pós-falha.

Name Tipo Description
id

string

Identificador de recurso do servidor de parceiros.

location

string

Localização geográfica do servidor de parceiros.

replicationRole

FailoverGroupReplicationRole

Função de replicação do servidor de parceiros.

ReadOnlyEndpointFailoverPolicy

Política de ativação pós-falha do ponto final só de leitura para o grupo de ativação pós-falha.

Name Tipo Description
Disabled

string

Enabled

string

ReadWriteEndpointFailoverPolicy

Política de ativação pós-falha do ponto final de leitura-escrita para o grupo de ativação pós-falha. Se failoverPolicy for Automático, é necessária a ativação pós-falhaWithDataLossGracePeriodMinutes.

Name Tipo Description
Automatic

string

Manual

string