Migrations - Update

Serviço:

PostgreSQL

Versão da API:

2025-08-01

Atualiza uma migração existente. O corpo da solicitação pode conter uma a muitas das propriedades mutáveis presentes na definição de migração. Determinadas atualizações de propriedade iniciam transições de estado de migração.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
migrationName	path	True	string pattern: ^[a-z][a-z0-9]*$	Nome da migração.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.cancel	Cancel	Indica se o cancelamento deve ser disparado para toda a migração.
properties.dbsToCancelMigrationOn	string[]	Quando você quiser acionar o cancelamento para bancos de dados específicos, defina 'triggerCutover' como 'True' e os nomes dos bancos de dados específicos nessa matriz.
properties.dbsToMigrate	string[]	Nomes de bancos de dados a serem migrados.
properties.dbsToTriggerCutoverOn	string[]	Quando você quiser disparar a substituição para bancos de dados específicos, defina 'triggerCutover' como 'True' e os nomes dos bancos de dados específicos nessa matriz.
properties.migrateRoles	MigrateRolesAndPermissions	Indica se as funções e permissões devem ser migradas.
properties.migrationMode	MigrationMode	Modo utilizado para realizar a migração: Online ou Offline.
properties.migrationWindowStartTimeInUtc	string (date-time)	Hora de início (UTC) para a janela de migração.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Indica se os bancos de dados no servidor de destino podem ser substituídos quando já estiverem presentes. Se definido como 'False', quando o fluxo de trabalho de migração detectar que o banco de dados já existe no servidor de destino, ele aguardará uma confirmação.
properties.secretParameters	MigrationSecretParametersForPatch	Parâmetros de segredo de migração.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Indica se a replicação lógica deve ser configurada no servidor de origem, se necessário.
properties.sourceDbServerFullyQualifiedDomainName	string	Nome de domínio totalmente qualificado (FQDN) ou endereço IP do servidor de origem. Esta propriedade é opcional. Quando fornecido, o serviço de migração sempre o usará para se conectar ao servidor de origem.
properties.sourceDbServerResourceId	string	Identificador do recurso do servidor de banco de dados de origem, quando 'sourceType' é 'PostgreSQLSingleServer'. Para outros tipos de origem, isso deve ser definido como ipaddress:port@username ou hostname:port@username.
properties.startDataMigration	StartDataMigration	Indica se a migração de dados deve começar imediatamente.
properties.targetDbServerFullyQualifiedDomainName	string	Nome de domínio totalmente qualificado (FQDN) ou endereço IP do servidor de destino. Esta propriedade é opcional. Quando fornecido, o serviço de migração sempre o usará para se conectar ao servidor de destino.
properties.triggerCutover	TriggerCutover	Indica se a substituição deve ser disparada para toda a migração.
tags	object	Os metadados específicos a um aplicativo na forma de pares chave-valor.

Respostas

Nome	Tipo	Description
200 OK	Migration	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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

