Migrations - Update

Service:

PostgreSQL

Version d'API:

2025-08-01

Met à jour une migration existante. Le corps de la requête peut contenir une à plusieurs des propriétés mutables présentes dans la définition de migration. Certaines mises à jour de propriétés lancent des transitions d’état de migration.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}?api-version=2025-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
migrationName	path	True	string pattern: ^[a-z][a-z0-9]*$	Nom de la migration.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.cancel	Cancel	Indique si l’annulation doit être déclenchée pour l’ensemble de la migration.
properties.dbsToCancelMigrationOn	string[]	Lorsque vous souhaitez déclencher cancel pour des bases de données spécifiques, définissez 'triggerCutover' sur 'True' et les noms des bases de données spécifiques de ce tableau.
properties.dbsToMigrate	string[]	Noms des bases de données à migrer.
properties.dbsToTriggerCutoverOn	string[]	Lorsque vous souhaitez déclencher le basculement pour des bases de données spécifiques, définissez 'triggerCutover' sur 'True' et les noms des bases de données spécifiques de ce tableau.
properties.migrateRoles	MigrateRolesAndPermissions	Indique si les rôles et les autorisations doivent être migrés.
properties.migrationMode	MigrationMode	Mode utilisé pour effectuer la migration : En ligne ou Hors ligne.
properties.migrationWindowStartTimeInUtc	string (date-time)	Heure de début (UTC) de la fenêtre de migration.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Indique si les bases de données du serveur cible peuvent être écrasées lorsqu’elles sont déjà présentes. Si la valeur est « False », lorsque le workflow de migration détecte que la base de données existe déjà sur le serveur cible, il attend une confirmation.
properties.secretParameters	MigrationSecretParametersForPatch	Paramètres de secret de migration.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Indique s’il faut configurer la réplication logique sur le serveur source, si nécessaire.
properties.sourceDbServerFullyQualifiedDomainName	string	Nom de domaine complet (FQDN) ou adresse IP du serveur source. Cette propriété est facultative. Lorsqu’il est fourni, le service de migration l’utilise toujours pour se connecter au serveur source.
properties.sourceDbServerResourceId	string	Identificateur de la ressource du serveur de base de données source, lorsque 'sourceType' est 'PostgreSQLSingleServer'. Pour les autres types de sources, cela doit être défini sur ipaddress :port@username ou hostname :port@username.
properties.startDataMigration	StartDataMigration	Indique si la migration des données doit commencer immédiatement.
properties.targetDbServerFullyQualifiedDomainName	string	Nom de domaine complet (FQDN) ou adresse IP du serveur cible. Cette propriété est facultative. Lorsqu’il est fourni, le service de migration l’utilise toujours pour se connecter au serveur cible.
properties.triggerCutover	TriggerCutover	Indique si le basculement doit être déclenché pour l’ensemble de la migration.
tags	object	Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

Réponses

Nom	Type	Description
200 OK	Migration	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

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

Update an existing migration.

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/migrations/examplemigration?api-version=2025-08-01

{
  "properties": {
    "setupLogicalReplicationOnSourceDbIfNeeded": "True"
  }
}

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.LogicalReplicationOnSourceServer;
import com.azure.resourcemanager.postgresqlflexibleserver.models.Migration;

