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 de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
location
|
path | True |
string |
O nome da região em que o recurso está localizado. |
|
resource
|
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. |
|
subscription
|
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 |
Recuperou com êxito os grupos de failover. |
|
| Other Status Codes |
Respostas de erro: ***
|
Exemplos
List failover group
Solicitação de exemplo
Resposta de exemplo
{
"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
| Nome | Description |
|---|---|
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Instance |
Um grupo de failover de instância. |
|
Instance |
Uma lista de grupos de failover de instância. |
|
Instance |
Ponto de extremidade somente leitura da instância do grupo de failover. |
|
Instance |
Ponto de extremidade de leitura/gravação da instância do grupo de failover. |
|
Instance |
Função de replicação local da instância do grupo de failover. |
|
Managed |
Pares de Instâncias Gerenciadas no grupo de failover. |
|
Partner |
Informações da região do parceiro para o grupo de failover. |
|
Read |
Política de failover do ponto de extremidade somente leitura para o grupo de failover. |
|
Read |
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. |
|
Secondary |
Tipo da instância geo-secundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR. |
ErrorAdditionalInfo
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
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
InstanceFailoverGroup
Um grupo de failover de instância.
| Nome | Tipo | 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. |
| properties.secondaryType |
Tipo da instância geo-secundá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.
| Nome | Tipo | Description |
|---|---|---|
| nextLink |
string |
Link para recuperar a próxima página de resultados. |
| value |
Matriz de resultados. |
InstanceFailoverGroupReadOnlyEndpoint
Ponto de extremidade somente leitura da instância do grupo de failover.
| Nome | Tipo | 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.
| Nome | Tipo | 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 (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. |
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.
| Nome | Tipo | Description |
|---|---|---|
| partnerManagedInstanceId |
string |
ID da Instância Gerenciada de Parceiros em par. |
| primaryManagedInstanceId |
string |
ID da Instância Gerenciada Primária em par. |
PartnerRegionInfo
Informações da região do parceiro para o grupo de failover.
| Nome | Tipo | 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.
| 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 Automático, o failoverWithDataLossGracePeriodMinutes será necessário.
| Valor | Description |
|---|---|
| Manual | |
| Automatic |
SecondaryInstanceType
Tipo da instância geo-secundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR.
| Valor | Description |
|---|---|
| Geo | |
| Standby |