Partilhar via


Instance Failover Groups - List By Location

Lista os grupos de failover em um local.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2023-08-01

Parâmetros do URI

Name Em Necessário Tipo Description
locationName
path True

string

O nome da região onde o recurso está localizado.

resourceGroupName
path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.

subscriptionId
path True

string

A ID de assinatura que identifica uma assinatura do Azure.

api-version
query True

string

A versão da API a ser usada para a solicitação.

Respostas

Name Tipo Description
200 OK

InstanceFailoverGroupListResult

Recuperados com êxito os grupos de failover.

Other Status Codes

ErrorResponse

Respostas de erro: ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - O campo primário fornecido no corpo da solicitação de grupo de failover de instância de criação ou atualização está vazio ou é inválido.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - O campo fornecido partners no corpo da solicitação de grupo de failover de instância de criação ou atualização está vazio ou é inválido.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - Um ou mais dos servidores parceiros fornecidos já fazem parte do grupo de failover de instância. Certifique-se de que o servidor primário e todos os servidores de parceiros fornecidos são exclusivos.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - A região de instância gerenciada pelo parceiro fornecido no corpo da solicitação do grupo de failover da instância está vazia ou é inválida.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Apenas uma região de parceiro é suportada.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - Apenas um par de instâncias gerenciadas é suportado.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - O campo readWriteEndpoint é necessário para criar ou atualizar solicitações.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - O corpo da solicitação de grupo de failover de instância de criação ou atualização está vazio ou é inválido.

  • 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - Não são permitidas modificações no grupo de failover de instância em um servidor secundário. Execute a solicitação no servidor primário.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - O valor do período de carência para o ponto de extremidade de leitura-gravação deve ser não negativo.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - O valor do período de carência para o grupo de failover de instância deve ser maior ou igual ao período de carência mínimo de '{0}' minutos

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - A propriedade failoverWithDataLossGracePeriodMinutes deve ser fornecida quando a política de failover Automatic é selecionada para o ponto de extremidade de leitura-gravação.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - O campo failoverPolicy para o ponto de extremidade de leitura-gravação é necessário para criar ou atualizar solicitações.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - O valor do período de carência não deve ser fornecido quando o Manual da política de failover é selecionado para o ponto de extremidade de leitura-gravação.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - O corpo da solicitação de grupo de failover de instância de criação ou atualização não deve modificar a propriedade somente leitura '{0}'.

  • 400 InstanceFailoverGroupFailoverRequestOnPrimary - A solicitação de failover deve ser iniciada no servidor secundário do grupo de failover de instância.

  • 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - O servidor primário e o servidor parceiro do grupo de failover são de assinaturas diferentes. Não é permitida a inscrição cruzada para servidores do grupo de failover.

  • 400 InvalidAddSecondaryPermission - O usuário não tem permissão suficiente para adicionar secundário no servidor especificado.

  • 400 InvalidSku - O usuário especificou um sku inválido.

  • 400 ServerNotFound - O servidor solicitado não foi encontrado.

  • 400 ServerEditionMismatch - Edition deve ser o mesmo que o servidor primário ao criar um servidor de réplica.

  • 400 FeatureDisabledOnSelectedEdition - O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados.

  • 400 TokenTooLong - O token fornecido é muito longo.

  • 400 InvalidTargetSubregion - O servidor de destino de um secundário ilegível não está em uma região do Azure emparelhada com DR.

  • 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada

  • 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial

  • 400 IncorrectReplicationLinkState - A operação espera que o banco de dados esteja em um estado esperado no link de replicação.

  • 400 CloudLifterFogInaccessibleDbRoleMismatch - Não é possível tornar o {0} de banco de dados na instância gerenciada SQL {1} acessível porque a função de instância no grupo de failover mudou de {2} para {3} enquanto o banco de dados estava no estado inacessível. Restaure a função de banco de dados original executando failover geográfico e tente novamente.

  • 400 CloudLifterGeodrBlocksDbActivate - Não é possível tornar a {0} do banco de dados na instância gerenciada SQL {1} acessível devido à operação geodr em andamento. Aguarde até que a operação conflitante seja concluída e tente novamente.

  • 400 AzureKeyVaultKeyDisabled - A operação não pôde ser concluída no servidor porque a chave do Cofre da Chave do Azure está desabilitada.

  • 400 AzureKeyVaultInvalidExpirationDate - A operação não pôde ser concluída porque a data de expiração da chave do Cofre da Chave do Azure é inválida.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - A operação não pôde ser concluída porque o Uri do Cofre da Chave do Azure é nulo ou vazio.

  • 400 AzureKeyVaultNoServerIdentity - A identidade do servidor não está configurada corretamente.

  • 400 AzureKeyVaultInvalidUri - Uma resposta inválida do Azure Key Vault. Use um URI válido do Azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions - O servidor não tem as permissões necessárias no Cofre da Chave do Azure.

  • 400 SecurityAzureKeyVaultInvalidKeyName - A operação não pôde ser concluída devido a um nome de chave de servidor inválido.

  • 400 PlannedFailoverTimedOutForDatabase - O usuário invocou o failover planejado, atingiu o tempo limite e um banco de dados específico parece ser o culpado.

  • 400 PlannedFailoverTimedOut - O usuário invocou o failover planejado e atingiu o tempo limite ao tentar entrar em contato com o serviço de gerenciamento de parceiros.

  • 400 AdalGenericError - A operação não pôde ser concluída porque foi encontrado um erro do Azure Ative Directory.

  • 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque foi encontrado um erro de Entidade de Serviço não encontrada da biblioteca do Azure Ative Directory.

  • 400 AzureKeyVaultMalformedVaultUri - O uri do Cofre da Chave fornecido não é válido.

  • 400 CannotUseReservedDatabaseName - Não é possível usar o nome do banco de dados reservado nesta operação.

  • 400 InvalidFailoverGroupRegion - Os servidores especificados em um Grupo de Failover de Instância precisam residir em regiões diferentes para fornecer isolamento.

  • 400 InstanceFailoverGroupDoesNotExist - O grupo de failover não existe em um servidor.

  • 400 InstanceFailoverGroupNotSecondary - O failover não pode ser iniciado a partir do servidor primário em um grupo de failover de instância.

  • 400 ManagedInstanceGeoDRNotAllowedForInstancePool - A criação de grupo de failover automático (GeoDR) não é suportada para instâncias gerenciadas provisionadas dentro de pools de instâncias. Os grupos de failover automático só podem ser criados para instâncias gerenciadas autônomas.

  • 400 InvalidServerName - Nome do servidor inválido especificado.

  • 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - O grupo de failover não pode ser criado porque o formato de banco de dados da instância primária não é compatível com o formato de banco de dados da instância secundária. Consulte https://go.microsoft.com/fwlink/?linkid=2251601 para obter mais detalhes.

  • 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - A operação de failover não pode ser executada devido à incompatibilidade de formato de banco de dados entre as instâncias no grupo de failover. Considere atualizar o formato de banco de dados da instância primária ou excluir o grupo de failover para promover a instância secundária atual para uma instância autônoma. Consulte https://go.microsoft.com/fwlink/?linkid=2251601 para obter mais detalhes.

  • 400 SecurityAdalPrincipalCertExpiredError - A operação não pôde ser concluída porque o certificado principal do Cofre de Chaves do Azure expirou.

  • 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - A implantação do grupo de failover não é suportada com a oferta gratuita da Instância Gerenciada SQL do Azure.

  • 400 InvalidIdentifier - O identificador contém NULL ou um caractere unicode inválido.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri do Cofre da Chave fornecido não é válido.

  • 400 ManagedInstanceGeoFailoverCannotBeExecuted - O failover geográfico da instância gerenciada não pode ser executado no momento. Motivo: '{0}'.

  • 400 KeyMaterialNotFoundOnRemoteServer - O servidor remoto não tem acesso ao material de chave usado como um protetor TDE.

  • 400 SameKeyUriNotFoundOnRemoteServer - O servidor secundário não tem o material da chave do mesmo cofre de chaves que o protetor de criptografia do servidor primário com a rotação automática de chaves habilitada.

  • 400 AzureKeyVaultRsaKeyNotSupported - O cofre de chaves fornecido usa o Tamanho da Chave RSA ou o Tipo de Chave não suportados. O tamanho da chave RSA suportada é 2048 ou 3072 e o tipo de chave é RSA ou RSA-HSM.

  • 400 SameKeyMaterialNotFoundOnRemoteServer - O servidor secundário não tem o material da chave do protetor de criptografia do servidor primário.

  • 400 GeoReplicationDatabaseNotSecondary - A operação espera que o banco de dados seja um destino de replicação.

  • 400 ManagedInstanceUpdateSloOngoing - A operação não pôde ser concluída porque uma alteração na camada de serviço está em andamento para a instância gerenciada '{0}.' Aguarde a conclusão da operação em curso e tente novamente.

  • 400 FailoverGroupRegionMismatch - A região de parceiro especificada no Grupo de Failover precisa corresponder à região da instância gerenciada pelo parceiro indicada.

  • 400 DnsZoneMismatch - O DNSZone no servidor parceiro é diferente do DNSZone no servidor de origem. Isso interrompe a funcionalidade InstanceFailoverGroup.

  • 400 GeoDrInstanceSizeMismatch - A instância gerenciada principal e a instância gerenciada pelo parceiro não têm o mesmo tamanho de armazenamento.

  • 400 UnableToResolveRemoteServer - O nome do servidor de parceiro remoto não pôde ser resolvido devido a um nome de servidor inválido ou problemas de conectividade DNS.

  • 400 GeoDrSecondaryInstanceNotEmpty - A instância gerenciada secundária tem bancos de dados de usuários. Para criar um grupo de failover de instância, a instância gerenciada secundária precisa estar vazia.

  • 400 RemoteDatabaseCopyPermission - O usuário não tem permissão suficiente para criar uma cópia de banco de dados no servidor especificado.

  • 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - A configuração de rede está incorreta. O tráfego de replicação do servidor primário não pode alcançar o servidor secundário.

  • 404 ResourceNotFound - O recurso solicitado não foi encontrado.

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

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

  • 404 SourceDatabaseNotFound - O banco de dados de origem não existe.

  • 405 UnsupportedReplicationOperation - Uma operação de replicação sem suporte foi iniciada no banco de dados.

  • 409 ConflictingServerOperation - Uma operação está atualmente em andamento para o servidor.

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

  • 409 ConflictingSystemOperationInProgress - Uma operação de manutenção do sistema está em andamento no banco de dados e outras operações precisam esperar até que sejam concluídas.

  • 409 ManagedInstanceContainsInaccessibleDatabases - A operação não pôde ser concluída porque a instância gerenciada '{0}' contém bancos de dados que estão no estado Inacessível. Remova os bancos de dados inacessíveis ou corrija os problemas com o acesso à chave de proteção TDE gerenciada pelo cliente para a instância gerenciada antes de tentar novamente a operação. https://go.microsoft.com/fwlink/?linkid=2111623

  • 409 ManagedInstanceHasHybridLink - O usuário tentou iniciar uma operação que não é suportada quando a instância gerenciada tem um link híbrido configurado.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo - O usuário tentou fazer failover ou forçar o encerramento de um link geográfico enquanto o secundário está em um estado em que pode não ser fisicamente consistente e, portanto, não pode entrar na função principal.

  • 409 ServerKeyNameAlreadyExists - A chave do servidor já existe no servidor.

  • 409 ServerKeyUriAlreadyExists - O URI da chave do servidor já existe no servidor.

  • 409 ServerKeyDoesNotExists - A chave do servidor não existe.

  • 409 UpdateSloInProgress - O usuário tentou iniciar uma operação incompatível enquanto uma atualização de SLO estava em andamento.

  • 409 AzureKeyVaultKeyNameNotFound - A operação não pôde ser concluída porque o nome da Chave do Cofre da Chave do Azure não existe.

  • 409 AzureKeyVaultKeyInUse - A chave está sendo usada atualmente pelo servidor.

  • 409 InstanceFailoverGroupAlreadyExists - O grupo de failover já existe em um determinado servidor.

  • 409 InstanceFailoverGroupBusy - O grupo de failover de instância está ocupado com outra operação.

  • 409 InstanceFailoverGroupDnsRecordInUse - Existe um registro DNS duplicado para o ponto de extremidade solicitado.

  • 409 InvalidFailoverGroupName - O nome do Grupo de Failover de Instância Inválida foi fornecido.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - Uma operação de replicação foi executada em um banco de dados que não está em uma relação de replicação.

  • 409 InvalidDatabaseStateForOperation - A operação não é permitida no banco de dados em seu estado de replicação atual.

  • 409 DuplicateGeoDrRelation - Os bancos de dados já estão em uma relação de replicação. Trata-se de um pedido duplicado.

  • 409 RemoteDatabaseExists - O nome do banco de dados de destino já existe no servidor de destino.

  • 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

  • 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

  • 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

  • 503 AzureKeyVaultConnectionFailed - A operação não pôde ser concluída no servidor porque as tentativas de conexão ao Cofre de Chaves do Azure falharam

  • 503 AzureKeyVaultGenericConnectionError - A operação não pôde ser concluída porque foi encontrado um erro ao tentar recuperar informações do Cofre da Chave.

  • 504 RequestTimeout - A solicitação de serviço excedeu o tempo limite permitido.