/**
 * Samples for Migrations Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.
     * json
     */
    /**
     * Sample code: Update an existing migration.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        updateAnExistingMigration(com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        Migration resource = manager.migrations().getWithResponse("exampleresourcegroup", "exampleserver",
            "examplemigration", com.azure.core.util.Context.NONE).getValue();
        resource.update().withSetupLogicalReplicationOnSourceDbIfNeeded(LogicalReplicationOnSourceServer.TRUE).apply();
    }
}

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.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python migrations_update.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 = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.migrations.update(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        migration_name="examplemigration",
        parameters={"properties": {"setupLogicalReplicationOnSourceDbIfNeeded": "True"}},
    )
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.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 armpostgresqlflexibleservers_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/postgresql/armpostgresqlflexibleservers/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e96c24570a484cff13d153fb472f812878866a39/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.json
func ExampleMigrationsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMigrationsClient().Update(ctx, "exampleresourcegroup", "exampleserver", "examplemigration", armpostgresqlflexibleservers.MigrationResourceForPatch{
		Properties: &armpostgresqlflexibleservers.MigrationPropertiesForPatch{
			SetupLogicalReplicationOnSourceDbIfNeeded: to.Ptr(armpostgresqlflexibleservers.LogicalReplicationOnSourceServerTrue),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.Migration = armpostgresqlflexibleservers.Migration{
	// 	Name: to.Ptr("examplemigration"),
	// 	Type: to.Ptr("Microsoft.DBForPostgreSql/flexibleServers/migrations"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget/migrations/examplemigration"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armpostgresqlflexibleservers.MigrationProperties{
	// 		CurrentStatus: &armpostgresqlflexibleservers.MigrationStatus{
	// 			CurrentSubStateDetails: &armpostgresqlflexibleservers.MigrationSubstateDetails{
	// 				CurrentSubState: to.Ptr(armpostgresqlflexibleservers.MigrationSubstatePerformingPreRequisiteSteps),
	// 			},
	// 			Error: to.Ptr(""),
	// 			State: to.Ptr(armpostgresqlflexibleservers.MigrationStateInProgress),
	// 		},
	// 		DbsToMigrate: []*string{
	// 			to.Ptr("exampledatabase1"),
	// 			to.Ptr("exampledatabase2"),
	// 			to.Ptr("exampledatabase3"),
	// 			to.Ptr("exampledatabase4")},
	// 			MigrateRoles: to.Ptr(armpostgresqlflexibleservers.MigrateRolesAndPermissionsFalse),
	// 			MigrationID: to.Ptr("d3ceacbb-a5fd-43dc-a9db-6022b5154856"),
	// 			MigrationWindowStartTimeInUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2025-06-01T20:30:22.123Z"); return t}()),
	// 			OverwriteDbsInTarget: to.Ptr(armpostgresqlflexibleservers.OverwriteDatabasesOnTargetServerFalse),
	// 			SetupLogicalReplicationOnSourceDbIfNeeded: to.Ptr(armpostgresqlflexibleservers.LogicalReplicationOnSourceServerTrue),
	// 			SourceDbServerMetadata: &armpostgresqlflexibleservers.DbServerMetadata{
	// 				Location: to.Ptr("eastus"),
	// 				SKU: &armpostgresqlflexibleservers.ServerSKU{
	// 					Name: to.Ptr("B_Gen5_2"),
	// 					Tier: to.Ptr(armpostgresqlflexibleservers.SKUTier("Basic")),
	// 				},
	// 				StorageMb: to.Ptr[int32](1024),
	// 				Version: to.Ptr("10"),
	// 			},
	// 			SourceDbServerResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/servers/examplesource"),
	// 			StartDataMigration: to.Ptr(armpostgresqlflexibleservers.StartDataMigrationFalse),
	// 			TargetDbServerMetadata: &armpostgresqlflexibleservers.DbServerMetadata{
	// 				Location: to.Ptr("eastus"),
	// 				SKU: &armpostgresqlflexibleservers.ServerSKU{
	// 					Name: to.Ptr("Standard_D4ds_v5"),
	// 					Tier: to.Ptr(armpostgresqlflexibleservers.SKUTierGeneralPurpose),
	// 				},
	// 				StorageMb: to.Ptr[int32](2048),
	// 				Version: to.Ptr("17"),
	// 			},
	// 			TargetDbServerResourceID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget"),
	// 			TriggerCutover: to.Ptr(armpostgresqlflexibleservers.TriggerCutoverFalse),
	// 		},
	// 	}
}

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

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.
 *
 * @summary Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.json
 */
async function updateAnExistingMigration() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "exampleresourcegroup";
  const serverName = "exampleserver";
  const migrationName = "examplemigration";
  const parameters = {
    setupLogicalReplicationOnSourceDbIfNeeded: "True",
  };
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.migrations.update(
    resourceGroupName,
    serverName,
    migrationName,
    parameters,
  );
  console.log(result);
}

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.PostgreSql.FlexibleServers.Models;
using Azure.ResourceManager.PostgreSql.FlexibleServers;

