Failover Groups - List By Server

Serviço:

SQL Database

Versão da API:

2023-08-01

Lista os grupos de failover em um servidor.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor que contém o grupo de failover.
subscriptionId	path	True	string	A ID da 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

Nome	Tipo	Description
200 OK	FailoverGroupListResult	Recuperou com êxito os grupos de failover.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases – as IDs de bancos de dados fornecidas não são IDs de recurso de banco de dados criadas corretamente. Para obter o exemplo de formatação adequada, consulte https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestInvalidPartner – O campo parceiros especificado no corpo da solicitação de grupo de failover de criação ou atualização está vazio ou inválido. Forneça um valor válido deste campo. Para obter exemplos de solicitações formatadas corretamente, consulte 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 failover. Verifique se o servidor primário e todos os servidores parceiros especificados são exclusivos. 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer – um ou mais dos bancos de dados fornecidos não existem no servidor primário do grupo de failover. Verifique se todos os bancos de dados existem no servidor primário. 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount – há suporte apenas para um servidor parceiro para o Grupo de Failover. Modifique sua solicitação adequadamente. Para obter exemplos de solicitações válidas, consulte https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint – O campo readWriteEndpoint é necessário para solicitações de criação ou atualização. 400 FailoverGroupCreateOrUpdateRequestInvalid – o corpo da solicitação de grupo de failover de criação ou atualização está vazio ou inválido. 400 FailoverGroupUpdateOrDeleteRequestOnSecondary – As modificações no grupo de failover não são permitidas em um servidor secundário. Execute a solicitação no servidor primário. 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues – O valor do período de carência para o ponto de extremidade de leitura-gravação deve ser não negativo. 400 FailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - O valor do período de carência para o grupo de failover deve ser maior ou igual ao período de carência mínimo de '{0}' minutos 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - O failover de propriedadeWithDataLossGracePeriodMinutes deve ser fornecido quando a política de failover Automático é selecionada para o ponto de extremidade de leitura/gravação. 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - O campo failoverPolicy para o ponto de extremidade de leitura/gravação é necessário para solicitações de criação ou atualização. 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy – 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. Remova-o da solicitação. 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified – O corpo da solicitação de grupo de failover de criação ou atualização não deve modificar a propriedade somente leitura '{0}'. 400 FailoverGroupFailoverRequestOnPrimary – A solicitação de failover deve ser iniciada no servidor secundário do grupo de failover. 400 FailoverGroupPartnerServerFromDifferentSubscription – O servidor primário e os servidores parceiros do grupo de failover são de assinaturas diferentes. Não é permitida a assinatura cruzada para servidores do grupo de failover. 400 FailoverGroupCreateOrUpdateRequestInvalidReadOnlyEndpointTargetServer - A propriedade targetServer do ponto de extremidade somente leitura deve ser um servidor válido presente entre os partnerServers configurados para o grupo de failover. 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCountForStandby – somente um servidor parceiro para o Grupo de Failover tem suporte para espera secondaryType. Modifique sua solicitação adequadamente. 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 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 não legível não está em uma região do Azure emparelhada com DR. 400 PartnerServerNotCompatible – O usuário está tentando copiar um banco de dados de um servidor SAWA V1 para um servidor Sterling ou vice-versa. 400 IncorrectReplicationLinkState - A operação espera que o banco de dados esteja em um estado esperado no link de replicação. 400 ResourcePoolNotFound – O pool elástico especificado não existe no servidor lógico especificado. 400 AzureKeyVaultKeyDisabled – A operação não pôde ser concluída no servidor porque a chave do Azure Key Vault está desabilitada. 400 AzureKeyVaultInvalidExpirationDate – A operação não pôde ser concluída porque a data de validade da chave do Azure Key Vault é inválida. 400 SecurityAzureKeyVaultUrlNullOrEmpty - A operação não pôde ser concluída porque o Uri do Azure Key Vault é 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 permissões necessárias no Azure Key Vault. 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 do Azure Active Directory foi encontrado. 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque uma entidade de serviço de biblioteca do Azure Active Directory não encontrou erro. 400 AzureKeyVaultMalformedVaultUri – O uri do Key Vault 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 precisam residir em regiões diferentes para fornecer isolamento. 400 FailoverGroupDoesNotExist – O grupo de failover não existe em um servidor. 400 FailoverGroupNotSecondary – O failover não pode ser iniciado do servidor primário em um Grupo de Failover. 400 InvalidServerName – Nome do servidor inválido especificado. 400 DatabaseInFailoverGroupNotPrimary – O link geoDR para o banco de dados já existe, mas sua função não é 'Primária' ou não é um link de cópia contínua. 400 SecurityAdalPrincipalCertExpiredError – A operação não pôde ser concluída porque o certificado principal do Azure Key Vault expirou. 400 UnableToCreateFailoverGroupDueToTableAuditing – O Grupo de Failover não pode ser criado para o servidor que tem a auditoria de tabela ativada. 400 InvalidIdentifier - O identificador contém NULL ou um caractere unicode inválido. 400 UnableToAddDbWithTableAuditingToFailoverGroup – O banco de dados com a Auditoria de Tabela habilitada não estará acessível por meio do ponto de extremidade do Grupo de Failover. 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri do 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 LimitOfFailoverGroupsPerServerExceeded - A criação de um novo grupo de failover excederá o número permitido de Grupos de Failover por servidor. 400 SameKeyUriNotFoundOnRemoteServer – O servidor secundário não tem o material de chave do mesmo cofre de chaves que o protetor de criptografia do servidor primário com a rotação automática de chave habilitada. 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 SameKeyMaterialNotFoundOnRemoteServer – O servidor secundário não tem o material de 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 GeoReplicaLimitReached – O limite de replicação por réplica foi atingido. 400 FailoverGroupWithVirtualNetworkRulesNotSupported – Atualmente, não há suporte para grupos de failover configurados com uma política de failover automático em servidores configurados com regras de firewall de rede virtual. Configure o grupo de failover com a política de failover manual. 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 SecurityAzureKeyVaultGeoChainError – Não há suporte para a criação do secundário (um processo conhecido como encadeamento) ao habilitar a Transparent Data Encryption usando o Azure Key Vault (BYOK). 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á em andamento para o servidor. 409 SubscriptionDisabled – A assinatura está desabilitada. 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 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 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 slo estava em andamento. 409 AzureKeyVaultKeyNameNotFound – A operação não pôde ser concluída porque o nome da chave do Azure Key Vault não existe. 409 AzureKeyVaultKeyInUse – A chave está sendo usada no momento pelo servidor. 409 FailoverGroupAlreadyExists – O grupo de failover já existe em um determinado servidor. Use o nome do grupo de failover diferente. 409 FailoverGroupBusy – O Grupo de Failover está ocupado com outra operação. 409 DatabaseBelongsToOtherFailoverGroup – O banco de dados pertence a outro Grupo de Failover e não pode ser considerado uma parte deste. 409 DatabaseBeingAddedToFailoverGroup – O banco de dados está sendo adicionado ao Grupo de Failover, o cliente precisa aguardar a conclusão desta operação para remover o problema. 409 DatabaseBeingRemovedFromFailoverGroup – O banco de dados está sendo removido do grupo de failover, o cliente precisa aguardar a conclusão desta operação para emitir adição. 409 FailoverGroupDnsRecordInUse – Existe um registro DNS duplicado para o ponto de extremidade solicitado. 409 InvalidFailoverGroupName – Nome do grupo de failover inválido 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. Essa é uma solicitação duplicada. 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 por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por 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 do Key Vault. 503 DatabaseUnavailable – A operação falhou porque o banco de dados não está disponível. 504 RequestTimeout – A solicitação de serviço excedeu o tempo limite permitido.

