Instance Failover Groups - Get

Obtém um grupo de failover.

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

Parâmetros de URI

Name In Required Type Description
failoverGroupName
path True
  • string

O nome do grupo de failover.

locationName
path True
  • string

O nome da região em que o recurso está localizado.

resourceGroupName
path True
  • string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio 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 Type Description
200 OK

Recuperou com êxito o grupo de failover especificado.

Other Status Codes

Respostas de erro: ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - O campo parceiros específico no corpo da solicitação do 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 da instância. Verifique se o servidor primário e todos os servidores parceiros determinados são exclusivos.

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

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - há suporte para apenas uma região de parceiro.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - há suporte para apenas um par de instância gerenciada.

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

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

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

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

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - O failover de propriedadeWithDataLossGracePeriodMinutes deve ser fornecido quando a política de failover Automática é 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 a política de failover Manual for selecionada para o ponto de extremidade de leitura-gravação.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - O corpo da solicitação de grupo de failover da 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. Assinatura cruzada para servidores do grupo de failover não é permitida.

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

  • 400 GeoDrInstanceSizeMismatch – a instância gerenciada primária e a instância gerenciada do parceiro não têm o mesmo tamanho de armazenamento.

  • 400 SecurityAdalPrincipalCertExpiredError - A operação não pôde ser concluída porque o certificado de entidade de segurança do Azure Key Vault expirou.

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

  • 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.

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

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri de Key Vault fornecido não é válido.

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

  • 400 AzureKeyVaultMismatchError – região de Key Vault inesperada encontrada na resposta http.

  • 400 AzureKeyVaultRsaKeyNotSupported - O cofre de chaves fornecido usa tamanho de chave RSA sem suporte ou tipo de chave. O tamanho da chave RSA com suporte é 2048 ou 3072 e o Tipo de Chave é RSA ou RSA-HSM.

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

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

  • 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 diferentes regiões para fornecer isolamento.

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

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

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

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

  • 400 TokenTooLong – O token fornecido é muito longo.

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

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

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

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

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

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

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

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

  • 400 AzureKeyVaultMissingPermissions – faltam permissões necessárias para o servidor no Key Vault 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, ele 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 um erro de Azure Active Directory foi encontrado.

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

  • 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque uma entidade de serviço de biblioteca Azure Active Directory não encontrou erro.

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

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

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

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

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

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

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

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

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

  • 409 ConflictingServerOperation – Uma operação está em andamento no momento para o servidor.

  • 409 Assinatura Desabilitada – A assinatura está desabilitada.

  • 409 InstanceFailoverGroupAlreadyExists – 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 GeoReplicationCannotBecomePrimaryDuringUndo – o usuário tentou fazer failover ou forçar o término de um vínculo geográfico enquanto o secundário está em um estado em que ele pode não ser fisicamente consistente e, portanto, não pode entrar na função primária.

  • 409 InstanceFailoverGroupDnsRecordInUse – existe um registro DNS duplicado para o ponto de extremidade solicitado.

  • 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 InvalidFailoverGroupName – Nome do grupo de failover de instância inválido foi fornecido.

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

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

  • 409 AzureKeyVaultKeyInUse – A chave está sendo usada no momento pelo servidor.

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

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - Uma operação de propagação de replicação foi executada em um banco de dados que já 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. Essa é uma solicitação duplicada.

  • 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além das solicitações máximas que podem ser processadas pelos recursos disponíveis.

  • 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas pelos recursos disponíveis.

  • 503 TooManyRequests – Solicitações além das solicitações máximas 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 com o Azure Key Vault falharam

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

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

Exemplos

Get failover group

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test?api-version=2021-02-01-preview

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/failoverGroups",
  "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"
      }
    ]
  }
}

Definições

InstanceFailoverGroup

Um grupo 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 da região do 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 Automático, o failoverWithDataLossGracePeriodMinutes será necessário.

InstanceFailoverGroup

Um grupo de failover de instância.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.managedInstancePairs

Lista de pares de instância gerenciada no grupo de failover.

properties.partnerRegions

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

properties.readOnlyEndpoint

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

properties.readWriteEndpoint

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

properties.replicationRole

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.

type
  • string

Tipo de recurso.

InstanceFailoverGroupReadOnlyEndpoint

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

Name Type Description
failoverPolicy

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 Type Description
failoverPolicy

Política de failover do ponto de extremidade de leitura/gravação para o grupo de failover. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário.

failoverWithDataLossGracePeriodMinutes
  • integer

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 Automático, o failoverWithDataLossGracePeriodMinutes será necessário.

InstanceFailoverGroupReplicationRole

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

Name Type Description
Primary
  • string
Secondary
  • string

ManagedInstancePairInfo

Pares de Instâncias Gerenciadas no grupo de failover.

Name Type Description
partnerManagedInstanceId
  • string

ID do Partner Instância Gerenciada em par.

primaryManagedInstanceId
  • string

ID do primary Instância Gerenciada em par.

PartnerRegionInfo

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

Name Type Description
location
  • string

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

replicationRole

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.

Name Type Description
Disabled
  • string
Enabled
  • string

ReadWriteEndpointFailoverPolicy

Política de failover do ponto de extremidade de leitura/gravação para o grupo de failover. Se failoverPolicy for Automático, o failoverWithDataLossGracePeriodMinutes será necessário.

Name Type Description
Automatic
  • string
Manual
  • string