// Generated from example definition: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/examples/MigrationsUpdate.json
// this example is just showing the usage of "Migrations_Update" 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 PostgreSqlMigrationResource created on azure
// for more information of creating PostgreSqlMigrationResource, please refer to the document of PostgreSqlMigrationResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "exampleresourcegroup";
string serverName = "exampleserver";
string migrationName = "examplemigration";
ResourceIdentifier postgreSqlMigrationResourceId = PostgreSqlMigrationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, migrationName);
PostgreSqlMigrationResource postgreSqlMigration = client.GetPostgreSqlMigrationResource(postgreSqlMigrationResourceId);

// invoke the operation
PostgreSqlMigrationPatch patch = new PostgreSqlMigrationPatch
{
    SetupLogicalReplicationOnSourceDbIfNeeded = PostgreSqlMigrationLogicalReplicationOnSourceDb.True,
};
PostgreSqlMigrationResource result = await postgreSqlMigration.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PostgreSqlMigrationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:

200

{
  "name": "examplemigration",
  "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget/migrations/examplemigration",
  "location": "eastus",
  "properties": {
    "currentStatus": {
      "currentSubStateDetails": {
        "currentSubState": "PerformingPreRequisiteSteps"
      },
      "error": "",
      "state": "InProgress"
    },
    "dbsToMigrate": [
      "exampledatabase1",
      "exampledatabase2",
      "exampledatabase3",
      "exampledatabase4"
    ],
    "migrateRoles": "False",
    "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856",
    "migrationWindowStartTimeInUtc": "2025-06-01T20:30:22.123456Z",
    "overwriteDbsInTarget": "False",
    "setupLogicalReplicationOnSourceDbIfNeeded": "True",
    "sourceDbServerMetadata": {
      "location": "eastus",
      "sku": {
        "name": "B_Gen5_2",
        "tier": "Basic"
      },
      "storageMb": 1024,
      "version": "10"
    },
    "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/servers/examplesource",
    "startDataMigration": "False",
    "targetDbServerMetadata": {
      "location": "eastus",
      "sku": {
        "name": "Standard_D4ds_v5",
        "tier": "GeneralPurpose"
      },
      "storageMb": 2048,
      "version": "17"
    },
    "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBForPostgreSql/flexibleServers/exampletarget",
    "triggerCutover": "False"
  }
}

Définitions

Nom	Description
AdminCredentials	Informations d’identification des utilisateurs administrateurs pour les serveurs source et cible.
AdminCredentialsForPatch	Informations d’identification des utilisateurs administrateurs pour les serveurs source et cible.
Cancel	Indique si l’annulation doit être déclenchée pour l’ensemble de la migration.
createdByType	Type d’identité qui a créé la ressource.
DatabaseMigrationState	État de migration d’une base de données.
DbLevelValidationStatus	Résumé de l’état de validation d’une base de données.
DbServerMetadata	Métadonnées du serveur de base de données.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LogicalReplicationOnSourceServer	Indique s’il faut configurer la réplication logique sur le serveur source, si nécessaire.
MigrateRolesAndPermissions	Indique si les rôles et les autorisations doivent être migrés.
Migration	Propriétés d’une migration.
MigrationDatabaseState	État de migration d’une base de données.
MigrationMode	Mode utilisé pour effectuer la migration : En ligne ou Hors ligne.
MigrationOption	Option prise en charge pour une migration
MigrationResourceForPatch	Migration.
MigrationSecretParameters	Paramètres de secret de migration.
MigrationSecretParametersForPatch	Paramètres de secret de migration.
MigrationState	État des migrations.
MigrationStatus	État des migrations.
MigrationSubstate	Sous-état de migration.
MigrationSubstateDetails	Détails du sous-état de migration.
OverwriteDatabasesOnTargetServer	Indique si les bases de données du serveur cible peuvent être écrasées lorsqu’elles sont déjà présentes. Si la valeur est « False », lorsque le workflow de migration détecte que la base de données existe déjà sur le serveur cible, il attend une confirmation.
ServerSku	Calculez les informations d’un serveur.
SkuTier	Niveau du calcul attribué à un serveur.
SourceType	Type de serveur source utilisé pour la migration : ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer ou Supabase_PostgreSQL
SslMode	Mode SSL utilisé par une migration. Le mode SSL par défaut pour 'PostgreSQLSingleServer' est 'VerifyFull'. Le mode SSL par défaut pour les autres types de sources est « Préférer ».
StartDataMigration	Indique si la migration des données doit commencer immédiatement.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TriggerCutover	Indique si le basculement doit être déclenché pour l’ensemble de la migration.
ValidationDetails	Détails de la validation de la migration.
ValidationMessage	Objet de message de validation.
ValidationState	Statut de validation de la migration.
ValidationSummaryItem	Objet de résumé de validation.

