Partager via


Iot Hub - Manual Failover

Initiez manuellement un basculement pour le IoT Hub vers sa région secondaire. Pour en savoir plus, consultez https://aka.ms/manualfailover.

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

Paramètres URI

Nom Dans Obligatoire Type Description
iotHubName
path True

string

Nom du hub IoT à basculer

resourceGroupName
path True

string

Nom du groupe de ressources contenant la ressource IoT Hub

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Corps de la demande

Nom Obligatoire Type Description
failoverRegion True

string

Région vers laquelle le hub sera basculé

Réponses

Nom Type Description
200 OK

Opération de basculement manuel de longue durée pour le hub IoT terminée

202 Accepted

Basculement manuel initié

En-têtes

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

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IotHub_ManualFailover

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ErrorDetails

Détails de l’erreur.

FailoverInput

Permet de fournir une région de basculement lors de la demande de basculement manuel pour un hub.

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

FailoverInput

Permet de fournir une région de basculement lors de la demande de basculement manuel pour un hub.

Nom Type Description
failoverRegion

string

Région vers laquelle le hub sera basculé