Protected Item - Planned Failover

Serviço:: Data Replication

Versão da API:: 2026-05-01

Executa o failover planejado no item protegido.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/plannedFailover?api-version=2026-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
protectedItemName	path	True	string pattern: ^[a-zA-Z0-9]*$	O nome do item protegido.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser um UUID.
vaultName	path	True	string pattern: ^[a-zA-Z0-9]*$	O nome do cofre.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties	True	PlannedFailoverModelProperties	Propriedades do modelo de failover planejado.

Respostas

Name	Tipo	Description
200 OK	PlannedFailoverModel	Operação do Azure concluída com sucesso.
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

PlannedFailoverModel

Operação do Azure concluída com sucesso.

202 Accepted

Operação de recurso aceita.

Cabeçalhos

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Performs planned failover.

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/AB5DAF5C-38A8-40FF-9D90-4C394A40E094/resourceGroups/rgrecoveryservicesdatareplication/providers/Microsoft.DataReplication/replicationVaults/lftqijwwzmqhexnl/protectedItems/ybdaqrrypdozdgxrvmvv/plannedFailover?api-version=2026-05-01

{
  "properties": {
    "customProperties": {
      "instanceType": "PlannedFailoverModelCustomProperties"
    }
  }
}

Resposta da amostra

Código de estado:: 200

{
  "properties": {
    "customProperties": {
      "instanceType": "PlannedFailoverModelCustomProperties"
    }
  }
}

Código de estado:: 202

location: https://contoso.com/operationstatus

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HyperVToAzStackHCIPlannedFailoverModelCustomProperties	Propriedades personalizadas do modelo de failover planejado do HyperV para AzStackHCI.
PlannedFailoverModel	Modelo de failover planejado.
PlannedFailoverModelProperties	Propriedades do modelo de failover planejado.
VMwareToAzStackHCIPlannedFailoverModelCustomProperties	Propriedades personalizadas do modelo de failover planejado VMware para AzStackHCI.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

HyperVToAzStackHCIPlannedFailoverModelCustomProperties

Object

Propriedades personalizadas do modelo de failover planejado do HyperV para AzStackHCI.

Name	Tipo	Description
instanceType	string: HyperVToAzStackHCI	Propriedade discriminator para PlannedFailoverModelCustomProperties.
shutdownSourceVM	boolean	Obtém ou define um valor que indica se a VM precisa ser desligada.

PlannedFailoverModel

Object

Modelo de failover planejado.

Name	Tipo	Description
properties	PlannedFailoverModelProperties	Propriedades do modelo de failover planejado.

PlannedFailoverModelProperties

Object

Propriedades do modelo de failover planejado.

Name	Tipo	Description
customProperties	PlannedFailoverModelCustomProperties: HyperVToAzStackHCIPlannedFailoverModelCustomProperties VMwareToAzStackHCIPlannedFailoverModelCustomProperties	Propriedades personalizadas do modelo de failover planejado.

VMwareToAzStackHCIPlannedFailoverModelCustomProperties

Object

Propriedades personalizadas do modelo de failover planejado VMware para AzStackHCI.

Name	Tipo	Description
instanceType	string: VMwareToAzStackHCI	Propriedade discriminator para PlannedFailoverModelCustomProperties.
shutdownSourceVM	boolean	Obtém ou define um valor que indica se a VM precisa ser desligada.