Instance Failover Groups - Failover

Служба:: SQL Database

Версия API:: 2025-01-01

Отработка отказа из текущего основного управляемого экземпляра в этот управляемый экземпляр.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
failoverGroupName	path	True	string	Имя группы отработки отказа.
locationName	path	True	string	Имя региона, в котором находится ресурс.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	InstanceFailoverGroup	Операция Azure успешно завершена.
202 Accepted		Операция ресурса принята. Заголовки Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

InstanceFailoverGroup

Операция Azure успешно завершена.

202 Accepted

Операция ресурса принята.

Заголовки

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Planned failover of a failover group

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

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

Код состояния:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/instanceFailoverGroupOperationResults/failover-group-test-3?api-version=2022-05-01-preview

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
InstanceFailoverGroup	Группа отработки отказа экземпляра.
InstanceFailoverGroupReadOnlyEndpoint	Конечная точка группы отработки отказа только для чтения.
InstanceFailoverGroupReadWriteEndpoint	Конечная точка чтения и записи экземпляра группы отработки отказа.
InstanceFailoverGroupReplicationRole	Локальная роль репликации экземпляра группы отработки отказа.
ManagedInstancePairInfo	Пары управляемых экземпляров в группе отработки отказа.
PartnerRegionInfo	Сведения о регионе партнера для группы отработки отказа.
ReadOnlyEndpointFailoverPolicy	Политика отработки отказа конечной точки только для чтения для группы отработки отказа.
ReadWriteEndpointFailoverPolicy	Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если отработка отказа является автоматической, требуется отработка отказаWithDataLossGracePeriodMinutes.
SecondaryInstanceType	Тип гео-вторичного экземпляра. Установите значение "Резервный", если экземпляр используется только в качестве параметра аварийного восстановления.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

InstanceFailoverGroup

Объект

Группа отработки отказа экземпляра.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.managedInstancePairs	ManagedInstancePairInfo[]	Список пар управляемых экземпляров в группе отработки отказа.
properties.partnerRegions	PartnerRegionInfo[]	Сведения о регионе партнера для группы отработки отказа.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Конечная точка группы отработки отказа только для чтения.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Конечная точка чтения и записи экземпляра группы отработки отказа.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Локальная роль репликации экземпляра группы отработки отказа.
properties.replicationState	string	Состояние репликации экземпляра группы отработки отказа.
properties.secondaryType	SecondaryInstanceType	Тип гео-вторичного экземпляра. Установите значение "Резервный", если экземпляр используется только в качестве параметра аварийного восстановления.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

InstanceFailoverGroupReadOnlyEndpoint

Объект

Конечная точка группы отработки отказа только для чтения.

Имя	Тип	Описание
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Политика отработки отказа конечной точки только для чтения для группы отработки отказа.

InstanceFailoverGroupReadWriteEndpoint

Объект

Конечная точка чтения и записи экземпляра группы отработки отказа.

Имя	Тип	Описание
failoverPolicy	ReadWriteEndpointFailoverPolicy	Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если отработка отказа является автоматической, требуется отработка отказаWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Льготный период перед отработкой отказа с потерей данных пытается выполнить для конечной точки чтения и записи. Если отработка отказа является автоматической, требуется отработка отказаWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

Перечисление

Локальная роль репликации экземпляра группы отработки отказа.

Значение	Описание
Primary	Primary
Secondary	Secondary

ManagedInstancePairInfo

Объект

Пары управляемых экземпляров в группе отработки отказа.

Имя	Тип	Описание
partnerManagedInstanceId	string	ID партнёра Управляемый экземпляр в паре.
primaryManagedInstanceId	string	ID Primary Управляемый экземпляр в паре.

PartnerRegionInfo

Объект

Сведения о регионе партнера для группы отработки отказа.

Имя	Тип	Описание
location	string	Географическое расположение управляемых экземпляров партнера.
replicationRole	InstanceFailoverGroupReplicationRole	Роль репликации управляемых экземпляров партнера.

ReadOnlyEndpointFailoverPolicy

Перечисление

Политика отработки отказа конечной точки только для чтения для группы отработки отказа.

Значение	Описание
Disabled	Disabled
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Перечисление

Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если отработка отказа является автоматической, требуется отработка отказаWithDataLossGracePeriodMinutes.

Значение	Описание
Manual	Руководство
Automatic	Автоматический

SecondaryInstanceType

Перечисление

Тип гео-вторичного экземпляра. Установите значение "Резервный", если экземпляр используется только в качестве параметра аварийного восстановления.

Значение	Описание
Geo	Гео
Standby	Режим ожидания

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Instance Failover Groups - Failover

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Planned failover of a failover group

Образец запроса

Пример ответа

Определения

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData