Failover Groups - Create Or Update

Usługa:: SQL Database

Wersja interfejsu API:: 2025-01-01

Tworzy lub aktualizuje grupę trybu failover.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
failoverGroupName	path	True	string	Nazwa grupy trybu failover.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.partnerServers	True	PartnerInfo[]	Lista informacji o serwerze partnerskim dla grupy trybu failover.
properties.readWriteEndpoint	True	FailoverGroupReadWriteEndpoint	Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.
properties.databases		string[] (arm-id)	Lista baz danych w grupie trybu failover.
properties.readOnlyEndpoint		FailoverGroupReadOnlyEndpoint	Punkt końcowy grupy trybu failover tylko do odczytu.
properties.secondaryType		FailoverGroupDatabasesSecondaryType	Typ pomocniczy baz danych na serwerze partnerskim.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FailoverGroup	Operacja aktualizacji zasobu 'FailoverGroup' zakończyła się sukcesem
201 Created	FailoverGroup	Operacja tworzenia zasobu 'FailoverGroup' zakończyła się sukcesem Nagłówki Location: string Retry-After: integer
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create failover group

Create failover group with standby secondary database on partner server.

Create failover group

Przykładowe żądanie

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Kod stanu:: 201

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Kod stanu:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

Create failover group with standby secondary database on partner server.

Przykładowe żądanie

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "secondaryType": "Standby"
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Kod stanu:: 201

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Kod stanu:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FailoverGroup	Grupa trybu failover.
FailoverGroupDatabasesSecondaryType	Typ pomocniczy baz danych na serwerze partnerskim.
FailoverGroupReadOnlyEndpoint	Punkt końcowy grupy trybu failover tylko do odczytu.
FailoverGroupReadWriteEndpoint	Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.
FailoverGroupReplicationRole	Rola replikacji lokalnej wystąpienia grupy trybu failover.
PartnerInfo	Informacje o serwerze partnerskim dla grupy trybu failover.
ReadOnlyEndpointFailoverPolicy	Zasady trybu failover punktu końcowego tylko do odczytu dla grupy trybu failover.
ReadWriteEndpointFailoverPolicy	Zasady trybu failover punktu końcowego odczytu i zapisu dla grupy trybu failover. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Błąd dodatkowe informacje.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

FailoverGroup

Objekt

Grupa trybu failover.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu
properties.databases	string[] (arm-id)	Lista baz danych w grupie trybu failover.
properties.partnerServers	PartnerInfo[]	Lista informacji o serwerze partnerskim dla grupy trybu failover.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Punkt końcowy grupy trybu failover tylko do odczytu.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.
properties.replicationRole	FailoverGroupReplicationRole	Rola replikacji lokalnej wystąpienia grupy trybu failover.
properties.replicationState	string	Stan replikacji wystąpienia grupy trybu failover.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Typ pomocniczy baz danych na serwerze partnerskim.
systemData	systemData	Metadane Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft. Compute/virtualMachines" lub "Microsoft. Storage/storageAccounts"

FailoverGroupDatabasesSecondaryType

Wyliczenie

Typ pomocniczy baz danych na serwerze partnerskim.

Wartość	Opis
Geo	Geo
Standby	Czuwanie

FailoverGroupReadOnlyEndpoint

Objekt

Punkt końcowy grupy trybu failover tylko do odczytu.

Nazwa	Typ	Opis
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Zasady trybu failover punktu końcowego tylko do odczytu dla grupy trybu failover.
targetServer	string (arm-id)	Docelowy serwer partnera, na którym wskazuje punkt końcowy tylko do odczytu.

FailoverGroupReadWriteEndpoint

Objekt

Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.

Nazwa	Typ	Opis
failoverPolicy	ReadWriteEndpointFailoverPolicy	Zasady trybu failover punktu końcowego odczytu i zapisu dla grupy trybu failover. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Okres prolongaty przed próbą przejścia w tryb failover z utratą danych dla punktu końcowego odczytu i zapisu. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.

FailoverGroupReplicationRole

Wyliczenie

Rola replikacji lokalnej wystąpienia grupy trybu failover.

Wartość	Opis
Primary	Podstawowe
Secondary	Podrzędny

PartnerInfo

Objekt

Informacje o serwerze partnerskim dla grupy trybu failover.

Nazwa	Typ	Opis
id	string (arm-id)	Identyfikator zasobu serwera partnerskiego.
location	string	Lokalizacja geograficzna serwera partnerskiego.
replicationRole	FailoverGroupReplicationRole	Rola replikacji serwera partnerskiego.

ReadOnlyEndpointFailoverPolicy

Wyliczenie

Zasady trybu failover punktu końcowego tylko do odczytu dla grupy trybu failover.

Wartość	Opis
Disabled	Wyłączony
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Wyliczenie

Zasady trybu failover punktu końcowego odczytu i zapisu dla grupy trybu failover. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.

Wartość	Opis
Manual	Instrukcja
Automatic	Automatycznie

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Failover Groups - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Create failover group

Przykładowe żądanie

Przykładowa odpowiedź

Create failover group with standby secondary database on partner server.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailoverGroup

FailoverGroupDatabasesSecondaryType

FailoverGroupReadOnlyEndpoint

FailoverGroupReadWriteEndpoint

FailoverGroupReplicationRole

PartnerInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

systemData