AdminCredentials

Objet

Informations d’identification des utilisateurs administrateurs pour les serveurs source et cible.

Nom	Type	Description
sourceServerPassword	string (password)	Mot de passe de l’utilisateur du serveur source.
targetServerPassword	string (password)	Mot de passe de l’utilisateur du serveur cible.

AdminCredentialsForPatch

Objet

Informations d’identification des utilisateurs administrateurs pour les serveurs source et cible.

Nom	Type	Description
sourceServerPassword	string (password)	Mot de passe de l’utilisateur du serveur source.
targetServerPassword	string (password)	Mot de passe de l’utilisateur du serveur cible.

Cancel

Énumération

Indique si l’annulation doit être déclenchée pour l’ensemble de la migration.

Valeur	Description
True
False

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DatabaseMigrationState

Objet

État de migration d’une base de données.

Nom	Type	Description
appliedChanges	integer (int32)	La capture des données de modification a appliqué le compteur de modifications.
cdcDeleteCounter	integer (int32)	Modifier la capture des données Supprimer le compteur.
cdcInsertCounter	integer (int32)	Modifier le compteur d’encarts de la capture des données.
cdcUpdateCounter	integer (int32)	Modifier le compteur de mise à jour de la capture des données.
databaseName	string	Nom de base de données.
endedOn	string (date-time)	Heure de fin d’un état de migration.
fullLoadCompletedTables	integer (int32)	Nombre de tables chargées lors de la migration d’une base de données.
fullLoadErroredTables	integer (int32)	Nombre de tables rencontrant des erreurs lors de la migration d’une base de données.
fullLoadLoadingTables	integer (int32)	Nombre de tables chargées lors de la migration d’une base de données.
fullLoadQueuedTables	integer (int32)	Nombre de tables mises en file d’attente pour la migration d’une base de données.
incomingChanges	integer (int32)	Compteur de modifications Capture des modifications entrantes.
latency	integer (int32)	Décalage en secondes entre la source et la cible pendant la phase en ligne.
message	string	Message d’erreur, le cas contraire, pour l’état de migration.
migrationOperation	string	Opération de migration d’une base de données.
migrationState	MigrationDatabaseState	État de migration d’une base de données.
startedOn	string (date-time)	Heure de début d’un état de migration.

DbLevelValidationStatus

Objet

Résumé de l’état de validation d’une base de données.

Nom	Type	Description
databaseName	string	Nom de base de données.
endedOn	string (date-time)	Heure de fin d’une validation au niveau de la base de données.
startedOn	string (date-time)	Heure de début d’une validation au niveau de la base de données.
summary	ValidationSummaryItem[]	Résumé des validations au niveau de la base de données.

DbServerMetadata

Objet

Métadonnées du serveur de base de données.

Nom	Type	Description
location	string	Emplacement du serveur de base de données.
sku	ServerSku	Niveau de calcul et taille du serveur de base de données. Cet objet est vide pour un serveur unique Azure Database pour PostgreSQL.
storageMb	integer (int32)	Taille de stockage (en Mo) du serveur de base de données.
version	string	Version majeure du moteur de base de données PostgreSQL.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

LogicalReplicationOnSourceServer

Énumération

