Iot Hub - Manual Failover

Avviare manualmente un failover per il hub IoT nella relativa area secondaria. Per altre informazioni, vedere https://aka.ms/manualfailover

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
iotHubName
path True

string

Nome dell'hub IoT per il failover

resourceGroupName
path True

string

Nome del gruppo di risorse contenente la risorsa dell'hub IoT

subscriptionId
path True

string

L'identificatore della sottoscrizione.

api-version
query True

string

Versione dell'API.

Corpo della richiesta

Nome Necessario Tipo Descrizione
failoverRegion True

string

Area in cui verrà eseguito il failover dell'hub

Risposte

Nome Tipo Descrizione
200 OK

Operazione di failover manuale a esecuzione prolungata per l'hub IoT completata

202 Accepted

Failover manuale avviato

Intestazioni

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

ErrorDetails

DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

IotHub_ManualFailover

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ErrorDetails

Dettagli errore.

FailoverInput

Usare per specificare l'area di failover quando si richiede il failover manuale per un hub.

ErrorDetails

Dettagli errore.

Nome Tipo Descrizione
code

string

Codice di errore.

details

string

Dettagli dell'errore.

httpStatusCode

string

Codice di stato HTTP.

message

string

Messaggio di errore.

FailoverInput

Usare per specificare l'area di failover quando si richiede il failover manuale per un hub.

Nome Tipo Descrizione
failoverRegion

string

Area in cui verrà eseguito il failover dell'hub