Update an existing migration.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
AdminCredentials	Credenciais de usuários administradores para servidores de origem e destino.
AdminCredentialsForPatch	Credenciais de usuários administradores para servidores de origem e destino.
Cancel	Indica se o cancelamento deve ser disparado para toda a migração.
createdByType	O tipo de identidade que criou o recurso.
DatabaseMigrationState	Estado de migração de um banco de dados.
DbLevelValidationStatus	Resumo do status de validação de um banco de dados.
DbServerMetadata	Metadados do servidor de banco de dados.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LogicalReplicationOnSourceServer	Indica se a replicação lógica deve ser configurada no servidor de origem, se necessário.
MigrateRolesAndPermissions	Indica se as funções e permissões devem ser migradas.
Migration	Propriedades de uma migração.
MigrationDatabaseState	Estado de migração de um banco de dados.
MigrationMode	Modo usado para realizar a migração.
MigrationOption	Opção com suporte para uma migração.
MigrationResourceForPatch	migração.
MigrationSecretParameters	Parâmetros de segredo de migração.
MigrationSecretParametersForPatch	Parâmetros de segredo de migração.
MigrationState	Estado de migração.
MigrationStatus	Estado de migração.
MigrationSubstate	Subestado de migração.
MigrationSubstateDetails	Detalhes do subestado de migração.
OverwriteDatabasesOnTargetServer	Indica se os bancos de dados no servidor de destino podem ser substituídos quando já estiverem presentes.
ServerSku	Compute as informações de um servidor.
SkuTier	Camada da computação atribuída a um servidor.
SourceType	Tipo de servidor de origem usado para a migração.
SslMode	Modo SSL usado por uma migração. O modo SSL padrão para 'PostgreSQLSingleServer' é 'VerifyFull'. O modo SSL padrão para outros tipos de origem é 'Prefer'.
StartDataMigration	Indica se a migração de dados deve começar imediatamente.
systemData	Metadados relativos à criação e última modificação do recurso.
TriggerCutover	Indica se a substituição deve ser disparada para toda a migração.
ValidationDetails	Detalhes da validação para migração.
ValidationMessage	Objeto de mensagem de validação.
ValidationState	Estado de validação para migração.
ValidationSummaryItem	Objeto de resumo de validação.

AdminCredentials

Objeto

Credenciais de usuários administradores para servidores de origem e destino.

Nome	Tipo	Description
sourceServerPassword	string (password)	Senha para o usuário do servidor de origem.
targetServerPassword	string (password)	Senha para o usuário do servidor de destino.

AdminCredentialsForPatch

Objeto

Credenciais de usuários administradores para servidores de origem e destino.

Nome	Tipo	Description
sourceServerPassword	string (password)	Senha para o usuário do servidor de origem.
targetServerPassword	string (password)	Senha para o usuário do servidor de destino.

Cancel

Enumeração

Indica se o cancelamento deve ser disparado para toda a migração.

Valor	Description
True	O cancelamento deve ser disparado para toda a migração.
False	O cancelamento não deve ser acionado para toda a migração.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DatabaseMigrationState

Objeto

Estado de migração de um banco de dados.

Nome	Tipo	Description
appliedChanges	integer (int32)	Contador de alterações aplicado ao Change Data Capture.
cdcDeleteCounter	integer (int32)	Altere o contador de exclusão do Data Capture.
cdcInsertCounter	integer (int32)	Altere o contador de inserção do Data Capture.
cdcUpdateCounter	integer (int32)	Altere o contador de atualizações do Data Capture.
databaseName	string	Nome do banco de dados.
endedOn	string (date-time)	Hora de término de um estado de migração.
fullLoadCompletedTables	integer (int32)	Número de tabelas carregadas durante a migração de um banco de dados.
fullLoadErroredTables	integer (int32)	Número de tabelas que encontram erros durante a migração de um banco de dados.
fullLoadLoadingTables	integer (int32)	Número de tabelas carregadas durante a migração de um banco de dados.
fullLoadQueuedTables	integer (int32)	Número de tabelas enfileiradas para a migração de um banco de dados.
incomingChanges	integer (int32)	Contador de alterações de entrada do Change Data Capture.
latency	integer (int32)	Atraso em segundos entre a origem e o destino durante a fase online.
message	string	Mensagem de erro, se houver, para o estado de migração.
migrationOperation	string	Operação de migração de um banco de dados.
migrationState	MigrationDatabaseState	Estado de migração de um banco de dados.
startedOn	string (date-time)	Hora de início de um estado de migração.

DbLevelValidationStatus

Objeto

Resumo do status de validação de um banco de dados.

Nome	Tipo	Description
databaseName	string	Nome do banco de dados.
endedOn	string (date-time)	Hora de término de uma validação no nível do banco de dados.
startedOn	string (date-time)	Hora de início de uma validação no nível do banco de dados.
summary	ValidationSummaryItem[]	Resumo das validações no nível do banco de dados.

DbServerMetadata

Objeto

Metadados do servidor de banco de dados.

