Instance Failover Groups - Create Or Update

Dienst:: SQL Database

API-Version:: 2025-01-01

Erstellt oder aktualisiert eine Failovergruppe.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
failoverGroupName	path	True	string	Der Name der Failovergruppe.
locationName	path	True	string	Der Name der Region, in der sich die Ressource befindet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.managedInstancePairs	True	ManagedInstancePairInfo[]	Liste der verwalteten Instanzpaare in der Failovergruppe.
properties.partnerRegions	True	PartnerRegionInfo[]	Partnerregionsinformationen für die Failovergruppe.
properties.readWriteEndpoint	True	InstanceFailoverGroupReadWriteEndpoint	Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.
properties.readOnlyEndpoint		InstanceFailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppeninstanz.
properties.secondaryType		SecondaryInstanceType	Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird.

Antworten

Name	Typ	Beschreibung
200 OK	InstanceFailoverGroup	Die Aktualisierungsoperation der Ressource 'InstanceFailoverGroup' war erfolgreich
201 Created	InstanceFailoverGroup	Resource 'InstanceFailoverGroup'-Erstellungsoperation erfolgreich Header Location: string Retry-After: integer
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Create failover group

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 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"
  }
}

Statuscode:: 202

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InstanceFailoverGroup	Eine Instanzfailovergruppe.
InstanceFailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppeninstanz.
InstanceFailoverGroupReadWriteEndpoint	Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.
InstanceFailoverGroupReplicationRole	Lokale Replikationsrolle der Failovergruppeninstanz.
ManagedInstancePairInfo	Paare verwalteter Instanzen in der Failovergruppe.
PartnerRegionInfo	Partnerregionsinformationen für die Failovergruppe.
ReadOnlyEndpointFailoverPolicy	Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.
ReadWriteEndpointFailoverPolicy	Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.
SecondaryInstanceType	Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InstanceFailoverGroup

Objekt

Eine Instanzfailovergruppe.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.managedInstancePairs	ManagedInstancePairInfo[]	Liste der verwalteten Instanzpaare in der Failovergruppe.
properties.partnerRegions	PartnerRegionInfo[]	Partnerregionsinformationen für die Failovergruppe.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppeninstanz.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Lokale Replikationsrolle der Failovergruppeninstanz.
properties.replicationState	string	Replikationsstatus der Failovergruppeninstanz.
properties.secondaryType	SecondaryInstanceType	Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

InstanceFailoverGroupReadOnlyEndpoint

Objekt

Schreibgeschützter Endpunkt der Failovergruppeninstanz.

Name	Typ	Beschreibung
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.

InstanceFailoverGroupReadWriteEndpoint

Objekt

Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.

Name	Typ	Beschreibung
failoverPolicy	ReadWriteEndpointFailoverPolicy	Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Die Karenzzeit vor dem Failover mit Datenverlust wird für den Endpunkt mit Lese-/Schreibzugriff versucht. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.

InstanceFailoverGroupReplicationRole

Enumeration

Lokale Replikationsrolle der Failovergruppeninstanz.

Wert	Beschreibung
Primary	Primär
Secondary	Secondary

ManagedInstancePairInfo

Objekt

Paare verwalteter Instanzen in der Failovergruppe.

Name	Typ	Beschreibung
partnerManagedInstanceId	string	ID der Partner verwaltete Instanz in Pair.
primaryManagedInstanceId	string	ID der primären verwaltete Instanz in Pair.

PartnerRegionInfo

Objekt

Partnerregionsinformationen für die Failovergruppe.

Name	Typ	Beschreibung
location	string	Geografischer Standort der vom Partner verwalteten Instanzen.
replicationRole	InstanceFailoverGroupReplicationRole	Replikationsrolle der vom Partner verwalteten Instanzen.

ReadOnlyEndpointFailoverPolicy

Enumeration

Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.

Wert	Beschreibung
Disabled	Deaktiviert
Enabled	Aktiviert

ReadWriteEndpointFailoverPolicy

Enumeration

Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.

Wert	Beschreibung
Manual	Manuell
Automatic	Automatisch

SecondaryInstanceType

Enumeration

Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird.

Wert	Beschreibung
Geo	Geo
Standby	Reserve

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Instance Failover Groups - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Create failover group

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData