Failover Groups - Get

Служба:: SQL Database

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

Возвращает группу отработки отказа.

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	FailoverGroup	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

Get failover group

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/failoverGroups/failovergrouptest3?api-version=2025-01-01

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/SQL/stable/2025-01-01/examples/FailoverGroupGet.json
// this example is just showing the usage of "FailoverGroups_Get" 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 FailoverGroupResource created on azure
// for more information of creating FailoverGroupResource, please refer to the document of FailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failovergroupprimaryserver";
string failoverGroupName = "failovergrouptest3";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
FailoverGroupResource result = await failoverGroup.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

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

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

{
  "name": "failovergrouptest3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/failoverGroups/failovergrouptest3",
  "location": "Japan West",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/databases/testdb1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/databases/testdb2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupsecondaryserver",
        "location": "Japan East",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Enabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupsecondaryserver"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
FailoverGroup	Группа отработки отказа.
FailoverGroupDatabasesSecondaryType	Вторичный тип баз данных на сервере партнера.
FailoverGroupReadOnlyEndpoint	Конечная точка группы отработки отказа только для чтения.
FailoverGroupReadWriteEndpoint	Конечная точка чтения и записи экземпляра группы отработки отказа.
FailoverGroupReplicationRole	Локальная роль репликации экземпляра группы отработки отказа.
PartnerInfo	Сведения о сервере партнера для группы отработки отказа.
ReadOnlyEndpointFailoverPolicy	Политика отработки отказа конечной точки только для чтения для группы отработки отказа.
ReadWriteEndpointFailoverPolicy	Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если отработка отказа является автоматической, требуется отработка отказаWithDataLossGracePeriodMinutes.
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	Объект ошибки.

FailoverGroup

Объект

Группа отработки отказа.

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

FailoverGroupDatabasesSecondaryType

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

Вторичный тип баз данных на сервере партнера.

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

FailoverGroupReadOnlyEndpoint

Объект

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

Имя	Тип	Описание
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Политика отработки отказа конечной точки только для чтения для группы отработки отказа.
targetServer	string (arm-id)	Целевой сервер партнера, на который указывает конечная точка только для чтения.

FailoverGroupReadWriteEndpoint

Объект

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

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

FailoverGroupReplicationRole

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

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

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

PartnerInfo

Объект

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

Имя	Тип	Описание
id	string (arm-id)	Идентификатор ресурса сервера партнера.
location	string	Географическое расположение сервера партнера.
replicationRole	FailoverGroupReplicationRole	Роль репликации сервера-партнера.

ReadOnlyEndpointFailoverPolicy

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

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

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

ReadWriteEndpointFailoverPolicy

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

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

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

systemData

Объект

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

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