Exemplos

List failover group

Pedido de amostra

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups?api-version=2023-08-01

Resposta da amostra

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test",
      "name": "failover-group-test",
      "type": "Microsoft.Sql/locations/instanceFailoverGroups",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerRegions": [
          {
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "managedInstancePairs": [
          {
            "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
            "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
          }
        ],
        "secondaryType": "Geo"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-1",
      "name": "failover-group-test-1",
      "type": "Microsoft.Sql/locations/instanceFailoverGroups",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerRegions": [
          {
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "managedInstancePairs": [
          {
            "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance-1",
            "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance-1"
          }
        ],
        "secondaryType": "Geo"
      }
    }
  ]
}

Definições

Name Description
ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

InstanceFailoverGroup

Um grupo de failover de instância.

InstanceFailoverGroupListResult

Uma lista de grupos de failover de instância.

InstanceFailoverGroupReadOnlyEndpoint

Ponto de extremidade somente leitura da instância do grupo de failover.

InstanceFailoverGroupReadWriteEndpoint

Ponto de extremidade de leitura-gravação da instância do grupo de failover.

InstanceFailoverGroupReplicationRole

Função de replicação local da instância do grupo de failover.

ManagedInstancePairInfo

Pares de instâncias gerenciadas no grupo de failover.

