Protected Item - Planned Failover

Dienst:

Data Replication

API-Version:

2021-02-16-preview

Führt geplantes Failover aus.
Führt das geplante Failover für das geschützte Element aus.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/plannedFailover?api-version=2021-02-16-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
protectedItemName	path	True	string pattern: ^[a-zA-Z0-9]*$	Der Name des geschützten Elements.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
vaultName	path	True	string pattern: ^[a-zA-Z0-9]*$	Der Tresorname.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties	True	PlannedFailoverModelProperties	Geplante Failovermodelleigenschaften.

Antworten

Name	Typ	Beschreibung
200 OK	PlannedFailoverModel	Erfolg
202 Accepted		Angenommen Header Azure-AsyncOperation: string Location: string
Other Status Codes	ErrorResponse	Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ProtectedItem_PlannedFailover

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Statuscode:

202

location: https://contoso.com/operationstatus

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HyperVToAzStackHCIPlannedFailoverModelCustomProperties	HyperV zu AzStackHCI geplante benutzerdefinierte Failovermodelleigenschaften.
PlannedFailoverModel	Geplantes Failovermodell.
PlannedFailoverModelProperties	Geplante Failovermodelleigenschaften.
VMwareToAzStackHCIPlannedFailoverModelCustomProperties	VMware to AzStackHCI plante benutzerdefinierte Failovermodelleigenschaften.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HyperVToAzStackHCIPlannedFailoverModelCustomProperties

Objekt

HyperV zu AzStackHCI geplante benutzerdefinierte Failovermodelleigenschaften.

Name	Typ	Beschreibung
instanceType	string: HyperVToAzStackHCI minLength: 1	Ruft den Instanztyp ab oder legt diesen fest.
shutdownSourceVM	boolean	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der virtuelle Computer heruntergefahren werden muss.

PlannedFailoverModel

Objekt

Geplantes Failovermodell.

Name	Typ	Beschreibung
properties	PlannedFailoverModelProperties	Geplante Failovermodelleigenschaften.

PlannedFailoverModelProperties

Objekt

Geplante Failovermodelleigenschaften.

Name	Typ	Beschreibung
customProperties	PlannedFailoverModelCustomProperties: HyperVToAzStackHCIPlannedFailoverModelCustomProperties VMwareToAzStackHCIPlannedFailoverModelCustomProperties	Geplante benutzerdefinierte Failovermodelleigenschaften.

VMwareToAzStackHCIPlannedFailoverModelCustomProperties

Objekt

VMware to AzStackHCI plante benutzerdefinierte Failovermodelleigenschaften.

Name	Typ	Beschreibung
instanceType	string: VMwareToAzStackHCI minLength: 1	Ruft den Instanztyp ab oder legt diesen fest.
shutdownSourceVM	boolean	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der virtuelle Computer heruntergefahren werden muss.