Failover Groups - Update
更新故障轉移群組。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}?api-version=2023-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
failover
|
path | True |
string |
故障轉移群組的名稱。 |
resource
|
path | True |
string |
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。 |
server
|
path | True |
string |
包含故障轉移群組的伺服器名稱。 |
subscription
|
path | True |
string |
識別 Azure 訂用帳戶的訂用帳戶標識碼。 |
api-version
|
query | True |
string |
要用於要求的 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties.databases |
string[] (arm-id) |
故障轉移群組中的資料庫清單。 |
properties.partnerServers |
故障轉移群組的合作夥伴伺服器資訊清單。 |
|
properties.readOnlyEndpoint |
故障轉移群組實例的唯讀端點。 |
|
properties.readWriteEndpoint |
故障轉移群組實例的讀寫端點。 |
|
properties.secondaryType |
夥伴伺服器上的資料庫次要類型。 |
|
tags |
object |
資源標籤。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功更新故障轉移群組。 |
|
202 Accepted |
接受 標題 Location: string |
|
Other Status Codes |
錯誤回應: ***
|
範例
Add database to failover group with standby secondary on partner server. |
Update failover group |
Add database to failover group with standby secondary on partner server.
範例要求
PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2023-08-01
{
"properties": {
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 120
},
"databases": [
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
],
"secondaryType": "Standby"
}
}
範例回覆
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
"name": "failover-group-test-3",
"type": "Microsoft.Sql/servers/failoverGroups",
"location": "Japan East",
"properties": {
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 120
},
"readOnlyEndpoint": {
"failoverPolicy": "Disabled",
"targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
},
"replicationRole": "Primary",
"replicationState": "CATCH_UP",
"partnerServers": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
"location": "Japan West",
"replicationRole": "Secondary"
}
],
"databases": [
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
]
}
}
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111
Update failover group
範例要求
PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2023-08-01
{
"properties": {
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 120
},
"databases": [
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
]
}
}
範例回覆
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
"name": "failover-group-test-3",
"type": "Microsoft.Sql/servers/failoverGroups",
"location": "Japan East",
"properties": {
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 120
},
"readOnlyEndpoint": {
"failoverPolicy": "Disabled",
"targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
},
"replicationRole": "Primary",
"replicationState": "CATCH_UP",
"partnerServers": [
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
"location": "Japan West",
"replicationRole": "Secondary"
}
],
"databases": [
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
]
}
}
Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Failover |
故障轉移群組。 |
Failover |
夥伴伺服器上的資料庫次要類型。 |
Failover |
故障轉移群組實例的唯讀端點。 |
Failover |
故障轉移群組實例的讀寫端點。 |
Failover |
故障轉移群組實例的本機複寫角色。 |
Failover |
故障轉移群組更新要求。 |
Partner |
故障轉移群組的合作夥伴伺服器資訊。 |
Read |
故障轉移群組只讀端點的故障轉移原則。 |
Read |
故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細數據。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
FailoverGroup
故障轉移群組。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼。 |
location |
string |
資源位置。 |
name |
string |
資源名稱。 |
properties.databases |
string[] (arm-id) |
故障轉移群組中的資料庫清單。 |
properties.partnerServers |
故障轉移群組的合作夥伴伺服器資訊清單。 |
|
properties.readOnlyEndpoint |
故障轉移群組實例的唯讀端點。 |
|
properties.readWriteEndpoint |
故障轉移群組實例的讀寫端點。 |
|
properties.replicationRole |
故障轉移群組實例的本機複寫角色。 |
|
properties.replicationState |
string |
故障轉移群組實例的復寫狀態。 |
properties.secondaryType |
夥伴伺服器上的資料庫次要類型。 |
|
tags |
object |
資源標籤。 |
type |
string |
資源類型。 |
FailoverGroupDatabasesSecondaryType
夥伴伺服器上的資料庫次要類型。
值 | Description |
---|---|
Geo | |
Standby |
FailoverGroupReadOnlyEndpoint
故障轉移群組實例的唯讀端點。
名稱 | 類型 | Description |
---|---|---|
failoverPolicy |
故障轉移群組只讀端點的故障轉移原則。 |
|
targetServer |
string (arm-id) |
唯讀端點指向的目標夥伴伺服器。 |
FailoverGroupReadWriteEndpoint
故障轉移群組實例的讀寫端點。
名稱 | 類型 | Description |
---|---|---|
failoverPolicy |
故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。 |
|
failoverWithDataLossGracePeriodMinutes |
integer (int32) |
嘗試讀取寫入端點的數據遺失故障轉移之前的寬限期。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。 |
FailoverGroupReplicationRole
故障轉移群組實例的本機複寫角色。
值 | Description |
---|---|
Primary | |
Secondary |
FailoverGroupUpdate
故障轉移群組更新要求。
名稱 | 類型 | Description |
---|---|---|
properties.databases |
string[] (arm-id) |
故障轉移群組中的資料庫清單。 |
properties.partnerServers |
故障轉移群組的合作夥伴伺服器資訊清單。 |
|
properties.readOnlyEndpoint |
故障轉移群組實例的唯讀端點。 |
|
properties.readWriteEndpoint |
故障轉移群組實例的讀寫端點。 |
|
properties.secondaryType |
夥伴伺服器上的資料庫次要類型。 |
|
tags |
object |
資源標籤。 |
PartnerInfo
故障轉移群組的合作夥伴伺服器資訊。
名稱 | 類型 | Description |
---|---|---|
id |
string (arm-id) |
夥伴伺服器的資源識別碼。 |
location |
string |
合作夥伴伺服器的地理位置。 |
replicationRole |
夥伴伺服器的復寫角色。 |
ReadOnlyEndpointFailoverPolicy
故障轉移群組只讀端點的故障轉移原則。
值 | Description |
---|---|
Disabled | |
Enabled |
ReadWriteEndpointFailoverPolicy
故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。
值 | Description |
---|---|
Automatic | |
Manual |