PartnerRegionInfo

Informações de região de parceiro para o grupo de failover.

ReadOnlyEndpointFailoverPolicy

Política de failover do ponto de extremidade somente leitura para o grupo de failover.

ReadWriteEndpointFailoverPolicy

Política de failover do ponto de extremidade de leitura-gravação para o grupo de failover. Se failoverPolicy for Automatic então failoverWithDataLossGracePeriodMinutes será necessário.

SecondaryInstanceType

Tipo de instância geosecundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR.

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.

InstanceFailoverGroup

Um grupo de failover de instância.

Name Tipo Description
id

string

ID do recurso.

name

string

Nome do recurso.

properties.managedInstancePairs

ManagedInstancePairInfo[]

Lista de pares de instâncias gerenciadas no grupo de failover.

properties.partnerRegions

PartnerRegionInfo[]

Informações de região de parceiro para o grupo de failover.

properties.readOnlyEndpoint

InstanceFailoverGroupReadOnlyEndpoint

Ponto de extremidade somente leitura da instância do grupo de failover.

properties.readWriteEndpoint

InstanceFailoverGroupReadWriteEndpoint

Ponto de extremidade de leitura-gravação da instância do grupo de failover.

properties.replicationRole

InstanceFailoverGroupReplicationRole

Função de replicação local da instância do grupo de failover.