Nome	Tipo	Description
location	string	Localização do servidor de banco de dados.
sku	ServerSku	Camada de computação e tamanho do servidor de banco de dados. Este objeto está vazio para um único servidor do Banco de Dados do Azure para PostgreSQL.
storageMb	integer (int32)	Tamanho do armazenamento (em MB) para o servidor de banco de dados.
version	string	Versão principal do mecanismo de banco de dados PostgreSQL.

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.

LogicalReplicationOnSourceServer

Enumeração

Indica se a replicação lógica deve ser configurada no servidor de origem, se necessário.

Valor	Description
True	A replicação lógica será configurada no servidor de origem.
False	A replicação lógica não será configurada no servidor de origem.

MigrateRolesAndPermissions

Enumeração

Indica se as funções e permissões devem ser migradas.

Valor	Description
True	As funções e permissões serão migradas.
False	Funções e permissões não serão migradas.

Migration

Objeto

Propriedades de uma migração.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.cancel	Cancel	Indica se o cancelamento deve ser disparado para toda a migração.
properties.currentStatus	MigrationStatus	Status atual de uma migração.
properties.dbsToCancelMigrationOn	string[]	Quando você quiser acionar o cancelamento para bancos de dados específicos, defina 'triggerCutover' como 'True' e os nomes dos bancos de dados específicos nessa matriz.
properties.dbsToMigrate	string[]	Nomes de bancos de dados a serem migrados.
properties.dbsToTriggerCutoverOn	string[]	Quando você quiser disparar a substituição para bancos de dados específicos, defina 'triggerCutover' como 'True' e os nomes dos bancos de dados específicos nessa matriz.
properties.migrateRoles	MigrateRolesAndPermissions	Indica se as funções e permissões devem ser migradas.
properties.migrationId	string	Identificador de uma migração.
properties.migrationInstanceResourceId	string (arm-id)	Identificador da instância de migração do ponto de extremidade privado.
properties.migrationMode	MigrationMode	Modo utilizado para realizar a migração: Online ou Offline.
properties.migrationOption	MigrationOption	Opção com suporte para uma migração.
properties.migrationWindowEndTimeInUtc	string (date-time)	Hora de término (UTC) para a janela de migração.
properties.migrationWindowStartTimeInUtc	string (date-time)	Hora de início (UTC) para a janela de migração.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Indica se os bancos de dados no servidor de destino podem ser substituídos quando já estiverem presentes. Se definido como 'False', quando o fluxo de trabalho de migração detectar que o banco de dados já existe no servidor de destino, ele aguardará uma confirmação.
properties.secretParameters	MigrationSecretParameters	Parâmetros de segredo de migração.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Indica se a replicação lógica deve ser configurada no servidor de origem, se necessário.
properties.sourceDbServerFullyQualifiedDomainName	string	Nome de domínio totalmente qualificado (FQDN) ou endereço IP do servidor de origem. Esta propriedade é opcional. Quando fornecido, o serviço de migração sempre o usará para se conectar ao servidor de origem.
properties.sourceDbServerMetadata	DbServerMetadata	Metadados do servidor de banco de dados de origem.
properties.sourceDbServerResourceId	string	Identificador do recurso do servidor de banco de dados de origem, quando 'sourceType' é 'PostgreSQLSingleServer'. Para outros tipos de origem, isso deve ser definido como ipaddress:port@username ou hostname:port@username.
properties.sourceType	SourceType	Tipo de servidor de origem usado para a migração: 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	Modo SSL usado por uma migração. O modo SSL padrão para 'PostgreSQLSingleServer' é 'VerifyFull'. O modo SSL padrão para outros tipos de origem é 'Prefer'.
properties.startDataMigration	StartDataMigration	Indica se a migração de dados deve começar imediatamente.
properties.targetDbServerFullyQualifiedDomainName	string	Nome de domínio totalmente qualificado (FQDN) ou endereço IP do servidor de destino. Esta propriedade é opcional. Quando fornecido, o serviço de migração sempre o usará para se conectar ao servidor de destino.
properties.targetDbServerMetadata	DbServerMetadata	Metadados do servidor de banco de dados de destino.
properties.targetDbServerResourceId	string	Identificador do recurso do servidor de banco de dados de destino.
properties.triggerCutover	TriggerCutover	Indica se a substituição deve ser disparada para toda a migração.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

MigrationDatabaseState

Enumeração

Estado de migração de um banco de dados.

Valor	Description
InProgress	A migração está em andamento para o banco de dados.
WaitingForCutoverTrigger	A migração está aguardando o gatilho de substituição para o banco de dados.
Failed	A migração falhou para o banco de dados.
Canceled	A migração foi cancelada para o banco de dados.
Succeeded	A migração foi bem-sucedida para o banco de dados.
Canceling	A migração do banco de dados está sendo cancelada.

MigrationMode

Enumeração

Modo usado para realizar a migração.

Valor	Description
Offline	Modo de migração offline.
Online	Modo de migração online.

MigrationOption

Enumeração

Opção com suporte para uma migração.

Valor	Description
Validate	Valide a migração sem executá-la.
Migrate	Realize a migração.
ValidateAndMigrate	Valide e execute a migração.

MigrationResourceForPatch

Objeto

migração.

Nome	Tipo	Description
properties.cancel	Cancel	Indica se o cancelamento deve ser disparado para toda a migração.
properties.dbsToCancelMigrationOn	string[]	Quando você quiser acionar o cancelamento para bancos de dados específicos, defina 'triggerCutover' como 'True' e os nomes dos bancos de dados específicos nessa matriz.
properties.dbsToMigrate	string[]	Nomes de bancos de dados a serem migrados.
properties.dbsToTriggerCutoverOn	string[]	Quando você quiser disparar a substituição para bancos de dados específicos, defina 'triggerCutover' como 'True' e os nomes dos bancos de dados específicos nessa matriz.
properties.migrateRoles	MigrateRolesAndPermissions	Indica se as funções e permissões devem ser migradas.
properties.migrationMode	MigrationMode	Modo utilizado para realizar a migração: Online ou Offline.
properties.migrationWindowStartTimeInUtc	string (date-time)	Hora de início (UTC) para a janela de migração.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Indica se os bancos de dados no servidor de destino podem ser substituídos quando já estiverem presentes. Se definido como 'False', quando o fluxo de trabalho de migração detectar que o banco de dados já existe no servidor de destino, ele aguardará uma confirmação.
properties.secretParameters	MigrationSecretParametersForPatch	Parâmetros de segredo de migração.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Indica se a replicação lógica deve ser configurada no servidor de origem, se necessário.
properties.sourceDbServerFullyQualifiedDomainName	string	Nome de domínio totalmente qualificado (FQDN) ou endereço IP do servidor de origem. Esta propriedade é opcional. Quando fornecido, o serviço de migração sempre o usará para se conectar ao servidor de origem.
properties.sourceDbServerResourceId	string	Identificador do recurso do servidor de banco de dados de origem, quando 'sourceType' é 'PostgreSQLSingleServer'. Para outros tipos de origem, isso deve ser definido como ipaddress:port@username ou hostname:port@username.
properties.startDataMigration	StartDataMigration	Indica se a migração de dados deve começar imediatamente.
properties.targetDbServerFullyQualifiedDomainName	string	Nome de domínio totalmente qualificado (FQDN) ou endereço IP do servidor de destino. Esta propriedade é opcional. Quando fornecido, o serviço de migração sempre o usará para se conectar ao servidor de destino.
properties.triggerCutover	TriggerCutover	Indica se a substituição deve ser disparada para toda a migração.
tags	object	Os metadados específicos a um aplicativo na forma de pares chave-valor.

MigrationSecretParameters

Objeto

Parâmetros de segredo de migração.

Nome	Tipo	Description
adminCredentials	AdminCredentials (password)	Credenciais de usuários administradores para servidores de origem e destino.
sourceServerUsername	string	Obtém ou define o nome do usuário para o servidor de origem. Esse usuário não precisa ser um administrador.
targetServerUsername	string	Obtém ou define o nome do usuário para o servidor de destino. Esse usuário não precisa ser um administrador.

