共用方式為


Iot Hub - Manual Failover

手動起始 IoT 中樞 至其次要區域的故障轉移。 若要深入了解,請參閱 https://aka.ms/manualfailover

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover?api-version=2023-06-30

URI 參數

名稱 位於 必要 類型 Description
iotHubName
path True

string

要故障轉移的IoT中樞名稱

resourceGroupName
path True

string

包含IoT中樞資源的資源群組名稱

subscriptionId
path True

string

訂用帳戶識別碼。

api-version
query True

string

API 的版本。

要求本文

名稱 必要 類型 Description
failoverRegion True

string

中樞將會故障轉移至的區域

回應

名稱 類型 Description
200 OK

IoT 中樞長時間執行的手動故障轉移作業已完成

202 Accepted

手動故障轉移起始

標題

  • Azure-AsyncOperation: string
  • Location: string
Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

IotHub_ManualFailover

範例要求

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/failover?api-version=2023-06-30

{
  "failoverRegion": "testHub"
}

範例回覆

Azure-AsyncOperation: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2023-06-30-preview&operationSource=os_ih&asyncinfo
Location: https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/operationResults/b3NfaWhfYmJhZmM4OWItNzQ3My00OWExLTg0NWUtNzQ3NWU2ODBkNDA3?api-version=2022-11-01-preview&operationSource=os_ih

定義

名稱 Description
ErrorDetails

錯誤詳細數據。

FailoverInput

當要求中樞的手動故障轉移時,請使用 來提供故障轉移區域。

ErrorDetails

錯誤詳細數據。

名稱 類型 Description
code

string

錯誤碼。

details

string

錯誤詳細資料。

httpStatusCode

string

HTTP 狀態碼。

message

string

錯誤訊息。

FailoverInput

當要求中樞的手動故障轉移時,請使用 來提供故障轉移區域。

名稱 類型 Description
failoverRegion

string

中樞將會故障轉移至的區域