properties.replicationState

string

Estado de replicação da instância do grupo de failover.

properties.secondaryType

SecondaryInstanceType

Tipo de instância geosecundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR.

type

string

Tipo de recurso.

InstanceFailoverGroupListResult

Uma lista de grupos de failover de instância.

Name Tipo Description
nextLink

string

Link para recuperar a próxima página de resultados.

value

InstanceFailoverGroup[]

Matriz de resultados.

InstanceFailoverGroupReadOnlyEndpoint

Ponto de extremidade somente leitura da instância do grupo de failover.

Name Tipo Description
failoverPolicy

ReadOnlyEndpointFailoverPolicy

Política de failover do ponto de extremidade somente leitura para o grupo de failover.

InstanceFailoverGroupReadWriteEndpoint

Ponto de extremidade de leitura-gravação da instância do grupo de failover.

Name Tipo Description
failoverPolicy

ReadWriteEndpointFailoverPolicy

Política de failover do ponto de extremidade de leitura-gravação para o grupo de failover. Se failoverPolicy for Automatic então failoverWithDataLossGracePeriodMinutes será necessário.

failoverWithDataLossGracePeriodMinutes

integer (int32)

O período de carência antes do failover com perda de dados é tentado para o ponto de extremidade de leitura-gravação. Se failoverPolicy for Automatic então failoverWithDataLossGracePeriodMinutes será necessário.

InstanceFailoverGroupReplicationRole

Função de replicação local da instância do grupo de failover.

Valor Description
Primary
Secondary

ManagedInstancePairInfo

Pares de instâncias gerenciadas no grupo de failover.

Name Tipo Description
partnerManagedInstanceId

string

ID da instância gerenciada pelo parceiro em par.

primaryManagedInstanceId

string

Id da Instância Gerenciada Primária em par.

PartnerRegionInfo

Informações de região de parceiro para o grupo de failover.

Name Tipo Description
location

string

Localização geográfica das instâncias gerenciadas pelo parceiro.

replicationRole

InstanceFailoverGroupReplicationRole

Função de replicação das instâncias gerenciadas pelo parceiro.

ReadOnlyEndpointFailoverPolicy

Política de failover do ponto de extremidade somente leitura para o grupo de failover.

Valor Description
Disabled
Enabled

ReadWriteEndpointFailoverPolicy

Política de failover do ponto de extremidade de leitura-gravação para o grupo de failover. Se failoverPolicy for Automatic então failoverWithDataLossGracePeriodMinutes será necessário.

Valor Description
Manual
Automatic

SecondaryInstanceType

Tipo de instância geosecundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR.

Valor Description
Geo
Standby