MigrationSecretParametersForPatch

Objeto

Parâmetros de segredo de migração.

Nome	Tipo	Description
adminCredentials	AdminCredentialsForPatch (password)	Credenciais de usuários administradores para servidores de origem e destino.
sourceServerUsername	string	Obtém ou define o nome do usuário para o servidor de origem. Esse usuário não precisa ser um administrador.
targetServerUsername	string	Obtém ou define o nome do usuário para o servidor de destino. Esse usuário não precisa ser um administrador.

MigrationState

Enumeração

Estado de migração.

Valor	Description
InProgress	A migração está em andamento.
WaitingForUserAction	A migração está aguardando a ação do usuário.
Canceled	A migração foi cancelada.
Failed	A migração falhou.
Succeeded	A migração foi bem-sucedida.
ValidationFailed	A validação para migração falhou.
CleaningUp	A migração está limpando os recursos.

MigrationStatus

Objeto

Estado de migração.

Nome	Tipo	Description
currentSubStateDetails	MigrationSubstateDetails	Detalhes do subestado de migração atual.
error	string	Mensagem de erro, se houver, para o estado de migração.
state	MigrationState	Estado de migração.

MigrationSubstate

Enumeração

Subestado de migração.

Valor	Description
PerformingPreRequisiteSteps	Executando etapas de pré-requisito para migração.
WaitingForLogicalReplicationSetupRequestOnSourceDB	Aguardando solicitação de configuração de replicação lógica no banco de dados de origem.
WaitingForDBsToMigrateSpecification	Aguardando a migração de especificação dos bancos de dados.
WaitingForTargetDBOverwriteConfirmation	Aguardando confirmação de substituição do banco de dados de destino.
WaitingForDataMigrationScheduling	Aguardando agendamento de migração de dados.
WaitingForDataMigrationWindow	Aguardando a janela de migração de dados.
MigratingData	Migrando dados.
WaitingForCutoverTrigger	Aguardando o gatilho de substituição.
CompletingMigration	Concluindo a migração.
Completed	Migração concluída.
CancelingRequestedDBMigrations	Cancelando migrações de banco de dados solicitadas.
ValidationInProgress	Validação em andamento.

MigrationSubstateDetails

Objeto

Detalhes do subestado de migração.

Nome	Tipo	Description
currentSubState	MigrationSubstate	Subestado de migração.
dbDetails	<string,  DatabaseMigrationState>
validationDetails	ValidationDetails	Detalhes da validação para migração.

OverwriteDatabasesOnTargetServer

Enumeração

Indica se os bancos de dados no servidor de destino podem ser substituídos quando já estiverem presentes.

Valor	Description
True	Os bancos de dados no servidor de destino podem ser substituídos quando já estiverem presentes.
False	Os bancos de dados no servidor de destino não podem ser substituídos quando já estiverem presentes. Quando o fluxo de trabalho de migração detecta que o banco de dados já existe no servidor de destino, ele aguardará uma confirmação.

ServerSku

Objeto

Compute as informações de um servidor.

Nome	Tipo	Description
name	string	Camada de computação e tamanho do servidor de banco de dados. Este objeto está vazio para um único servidor do Banco de Dados do Azure para PostgreSQL.
tier	SkuTier	Camada da computação atribuída a um servidor.

SkuTier

Enumeração

Camada da computação atribuída a um servidor.

Valor	Description
Burstable	Camada econômica para uso pouco frequente da CPU, ideal para cargas de trabalho de desenvolvimento e teste com requisitos de baixo desempenho.
GeneralPurpose	Computação e memória balanceadas para a maioria das cargas de trabalho, oferecendo desempenho escalável e taxa de transferência de E/S.
MemoryOptimized	Alta taxa de memória para núcleo para cargas de trabalho exigentes que precisam de processamento rápido na memória e alta simultaneidade.

SourceType

Enumeração

Tipo de servidor de origem usado para a migração.

