Instance Failover Groups - Create Or Update

Serviço:: SQL Database

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

Cria ou atualiza um grupo de failover.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	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 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 uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.managedInstancePairs	True	ManagedInstancePairInfo[]	Lista de pares de instância gerenciada no grupo de failover.
properties.partnerRegions	True	PartnerRegionInfo[]	Informações da região do parceiro para o grupo de failover.
properties.readWriteEndpoint	True	InstanceFailoverGroupReadWriteEndpoint	Ponto de extremidade de leitura/gravação da instância do grupo de failover.
properties.readOnlyEndpoint		InstanceFailoverGroupReadOnlyEndpoint	Ponto de extremidade somente leitura da instância do grupo de failover.
properties.secondaryType		SecondaryInstanceType	Tipo da instância geo-secundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR.

Respostas

Nome	Tipo	Description
200 OK	InstanceFailoverGroup	Operação de atualização do recurso 'InstanceFailoverGroup' bem-sucedida
201 Created	InstanceFailoverGroup	Recurso 'InstanceFailoverGroup' criar operação bem-sucedida Cabeçalhos Location: string Retry-After: integer
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create failover group

Solicitação de exemplo

HTTP

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

{
  "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"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "secondaryType": "Geo"
  }
}

Resposta de exemplo

Código de status:: 200

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

Código de status:: 201

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

Código de status:: 202

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
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.
SecondaryInstanceType	Tipo da instância geo-secundária. Defina 'Standby' se a instância for usada apenas como uma opção de DR.
systemData	Metadados relativos à 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

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.

InstanceFailoverGroup

Objeto

Um grupo de failover de instância.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada 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ância gerenciada no grupo de failover.
properties.partnerRegions	PartnerRegionInfo[]	Informações da região do 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 da instância geo-secundá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. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

InstanceFailoverGroupReadOnlyEndpoint

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.

InstanceFailoverGroupReadWriteEndpoint

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.

InstanceFailoverGroupReplicationRole

Enumeração

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

Valor	Description
Primary	Primária
Secondary	Secundário

ManagedInstancePairInfo

Objeto

Pares de Instâncias Gerenciadas no grupo de failover.

Nome	Tipo	Description
partnerManagedInstanceId	string	Id do Partner Instância Gerenciada em par.
primaryManagedInstanceId	string	Id do Primary Instância Gerenciada em par.

PartnerRegionInfo

Objeto

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	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	Desactivado
Enabled	Habilitado

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

SecondaryInstanceType

Enumeração

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	Geo
Standby	Em espera

systemData

Objeto

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

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

Compartilhar via

Instance Failover Groups - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create failover group

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData