Instance Failover Groups - Force Failover Allow Data Loss

服務:

SQL Database

API 版本:

2023-08-01

從目前的主要受控實例故障轉移至這個受控實例。 這項作業可能會導致數據遺失。

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

URI 參數

名稱	位於	必要	類型	Description
failoverGroupName	path	True	string	故障轉移群組的名稱。
locationName	path	True	string	資源所在的區域名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	InstanceFailoverGroup	已成功故障轉移。
202 Accepted		接受 標題 Location: string
Other Status Codes	ErrorResponse	錯誤回應： *** 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary - 建立或更新實例故障轉移群組要求本文中指定的主要欄位是空的或無效的。 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner - 建立或更新實例故障轉移群組要求本文中的指定夥伴字段是空的或無效的。 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner - 一或多個提供的夥伴伺服器已經是實例故障轉移群組的一部分。 請確定主伺服器和所有指定的夥伴伺服器都是唯一的。 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion - 實例故障轉移群組要求本文中提供的夥伴受控實例區域是空的或無效的。 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - 僅支援一個合作夥伴區域。 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount - 僅支援一個受控實例組。 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - 建立或更新要求需要 readWriteEndpoint 字段。 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid - 建立或更新實例故障轉移群組要求本文是空的或無效的。 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary - 輔助伺服器上不允許修改實例故障轉移群組。 在主伺服器上執行要求。 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - 讀寫端點的寬限期值必須是非負數。 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - 實例故障轉移群組的寬限期值必須大於或等於 '{0}' 分鐘最小寬限期 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - 必須在為讀寫端點選取故障轉移原則自動時提供屬性 failoverWithDataLossGracePeriodMinutes。 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - 建立或更新要求需要讀寫端點的 failoverPolicy 字段。 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - 當為讀寫端點選取故障轉移原則手動時，不應該提供寬限期值。 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - 建立或更新實例故障轉移群組要求本文不應修改只讀屬性 '{0}'。 400 InstanceFailoverGroupFailoverRequestOnPrimary - 故障轉移要求應在實例故障轉移群組的輔助伺服器上起始。 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - 故障轉移群組的主伺服器和夥伴伺服器來自不同的訂用帳戶。 不允許故障轉移群組伺服器的跨訂用帳戶。 400 InvalidServerName - 指定的伺服器名稱無效。 400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。 400 TokenTooLong - 提供的令牌太長。 400 InvalidAddSecondaryPermission - 使用者沒有足夠的許可權在指定的伺服器上新增次要複本。 400 InvalidSku - 使用者指定了無效的 SKU。 400 ServerNotFound - 找不到要求的伺服器。 400 ServerEditionMismatch - 建立複本伺服器時，Edition 必須與主伺服器相同。 400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本已停用的功能。 400 TokenTooLong - 提供的令牌太長。 400 InvalidTargetSubregion - 不可讀取次要伺服器的目標伺服器不在DR配對的 Azure 區域中。 400 ManagedInstanceStoppingOrStopped - 實例處於停止/停止狀態時提交的衝突作業 400 ManagedInstanceStarting - 實例處於啟動狀態時提交的衝突作業 400 IncorrectReplicationLinkState - 作業預期資料庫在復寫連結上處於預期狀態。 400 CloudLifterFogInaccessibleDbRoleMismatch - 無法讓 SQL 受控實例上的資料庫 {0}{1} 存取，因為故障轉移群組中的實例角色在資料庫處於無法存取狀態時，已從 {2} 變更為 {3}。 請執行異地故障轉移來還原原始資料庫角色，然後再試一次。 400 CloudLifterGeodrBlocksDbActivate - 由於進行中的異地作業，無法在 SQL 受控實例上 {0} 資料庫 {1} 存取。 請等到衝突的作業完成，然後再試一次。 400 AzureKeyVaultKeyDisabled - 無法完成伺服器上的作業，因為 Azure Key Vault 密鑰已停用。 400 AzureKeyVaultInvalidExpirationDate - 作業無法完成，因為 Azure Key Vault 密鑰到期日無效。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 作業無法完成，因為 Azure Key Vault URI 為 Null 或空白。 400 AzureKeyVaultNoServerIdentity - 伺服器識別未正確設定。 400 AzureKeyVaultInvalidUri - 來自 Azure Key Vault 的無效回應。 請使用有效的 Azure Key Vault URI。 400 AzureKeyVaultMissingPermissions - 伺服器缺少 Azure Key Vault 的必要許可權。 400 SecurityAzureKeyVaultInvalidKeyName - 作業無法完成，因為伺服器密鑰名稱無效。 400 PlannedFailoverTimedOutForDatabase - 使用者叫用計劃性故障轉移、逾時，而且特定資料庫似乎要責怪。 400 PlannedFailoverTimedOut - 使用者叫用計劃性故障轉移，嘗試連絡合作夥伴管理服務時逾時。 400 AdalGenericError - 作業無法完成，因為發生 Azure Active Directory 錯誤。 400 AdalServicePrincipalNotFound - 作業無法完成，因為找不到 Azure Active Directory 連結庫服務主體錯誤。 400 AzureKeyVaultMalformedVaultUri - 提供的 Key Vault URI 無效。 400 CannotUseReservedDatabaseName - 無法在此作業中使用保留的資料庫名稱。 400 InvalidFailoverGroupRegion - 實例故障轉移群組中指定的伺服器必須位於不同區域以提供隔離。 400 InstanceFailoverGroupDoesNotExist - 故障轉移群組不存在於伺服器上。 400 InstanceFailoverGroupNotSecondary - 故障轉移無法從實例故障轉移群組中的主伺服器起始故障轉移。 400 ManagedInstanceGeoDRNotAllowedForInstancePool - 針對在實例集區內布建的受控實例，不支援建立自動故障轉移群組 （GeoDR）。 自動故障轉移群組只能針對獨立受控實例建立。 400 InvalidServerName - 指定的伺服器名稱無效。 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - 無法建立故障轉移群組，因為主實例的資料庫格式與輔助實例的資料庫格式不相容。 如需詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2251601。 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - 故障轉移作業無法執行，因為故障轉移群組中的實例之間的資料庫格式不符。 請考慮升級主要實例的資料庫格式，或刪除故障轉移群組，以將目前的次要實例升級為獨立實例。 如需詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2251601。 400 SecurityAdalPrincipalCertExpiredError - 作業無法完成，因為 Azure Key Vault 主體憑證已過期。 免費 Azure SQL 受控實例供應專案不支援 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - 部署故障轉移群組。 400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 Key Vault URI 無效。 400 ManagedInstanceGeoFailoverCannotBeExecuted - 目前無法執行受控實例異地故障轉移。 原因：'{0}'。 400 KeyMaterialNotFoundOnRemoteServer - 遠端伺服器無法存取做為 TDE 保護裝置的金鑰數據。 400 SameKeyUriNotFoundOnRemoteServer - 輔助伺服器沒有與啟用密鑰自動輪替之主伺服器加密保護裝置相同的密鑰保存庫的金鑰數據。 400 AzureKeyVaultRsaKeyNotSupported - 提供的密鑰保存庫使用不支援的 RSA 金鑰大小或密鑰類型。 支援的 RSA 金鑰大小為 2048 或 3072，而密鑰類型為 RSA 或 RSA-HSM。 400 SameKeyMaterialNotFoundOnRemoteServer - 輔助伺服器沒有主伺服器加密保護裝置的密鑰內容。 400 GeoReplicationDatabaseNotSecondary - 此作業預期資料庫必須是復寫目標。 400 ManagedInstanceUpdateSloOngoing - 作業無法完成，因為受控實例 '{0}' 的服務層級變更正在進行中。 請等候作業進行中完成，然後再試一次。 400 FailoverGroupRegionMismatch - 故障轉移群組中指定的合作夥伴區域必須符合所指出合作夥伴受控實例的區域。 400 DnsZoneMismatch - 夥伴伺服器上的 DNSZone 與來源伺服器上的 DNSZone 不同。 這會中斷 InstanceFailoverGroup 功能。 400 GeoDrInstanceSizeMismatch - 主要受控實例和夥伴受控實例沒有相同的記憶體大小。 400 UnableToResolveRemoteServer - 遠端夥伴伺服器名稱無法解決，因為伺服器名稱或 DNS 連線問題無效。 400 GeoDrSecondaryInstanceNotEmpty - 次要受控實例具有用戶資料庫。 若要建立實例故障轉移群組，次要受控實例必須是空的。 400 RemoteDatabaseCopyPermission - 用戶沒有足夠的許可權在指定的伺服器上建立資料庫複本。 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - 網路設定不正確。 主伺服器的復寫流量無法連線到輔助伺服器。 404 OperationIdNotFound - 標識符為 的作業不存在。 404 ResourceNotFound - 找不到要求的資源。 404 OperationIdNotFound - 標識符為 的作業不存在。 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。 404 ServerNotInSubscription - 指定的伺服器不存在於指定的訂用帳戶上。 404 SourceDatabaseNotFound - 源資料庫不存在。 405 UnsupportedReplicationOperation - 資料庫上起始了不支持的復寫作業。 409 CannotCancelOperation - 管理作業處於無法取消的狀態。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為相同資源上的另一個作業中斷。 409 ConflictingServerOperation - 伺服器目前正在進行作業。 409 SubscriptionDisabled - 已停用訂用帳戶。 409 ConflictingSystemOperationInProgress - 資料庫上的系統維護作業正在進行中，而進一步的作業必須等到它完成為止。 409 ManagedInstanceContainsInaccessibleDatabases - 作業無法完成，因為受控實例 '{0}' 包含處於無法存取狀態的資料庫。 請在重試作業之前，先卸除無法存取的資料庫，或修正客戶管理的 TDE 保護裝置密鑰存取問題。 https://go.microsoft.com/fwlink/?linkid=2111623 409 ManagedInstanceHasHybridLink - 使用者嘗試在受控實例設定混合式連結時起始不支持的作業。 409 GeoReplicationCannotBecomePrimaryDuringUndo - 使用者嘗試故障轉移或強制終止異地連結，而次要複本處於實體不一致的狀態，因此無法進入主要角色。 409 ServerKeyNameAlreadyExists - 伺服器密鑰已存在於伺服器上。 409 ServerKeyUriAlreadyExists - 伺服器密鑰 URI 已存在於伺服器上。 409 ServerKeyDoesNotExists - 伺服器密鑰不存在。 409 UpdateSloInProgress - 用戶嘗試在 SLO 更新進行時起始不相容的作業。 409 AzureKeyVaultKeyNameNotFound - 作業無法完成，因為 Azure Key Vault 密鑰名稱不存在。 409 AzureKeyVaultKeyInUse - 伺服器目前正在使用密鑰。 409 InstanceFailoverGroupAlreadyExists - 故障轉移群組已存在於指定的伺服器上。 409 InstanceFailoverGroupBusy - 實例故障轉移群組正忙於另一項作業。 409 InstanceFailoverGroupDnsRecordInUse - 要求的端點有重複的 DNS 記錄。 409 InvalidFailoverGroupName - 已提供無效的實例故障轉移組名。 409 InvalidOperationForDatabaseNotInReplicationRelationship - 在不在復寫關聯性的資料庫中執行複寫作業。 409 InvalidDatabaseStateForOperation - 資料庫的目前復寫狀態不允許此作業。 409 DuplicateGeoDrRelation - 資料庫已經在復寫關聯中。 這是重複的要求。 409 RemoteDatabaseExists - 目的地伺服器上已經存在目的地資料庫名稱。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 500 OperationTimedOut - 作業逾時並自動回復。 請重試作業。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。 503 AzureKeyVaultConnectionFailed - 無法完成伺服器上的作業，因為嘗試連線到 Azure Key Vault 失敗 503 AzureKeyVaultGenericConnectionError - 作業無法完成，因為嘗試擷取 Key Vault 資訊時發生錯誤。 504 RequestTimeout - 服務要求超過允許的逾時。

範例

Forced failover of a failover group allowing data loss

範例要求

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/forceFailoverAllowDataLoss?api-version=2023-08-01

dotnet

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/stable/2023-08-01/examples/InstanceFailoverGroupForceFailoverAllowDataLoss.json
// this example is just showing the usage of "InstanceFailoverGroups_ForceFailoverAllowDataLoss" 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 InstanceFailoverGroupResource created on azure
// for more information of creating InstanceFailoverGroupResource, please refer to the document of InstanceFailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
AzureLocation locationName = new AzureLocation("Japan West");
string failoverGroupName = "failover-group-test-3";
ResourceIdentifier instanceFailoverGroupResourceId = InstanceFailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, failoverGroupName);
InstanceFailoverGroupResource instanceFailoverGroup = client.GetInstanceFailoverGroupResource(instanceFailoverGroupResourceId);

// invoke the operation
ArmOperation<InstanceFailoverGroupResource> lro = await instanceFailoverGroup.ForceFailoverAllowDataLossAsync(WaitUntil.Completed);
InstanceFailoverGroupResource result = lro.Value;

// 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
InstanceFailoverGroupData 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

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

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
InstanceFailoverGroup	實例故障轉移群組。
InstanceFailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
InstanceFailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
InstanceFailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
ManagedInstancePairInfo	故障轉移群組中的受控實例配對。
PartnerRegionInfo	故障轉移群組的合作夥伴區域資訊。
ReadOnlyEndpointFailoverPolicy	故障轉移群組只讀端點的故障轉移原則。
ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。
SecondaryInstanceType	異地次要實例的類型。 如果實例僅做為DR選項，請設定 『Standby』。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

