Compartilhar via


Iot Hub - Manual Failover

Inicie manualmente um failover para o Hub IoT para sua região secundária. Para saber mais, confira 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 URI

Nome Em Obrigatório Tipo Description
iotHubName
path True

string

Nome do hub IoT para failover

resourceGroupName
path True

string

Nome do grupo de recursos que contém o recurso do Hub IoT

subscriptionId
path True

string

O identificador da assinatura.

api-version
query True

string

A versão da API.

Corpo da solicitação

Nome Obrigatório Tipo Description
failoverRegion True

string

Região em que o hub será reprovado

Respostas

Nome Tipo Description
200 OK

Operação de failover manual de execução prolongada para o hub IoT concluída

202 Accepted

Failover manual iniciado

Cabeçalhos

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

ErrorDetails

DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

IotHub_ManualFailover

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ErrorDetails

Detalhes do erro.

FailoverInput

Use para fornecer a região de failover ao solicitar failover manual para um hub.

ErrorDetails

Detalhes do erro.

Nome Tipo Description
code

string

O código de erro.

details

string

Os detalhes do erro.

httpStatusCode

string

O código de status do HTTP.

message

string

A mensagem de erro.

FailoverInput

Use para fornecer a região de failover ao solicitar failover manual para um hub.

Nome Tipo Description
failoverRegion

string

Região em que o hub será reprovado