Instance Failover Groups - List By Location

Serviço:: SQL Database

Versão da API:: 2025-01-01

Lista os grupos de failover num local.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2025-01-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 minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	InstanceFailoverGroupListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active 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 failover group

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
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	A resposta de uma operação de lista InstanceFailoverGroup.
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.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

Object

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 alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

InstanceFailoverGroup

Object

Um grupo de failover de instância.

Name	Tipo	Description
id	string (arm-id)	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.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.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

InstanceFailoverGroupListResult

Object

A resposta de uma operação de lista InstanceFailoverGroup.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	InstanceFailoverGroup[]	Os itens do InstanceFailoverGroup nesta página

InstanceFailoverGroupReadOnlyEndpoint

Object

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

Object

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

Enumeração

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

Valor	Description
Primary	Primário
Secondary	Secundária

ManagedInstancePairInfo

Object

Pares de instâncias gerenciadas no grupo de failover.

Name	Tipo	Description
partnerManagedInstanceId	string	Id do Partner Managed Instance em par.
primaryManagedInstanceId	string	Id do Primary Managed Instance em par.

PartnerRegionInfo

Object

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

Enumeração

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

Valor	Description
Disabled	Disabled
Enabled	Ativado

ReadWriteEndpointFailoverPolicy

Enumeração

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	Manual
Automatic	Automático

SecondaryInstanceType

Enumeração

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

Valor	Description
Geo	Geografia
Standby	Standby

systemData

Object

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

Name	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.