Valor	Description
OnPremises	Servidor PostgreSQL local.
AWS	Servidor PostgreSQL da Amazon Web Services.
GCP	Servidor PostgreSQL do Google Cloud Platform.
AzureVM	Azure Virtual Machine PostgreSQL server.
PostgreSQLSingleServer	Banco de Dados do Azure para PostgreSQL single server.
AWS_RDS	Amazon RDS para PostgreSQL.
AWS_AURORA	Amazon Aurora para PostgreSQL.
AWS_EC2	Amazon EC2 para PostgreSQL.
GCP_CloudSQL	Google Cloud SQL para PostgreSQL.
GCP_AlloyDB	Google Cloud AlloyDB para PostgreSQL.
GCP_Compute	Google Compute Engine para PostgreSQL.
EDB	Servidor EnterpriseDB PostgreSQL.
EDB_Oracle_Server	Servidor Oracle EnterpriseDB.
EDB_PostgreSQL	Servidor EnterpriseDB PostgreSQL.
PostgreSQLFlexibleServer	Banco de Dados do Azure para PostgreSQL server flexible.
PostgreSQLCosmosDB	.NET Cosmos DB para PostgreSQL
Huawei_RDS	Huawei RDS para PostgreSQL
Huawei_Compute	Huawei Compute para PostgreSQL
Heroku_PostgreSQL	Heroku PostgreSQL
Crunchy_PostgreSQL	PostgreSQL crocante
ApsaraDB_RDS	ApsaraDB RDS para PostgreSQL
Digital_Ocean_Droplets	Gotículas do oceano digital para PostgreSQL
Digital_Ocean_PostgreSQL	Digital Ocean PostgreSQL
Supabase_PostgreSQL	Supabase PostgreSQL

SslMode

Enumeração

Modo SSL usado por uma migração. O modo SSL padrão para 'PostgreSQLSingleServer' é 'VerifyFull'. O modo SSL padrão para outros tipos de origem é 'Prefer'.

Valor	Description
Prefer	Prefira a conexão SSL. Se o servidor não suportar SSL, a conexão será estabelecida sem SSL.
Require	Requer conexão SSL. Se o servidor não suportar SSL, a conexão falhará.
VerifyCA	Exija conexão SSL e verifique o certificado do servidor em relação ao certificado da autoridade de certificação.
VerifyFull	Exigir conexão SSL, verifique o certificado do servidor em relação ao certificado CA e verifique se o nome do host do servidor corresponde ao certificado.

StartDataMigration

Enumeração

Indica se a migração de dados deve começar imediatamente.

Valor	Description
True	A migração de dados deve começar imediatamente.
False	A migração de dados não deve começar imediatamente.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TriggerCutover

Enumeração

Indica se a substituição deve ser disparada para toda a migração.

Valor	Description
True	A substituição deve ser disparada para toda a migração.
False	A substituição não deve ser acionada para toda a migração.

ValidationDetails

Objeto

Detalhes da validação para migração.

Nome	Tipo	Description
dbLevelValidationDetails	DbLevelValidationStatus[]	Detalhes das validações no nível do servidor.
serverLevelValidationDetails	ValidationSummaryItem[]	Detalhes das validações no nível do servidor.
status	ValidationState	Status de validação para migração.
validationEndTimeInUtc	string (date-time)	Hora de término (UTC) para validação.
validationStartTimeInUtc	string (date-time)	Hora de início (UTC) para validação.

ValidationMessage

Objeto

Objeto de mensagem de validação.

Nome	Tipo	Description
message	string	Cadeia de caracteres de mensagem de validação.
state	ValidationState	Gravidade da mensagem de validação.

ValidationState

Enumeração

Estado de validação para migração.

Valor	Description
Failed	A validação falhou.
Succeeded	A validação foi bem-sucedida.
Warning	A validação foi bem-sucedida com avisos.

ValidationSummaryItem

Objeto

Objeto de resumo de validação.

Nome	Tipo	Description
messages	ValidationMessage[]	Mensagens de validação.
state	ValidationState	Status de validação para migração.
type	string	Tipo de validação.