Indique s’il faut configurer la réplication logique sur le serveur source, si nécessaire.

Valeur	Description
True
False

MigrateRolesAndPermissions

Énumération

Indique si les rôles et les autorisations doivent être migrés.

Valeur	Description
True
False

Migration

Objet

Propriétés d’une migration.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.cancel	Cancel	Indique si l’annulation doit être déclenchée pour l’ensemble de la migration.
properties.currentStatus	MigrationStatus	Statut actuel d’une migration.
properties.dbsToCancelMigrationOn	string[]	Lorsque vous souhaitez déclencher cancel pour des bases de données spécifiques, définissez 'triggerCutover' sur 'True' et les noms des bases de données spécifiques de ce tableau.
properties.dbsToMigrate	string[]	Noms des bases de données à migrer.
properties.dbsToTriggerCutoverOn	string[]	Lorsque vous souhaitez déclencher le basculement pour des bases de données spécifiques, définissez 'triggerCutover' sur 'True' et les noms des bases de données spécifiques de ce tableau.
properties.migrateRoles	MigrateRolesAndPermissions	Indique si les rôles et les autorisations doivent être migrés.
properties.migrationId	string	Identifiant d’une migration.
properties.migrationInstanceResourceId	string (arm-id)	Identificateur de l’instance de migration de point de terminaison privé.
properties.migrationMode	MigrationMode	Mode utilisé pour effectuer la migration : En ligne ou Hors ligne.
properties.migrationOption	MigrationOption	Option prise en charge pour une migration.
properties.migrationWindowEndTimeInUtc	string (date-time)	Heure de fin (UTC) de la fenêtre de migration.
properties.migrationWindowStartTimeInUtc	string (date-time)	Heure de début (UTC) de la fenêtre de migration.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Indique si les bases de données du serveur cible peuvent être écrasées lorsqu’elles sont déjà présentes. Si la valeur est « False », lorsque le workflow de migration détecte que la base de données existe déjà sur le serveur cible, il attend une confirmation.
properties.secretParameters	MigrationSecretParameters	Paramètres de secret de migration.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Indique s’il faut configurer la réplication logique sur le serveur source, si nécessaire.
properties.sourceDbServerFullyQualifiedDomainName	string	Nom de domaine complet (FQDN) ou adresse IP du serveur source. Cette propriété est facultative. Lorsqu’il est fourni, le service de migration l’utilise toujours pour se connecter au serveur source.
properties.sourceDbServerMetadata	DbServerMetadata	Métadonnées du serveur de base de données source.
properties.sourceDbServerResourceId	string	Identificateur de la ressource du serveur de base de données source, lorsque 'sourceType' est 'PostgreSQLSingleServer'. Pour les autres types de sources, cela doit être défini sur ipaddress :port@username ou hostname :port@username.
properties.sourceType	SourceType	Type de serveur source utilisé pour la migration : ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer ou Supabase_PostgreSQL
properties.sslMode	SslMode	Mode SSL utilisé par une migration. Le mode SSL par défaut pour 'PostgreSQLSingleServer' est 'VerifyFull'. Le mode SSL par défaut pour les autres types de sources est « Préférer ».
properties.startDataMigration	StartDataMigration	Indique si la migration des données doit commencer immédiatement.
properties.targetDbServerFullyQualifiedDomainName	string	Nom de domaine complet (FQDN) ou adresse IP du serveur cible. Cette propriété est facultative. Lorsqu’il est fourni, le service de migration l’utilise toujours pour se connecter au serveur cible.
properties.targetDbServerMetadata	DbServerMetadata	Métadonnées du serveur de base de données cible.
properties.targetDbServerResourceId	string	Identificateur de la ressource du serveur de base de données cible.
properties.triggerCutover	TriggerCutover	Indique si le basculement doit être déclenché pour l’ensemble de la migration.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

MigrationDatabaseState

Énumération

État de migration d’une base de données.

Valeur	Description
InProgress
WaitingForCutoverTrigger
Failed
Canceled
Succeeded
Canceling

MigrationMode

Énumération

Mode utilisé pour effectuer la migration : En ligne ou Hors ligne.