Exemplos

List failover group

Solicitação de exemplo

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/FailoverGroupList.json
// this example is just showing the usage of "FailoverGroups_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-primary-server";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this FailoverGroupResource
FailoverGroupCollection collection = sqlServer.GetFailoverGroups();

// invoke the operation and iterate over the result
await foreach (FailoverGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FailoverGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Resposta de exemplo

Código de status:

200

{
  "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",
          "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
        },
        "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",
          "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
        },
        "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

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FailoverGroup	Um grupo de failover.
FailoverGroupDatabasesSecondaryType	Tipo secundário de bancos de dados no servidor parceiro.
FailoverGroupListResult	Uma lista de grupos de failover.
FailoverGroupReadOnlyEndpoint	Ponto de extremidade somente leitura da instância do grupo de failover.
FailoverGroupReadWriteEndpoint	Ponto de extremidade de leitura/gravação da instância do grupo de failover.
FailoverGroupReplicationRole	Função de replicação local da instância do grupo de failover.
PartnerInfo	Informações do servidor 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.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FailoverGroup

Objeto

Um grupo de failover.

Nome	Tipo	Description
id	string	ID do recurso.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.databases	string[] (arm-id)	Lista de bancos de dados no grupo de failover.
properties.partnerServers	PartnerInfo[]	Lista de informações do servidor parceiro para o grupo de failover.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Ponto de extremidade somente leitura da instância do grupo de failover.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Ponto de extremidade de leitura/gravação da instância do grupo de failover.
properties.replicationRole	FailoverGroupReplicationRole	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	FailoverGroupDatabasesSecondaryType	Tipo secundário de bancos de dados no servidor parceiro.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

FailoverGroupDatabasesSecondaryType

Enumeração

Tipo secundário de bancos de dados no servidor parceiro.

Valor	Description
Geo
Standby

FailoverGroupListResult

Objeto

Uma lista de grupos de failover.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	FailoverGroup[]	Matriz de resultados.

FailoverGroupReadOnlyEndpoint

Objeto

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

Nome	Tipo	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Política de failover do ponto de extremidade somente leitura para o grupo de failover.
targetServer	string (arm-id)	O servidor de parceiro de destino para o qual o ponto de extremidade somente leitura aponta.

FailoverGroupReadWriteEndpoint

Objeto

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

Nome	Tipo	Description
failoverPolicy	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.
failoverWithDataLossGracePeriodMinutes	integer (int32)	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.

FailoverGroupReplicationRole

Enumeração

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

Valor	Description
Primary
Secondary

PartnerInfo

Objeto

Informações do servidor parceiro para o grupo de failover.

Nome	Tipo	Description
id	string (arm-id)	Identificador de recurso do servidor parceiro.
location	string	Localização geográfica do servidor parceiro.
replicationRole	FailoverGroupReplicationRole	Função de replicação do servidor parceiro.

ReadOnlyEndpointFailoverPolicy

Enumeração

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

Valor	Description
Disabled
Enabled

ReadWriteEndpointFailoverPolicy

Enumeração

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.

Valor	Description
Manual
Automatic