Protected Item - Planned Failover

Serviço:

Data Replication

Versão da API:

2021-02-16-preview

Executa o failover planejado.
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=2021-02-16-preview

Parâmetros de URI

Nome	Em	Obrigató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)	A ID da assinatura de destino. O valor deve ser uma 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 ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties	True	PlannedFailoverModelProperties	Propriedades planejadas do modelo de failover.

Respostas

Nome	Tipo	Description
200 OK	PlannedFailoverModel	Êxito
202 Accepted		Aceitado Cabeçalhos Azure-AsyncOperation: string Location: string
Other Status Codes	ErrorResponse	Erro

Segurança

azure_auth

Fluxo 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

ProtectedItem_PlannedFailover

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/930CEC23-4430-4513-B855-DBA237E2F3BF/resourceGroups/rgrecoveryservicesdatareplication/providers/Microsoft.DataReplication/replicationVaults/4/protectedItems/d/plannedFailover?api-version=2021-02-16-preview

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

Java

import com.azure.resourcemanager.recoveryservicesdatareplication.fluent.models.PlannedFailoverModelInner;
import com.azure.resourcemanager.recoveryservicesdatareplication.models.PlannedFailoverModelCustomProperties;
import com.azure.resourcemanager.recoveryservicesdatareplication.models.PlannedFailoverModelProperties;

/**
 * Samples for ProtectedItem PlannedFailover.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-
     * preview/examples/ProtectedItem_PlannedFailover.json
     */
    /**
     * Sample code: ProtectedItem_PlannedFailover.
     * 
     * @param manager Entry point to RecoveryServicesDataReplicationManager.
     */
    public static void protectedItemPlannedFailover(
        com.azure.resourcemanager.recoveryservicesdatareplication.RecoveryServicesDataReplicationManager manager) {
        manager.protectedItems().plannedFailover("rgrecoveryservicesdatareplication", "4", "d",
            new PlannedFailoverModelInner().withProperties(
                new PlannedFailoverModelProperties().withCustomProperties(new PlannedFailoverModelCustomProperties())),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.recoveryservicesdatareplication import RecoveryServicesDataReplicationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesdatareplication
# USAGE
    python protected_item_planned_failover.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesDataReplicationMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="930CEC23-4430-4513-B855-DBA237E2F3BF",
    )

    response = client.protected_item.begin_planned_failover(
        resource_group_name="rgrecoveryservicesdatareplication",
        vault_name="4",
        protected_item_name="d",
    ).result()
    print(response)


# x-ms-original-file: specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/ProtectedItem_PlannedFailover.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesdatareplication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservicesdatareplication/armrecoveryservicesdatareplication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3066a973f4baf2e2bf072a013b585a820bb10146/specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/ProtectedItem_PlannedFailover.json
func ExampleProtectedItemClient_BeginPlannedFailover() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesdatareplication.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProtectedItemClient().BeginPlannedFailover(ctx, "rgrecoveryservicesdatareplication", "4", "d", &armrecoveryservicesdatareplication.ProtectedItemClientBeginPlannedFailoverOptions{Body: &armrecoveryservicesdatareplication.PlannedFailoverModel{
		Properties: &armrecoveryservicesdatareplication.PlannedFailoverModelProperties{
			CustomProperties: &armrecoveryservicesdatareplication.PlannedFailoverModelCustomProperties{
				InstanceType: to.Ptr("PlannedFailoverModelCustomProperties"),
			},
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PlannedFailoverModel = armrecoveryservicesdatareplication.PlannedFailoverModel{
	// 	Properties: &armrecoveryservicesdatareplication.PlannedFailoverModelProperties{
	// 		CustomProperties: &armrecoveryservicesdatareplication.PlannedFailoverModelCustomProperties{
	// 			InstanceType: to.Ptr("PlannedFailoverModelCustomProperties"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.RecoveryServicesDataReplication.Models;
using Azure.ResourceManager.RecoveryServicesDataReplication;

// Generated from example definition: specification/recoveryservicesdatareplication/resource-manager/Microsoft.DataReplication/preview/2021-02-16-preview/examples/ProtectedItem_PlannedFailover.json
// this example is just showing the usage of "ProtectedItem_PlannedFailover" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataReplicationProtectedItemResource created on azure
// for more information of creating DataReplicationProtectedItemResource, please refer to the document of DataReplicationProtectedItemResource
string subscriptionId = "930CEC23-4430-4513-B855-DBA237E2F3BF";
string resourceGroupName = "rgrecoveryservicesdatareplication";
string vaultName = "4";
string protectedItemName = "d";
ResourceIdentifier dataReplicationProtectedItemResourceId = DataReplicationProtectedItemResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vaultName, protectedItemName);
DataReplicationProtectedItemResource dataReplicationProtectedItem = client.GetDataReplicationProtectedItemResource(dataReplicationProtectedItemResourceId);

// invoke the operation
PlannedFailoverModel body = new PlannedFailoverModel(new PlannedFailoverModelProperties(new GeneralPlannedFailoverModelCustomProperties()));
ArmOperation<PlannedFailoverModel> lro = await dataReplicationProtectedItem.PlannedFailoverAsync(WaitUntil.Completed, body: body);
PlannedFailoverModel result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

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

Código de status:

202

location: https://contoso.com/operationstatus

Definições

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

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HyperVToAzStackHCIPlannedFailoverModelCustomProperties

Objeto

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

Nome	Tipo	Description
instanceType	string: HyperVToAzStackHCI minLength: 1	Obtém ou define o tipo de instância.
shutdownSourceVM	boolean	Obtém ou define um valor que indica se a VM precisa ser desligada.

PlannedFailoverModel

Objeto

Modelo de failover planejado.

Nome	Tipo	Description
properties	PlannedFailoverModelProperties	Propriedades planejadas do modelo de failover.

PlannedFailoverModelProperties

Objeto

Propriedades planejadas do modelo de failover.

Nome	Tipo	Description
customProperties	PlannedFailoverModelCustomProperties: HyperVToAzStackHCIPlannedFailoverModelCustomProperties VMwareToAzStackHCIPlannedFailoverModelCustomProperties	Propriedades personalizadas do modelo de failover planejadas.

VMwareToAzStackHCIPlannedFailoverModelCustomProperties

Objeto

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

Nome	Tipo	Description
instanceType	string: VMwareToAzStackHCI minLength: 1	Obtém ou define o tipo de instância.
shutdownSourceVM	boolean	Obtém ou define um valor que indica se a VM precisa ser desligada.