Valeur	Description
Offline
Online

MigrationOption

Énumération

Option prise en charge pour une migration

Valeur	Description
Validate
Migrate
ValidateAndMigrate

MigrationResourceForPatch

Objet

Migration.

Nom	Type	Description
properties.cancel	Cancel	Indique si l’annulation doit être déclenchée pour l’ensemble de la migration.
properties.dbsToCancelMigrationOn	string[]	Lorsque vous souhaitez déclencher cancel pour des bases de données spécifiques, définissez 'triggerCutover' sur 'True' et les noms des bases de données spécifiques de ce tableau.
properties.dbsToMigrate	string[]	Noms des bases de données à migrer.
properties.dbsToTriggerCutoverOn	string[]	Lorsque vous souhaitez déclencher le basculement pour des bases de données spécifiques, définissez 'triggerCutover' sur 'True' et les noms des bases de données spécifiques de ce tableau.
properties.migrateRoles	MigrateRolesAndPermissions	Indique si les rôles et les autorisations doivent être migrés.
properties.migrationMode	MigrationMode	Mode utilisé pour effectuer la migration : En ligne ou Hors ligne.
properties.migrationWindowStartTimeInUtc	string (date-time)	Heure de début (UTC) de la fenêtre de migration.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Indique si les bases de données du serveur cible peuvent être écrasées lorsqu’elles sont déjà présentes. Si la valeur est « False », lorsque le workflow de migration détecte que la base de données existe déjà sur le serveur cible, il attend une confirmation.
properties.secretParameters	MigrationSecretParametersForPatch	Paramètres de secret de migration.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Indique s’il faut configurer la réplication logique sur le serveur source, si nécessaire.
properties.sourceDbServerFullyQualifiedDomainName	string	Nom de domaine complet (FQDN) ou adresse IP du serveur source. Cette propriété est facultative. Lorsqu’il est fourni, le service de migration l’utilise toujours pour se connecter au serveur source.
properties.sourceDbServerResourceId	string	Identificateur de la ressource du serveur de base de données source, lorsque 'sourceType' est 'PostgreSQLSingleServer'. Pour les autres types de sources, cela doit être défini sur ipaddress :port@username ou hostname :port@username.
properties.startDataMigration	StartDataMigration	Indique si la migration des données doit commencer immédiatement.
properties.targetDbServerFullyQualifiedDomainName	string	Nom de domaine complet (FQDN) ou adresse IP du serveur cible. Cette propriété est facultative. Lorsqu’il est fourni, le service de migration l’utilise toujours pour se connecter au serveur cible.
properties.triggerCutover	TriggerCutover	Indique si le basculement doit être déclenché pour l’ensemble de la migration.
tags	object	Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

MigrationSecretParameters

Objet

Paramètres de secret de migration.

Nom	Type	Description
adminCredentials	AdminCredentials (password)	Informations d’identification des utilisateurs administrateurs pour les serveurs source et cible.
sourceServerUsername	string	Obtient ou définit le nom de l’utilisateur du serveur source. Cet utilisateur n’a pas besoin d’être un administrateur.
targetServerUsername	string	Obtient ou définit le nom de l’utilisateur du serveur cible. Cet utilisateur n’a pas besoin d’être un administrateur.

MigrationSecretParametersForPatch

Objet

Paramètres de secret de migration.

Nom	Type	Description
adminCredentials	AdminCredentialsForPatch (password)	Informations d’identification des utilisateurs administrateurs pour les serveurs source et cible.
sourceServerUsername	string	Obtient ou définit le nom de l’utilisateur du serveur source. Cet utilisateur n’a pas besoin d’être un administrateur.
targetServerUsername	string	Obtient ou définit le nom de l’utilisateur du serveur cible. Cet utilisateur n’a pas besoin d’être un administrateur.

MigrationState

Énumération

État des migrations.

Valeur	Description
InProgress
WaitingForUserAction
Canceled
Failed
Succeeded
ValidationFailed
CleaningUp

MigrationStatus

Objet

État des migrations.