InstanceFailoverGroup

Object

實例故障轉移群組。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.managedInstancePairs	ManagedInstancePairInfo[]	故障轉移群組中的受控實例配對清單。
properties.partnerRegions	PartnerRegionInfo[]	故障轉移群組的合作夥伴區域資訊。
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
properties.replicationRole	InstanceFailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
properties.replicationState	string	故障轉移群組實例的復寫狀態。
properties.secondaryType	SecondaryInstanceType	異地次要實例的類型。 如果實例僅做為DR選項，請設定 『Standby』。
type	string	資源類型。

InstanceFailoverGroupReadOnlyEndpoint

Object

故障轉移群組實例的唯讀端點。

名稱	類型	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	故障轉移群組只讀端點的故障轉移原則。

InstanceFailoverGroupReadWriteEndpoint

Object

故障轉移群組實例的讀寫端點。

名稱	類型	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes	integer (int32)	嘗試讀取寫入端點的數據遺失故障轉移之前的寬限期。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

InstanceFailoverGroupReplicationRole

列舉型別

故障轉移群組實例的本機複寫角色。

值	Description
Primary
Secondary

ManagedInstancePairInfo

Object

故障轉移群組中的受控實例配對。

名稱	類型	Description
partnerManagedInstanceId	string	配對的合作夥伴受控實例標識碼。
primaryManagedInstanceId	string	配對中主要受控實例的標識碼。

PartnerRegionInfo

Object

故障轉移群組的合作夥伴區域資訊。

名稱	類型	Description
location	string	合作夥伴受控實例的地理位置。
replicationRole	InstanceFailoverGroupReplicationRole	夥伴受控實例的複寫角色。

ReadOnlyEndpointFailoverPolicy

列舉型別

故障轉移群組只讀端點的故障轉移原則。

值	Description
Disabled
Enabled

ReadWriteEndpointFailoverPolicy

列舉型別

故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

值	Description
Manual
Automatic

SecondaryInstanceType

列舉型別

異地次要實例的類型。 如果實例僅做為DR選項，請設定 『Standby』。

值	Description
Geo
Standby