Compartir a través de


Iot Hub - Manual Failover

Inicie manualmente una conmutación por error para el IoT Hub a su región secundaria. Para más información, consulte https://aka.ms/manualfailover.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
iotHubName
path True

string

Nombre del centro de IoT para la conmutación por error

resourceGroupName
path True

string

Nombre del grupo de recursos que contiene el recurso de IoT Hub

subscriptionId
path True

string

Identificador de la suscripción.

api-version
query True

string

La versión de la API.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
failoverRegion True

string

Región a la que se conmutará por error el centro

Respuestas

Nombre Tipo Description
200 OK

Operación de conmutación por error manual de larga duración para ioT Hub completada

202 Accepted

Conmutación por error manual iniciada

Encabezados

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

ErrorDetails

DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

IotHub_ManualFailover

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
ErrorDetails

Detalles del error.

FailoverInput

Use para proporcionar una región de conmutación por error al solicitar conmutación por error manual para un centro.

ErrorDetails

Detalles del error.

Nombre Tipo Description
code

string

Código de error.

details

string

Los detalles del error.

httpStatusCode

string

El código de estado HTTP.

message

string

El mensaje de error.

FailoverInput

Use para proporcionar una región de conmutación por error al solicitar conmutación por error manual para un centro.

Nombre Tipo Description
failoverRegion

string

Región a la que se conmutará por error el centro