Nom	Type	Description
currentSubStateDetails	MigrationSubstateDetails	Détails du sous-état de migration actuel.
error	string	Message d’erreur, le cas contraire, pour l’état de migration.
state	MigrationState	État des migrations.

MigrationSubstate

Énumération

Sous-état de migration.

Valeur	Description
PerformingPreRequisiteSteps
WaitingForLogicalReplicationSetupRequestOnSourceDB
WaitingForDBsToMigrateSpecification
WaitingForTargetDBOverwriteConfirmation
WaitingForDataMigrationScheduling
WaitingForDataMigrationWindow
MigratingData
WaitingForCutoverTrigger
CompletingMigration
Completed
CancelingRequestedDBMigrations
ValidationInProgress

MigrationSubstateDetails

Objet

Détails du sous-état de migration.

Nom	Type	Description
currentSubState	MigrationSubstate	Sous-état de migration.
dbDetails	<string,  DatabaseMigrationState>
validationDetails	ValidationDetails	Détails de la validation de la migration.

OverwriteDatabasesOnTargetServer

Énumération

Indique si les bases de données du serveur cible peuvent être écrasées lorsqu’elles sont déjà présentes. Si la valeur est « False », lorsque le workflow de migration détecte que la base de données existe déjà sur le serveur cible, il attend une confirmation.

Valeur	Description
True
False

ServerSku

Objet

Calculez les informations d’un serveur.

Nom	Type	Description
name	string	Niveau de calcul et taille du serveur de base de données. Cet objet est vide pour un serveur unique Azure Database pour PostgreSQL.
tier	SkuTier	Niveau du calcul attribué à un serveur.

SkuTier

Énumération

Niveau du calcul attribué à un serveur.

Valeur	Description
Burstable
GeneralPurpose
MemoryOptimized

SourceType

Énumération

Type de serveur source utilisé pour la migration : ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer ou Supabase_PostgreSQL

Valeur	Description
OnPremises
AWS
GCP
AzureVM
PostgreSQLSingleServer
AWS_RDS
AWS_AURORA
AWS_EC2
GCP_CloudSQL
GCP_AlloyDB
GCP_Compute
EDB
EDB_Oracle_Server
EDB_PostgreSQL
PostgreSQLFlexibleServer
PostgreSQLCosmosDB
Huawei_RDS
Huawei_Compute
Heroku_PostgreSQL
Crunchy_PostgreSQL
ApsaraDB_RDS
Digital_Ocean_Droplets
Digital_Ocean_PostgreSQL
Supabase_PostgreSQL

SslMode

Énumération

Mode SSL utilisé par une migration. Le mode SSL par défaut pour 'PostgreSQLSingleServer' est 'VerifyFull'. Le mode SSL par défaut pour les autres types de sources est « Préférer ».

Valeur	Description
Prefer
Require
VerifyCA
VerifyFull

StartDataMigration

Énumération

Indique si la migration des données doit commencer immédiatement.

Valeur	Description
True
False

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TriggerCutover

Énumération

Indique si le basculement doit être déclenché pour l’ensemble de la migration.

Valeur	Description
True
False

ValidationDetails

Objet

Détails de la validation de la migration.

Nom	Type	Description
dbLevelValidationDetails	DbLevelValidationStatus[]	Détails des validations au niveau du serveur.
serverLevelValidationDetails	ValidationSummaryItem[]	Détails des validations au niveau du serveur.
status	ValidationState	Statut de validation de la migration.
validationEndTimeInUtc	string (date-time)	Heure de fin (UTC) pour la validation.
validationStartTimeInUtc	string (date-time)	Heure de début (UTC) de la validation.

ValidationMessage

Objet

Objet de message de validation.

Nom	Type	Description
message	string	Chaîne de message de validation.
state	ValidationState	Gravité du message de validation.

ValidationState

Énumération

Statut de validation de la migration.

Valeur	Description
Failed
Succeeded
Warning

ValidationSummaryItem

Objet

Objet de résumé de validation.

Nom	Type	Description
messages	ValidationMessage[]	Messages de validation.
state	ValidationState	Statut de validation de la migration.
type	string	Type de validation.