Migrations - Update

Service:

PostgreSQL

API-versie:

2025-08-01

Hiermee wordt een bestaande migratie bijgewerkt. De hoofdtekst van de aanvraag kan één tot veel van de onveranderbare eigenschappen bevatten die aanwezig zijn in de migratiedefinitie. Bepaalde eigenschappenupdates initiëren migratiestatusovergangen.

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

URI-parameters

Name	In	Vereist	Type	Description
migrationName	path	True	string pattern: ^[a-z][a-z0-9]*$	Naam van de migratie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	De naam van de server.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.cancel	Cancel	Geeft aan of annuleren moet worden geactiveerd voor de gehele migratie.
properties.dbsToCancelMigrationOn	string[]	Wanneer u annuleren wilt activeren voor specifieke databases, stelt u 'triggerCutover' in op 'True' en de namen van de specifieke databases in deze array.
properties.dbsToMigrate	string[]	Namen van databases die moeten worden gemigreerd.
properties.dbsToTriggerCutoverOn	string[]	Wanneer u de cutover voor specifieke databases wilt activeren, stelt u 'triggerCutover' in op 'True' en de namen van de specifieke databases in deze array.
properties.migrateRoles	MigrateRolesAndPermissions	Geeft aan of rollen en machtigingen moeten worden gemigreerd.
properties.migrationMode	MigrationMode	Modus die wordt gebruikt om de migratie uit te voeren: Online of Offline.
properties.migrationWindowStartTimeInUtc	string (date-time)	Begintijd (UTC) voor migratievenster.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Geeft aan of databases op de doelserver kunnen worden overschreven wanneer deze al aanwezig zijn. Als deze optie is ingesteld op 'Onwaar', wacht de migratiewerkstroom op een bevestiging wanneer deze detecteert dat de database al bestaat op de doelserver.
properties.secretParameters	MigrationSecretParametersForPatch	Parameters voor migratiegeheim.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Geeft aan of logische replicatie op de bronserver moet worden ingesteld, indien nodig.
properties.sourceDbServerFullyQualifiedDomainName	string	Fully qualified domain name (FQDN) of IP-adres van de bronserver. Deze eigenschap is optioneel. Indien aanwezig, zal de migratieservice deze altijd gebruiken om verbinding te maken met de bronserver.
properties.sourceDbServerResourceId	string	Id van de brondatabaseserverbron, wanneer 'sourceType' 'PostgreSQLSingleServer' is. Voor andere brontypen moet dit worden ingesteld op ipaddress:port@username of hostname:port@username.
properties.startDataMigration	StartDataMigration	Geeft aan of de datamigratie direct moet beginnen.
properties.targetDbServerFullyQualifiedDomainName	string	Fully qualified domain name (FQDN) of IP-adres van de doelserver. Deze eigenschap is optioneel. Indien aanwezig, zal de migratieservice deze altijd gebruiken om verbinding te maken met de doelserver.
properties.triggerCutover	TriggerCutover	Geeft aan of de cutover moet worden geactiveerd voor de gehele migratie.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

Antwoorden

Name	Type	Description
200 OK	Migration	Azure-operatie succesvol voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update an existing migration.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AdminCredentials	Referenties van beheerdersgebruikers voor bron- en doelservers.
AdminCredentialsForPatch	Referenties van beheerdersgebruikers voor bron- en doelservers.
Cancel	Geeft aan of annuleren moet worden geactiveerd voor de gehele migratie.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DatabaseMigrationState	Migratiestatus van een database.
DbLevelValidationStatus	Samenvatting van de validatiestatus voor een database.
DbServerMetadata	Metagegevens van databaseserver.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
LogicalReplicationOnSourceServer	Geeft aan of logische replicatie op de bronserver moet worden ingesteld, indien nodig.
MigrateRolesAndPermissions	Geeft aan of rollen en machtigingen moeten worden gemigreerd.
Migration	Eigenschappen van een migratie.
MigrationDatabaseState	Migratiestatus van een database.
MigrationMode	Modus die wordt gebruikt om de migratie uit te voeren.
MigrationOption	Ondersteunde optie voor een migratie.
MigrationResourceForPatch	Migration.
MigrationSecretParameters	Parameters voor migratiegeheim.
MigrationSecretParametersForPatch	Parameters voor migratiegeheim.
MigrationState	Staat van migratie.
MigrationStatus	Staat van migratie.
MigrationSubstate	Substaat van migratie.
MigrationSubstateDetails	Details van de migratiesubstaat.
OverwriteDatabasesOnTargetServer	Geeft aan of databases op de doelserver kunnen worden overschreven wanneer deze al aanwezig zijn.
ServerSku	Bereken informatie van een server.
SkuTier	Laag van de rekenkracht die aan een server is toegewezen.
SourceType	Bronservertype dat voor de migratie wordt gebruikt.
SslMode	SSL-modus die wordt gebruikt door een migratie. De standaard SSL-modus voor 'PostgreSQLSingleServer' is 'VerifyFull'. De standaard SSL-modus voor andere brontypen is 'Voorkeur'.
StartDataMigration	Geeft aan of de datamigratie direct moet beginnen.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TriggerCutover	Geeft aan of de cutover moet worden geactiveerd voor de gehele migratie.
ValidationDetails	Details voor de validatie voor migratie.
ValidationMessage	Object validatiebericht.
ValidationState	Validatiestaat voor migratie.
ValidationSummaryItem	Object met validatiesamenvatting.

AdminCredentials

Object

Referenties van beheerdersgebruikers voor bron- en doelservers.

Name	Type	Description
sourceServerPassword	string (password)	Wachtwoord voor de gebruiker van de bronserver.
targetServerPassword	string (password)	Wachtwoord voor de gebruiker van de doelserver.

AdminCredentialsForPatch

Object

Referenties van beheerdersgebruikers voor bron- en doelservers.

Name	Type	Description
sourceServerPassword	string (password)	Wachtwoord voor de gebruiker van de bronserver.
targetServerPassword	string (password)	Wachtwoord voor de gebruiker van de doelserver.

Cancel

Opsomming

Geeft aan of annuleren moet worden geactiveerd voor de gehele migratie.

Waarde	Description
True	Annuleren moet worden geactiveerd voor de gehele migratie.
False	Annuleren mag niet voor de hele migratie worden geactiveerd.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DatabaseMigrationState

Object

Migratiestatus van een database.

Name	Type	Description
appliedChanges	integer (int32)	Teller voor het vastleggen van gegevens voor het vastleggen van toegepaste wijzigingen.
cdcDeleteCounter	integer (int32)	Wijzig de deleteteller voor het vastleggen van gegevens.
cdcInsertCounter	integer (int32)	Wijzig de invoegteller voor Data Capture.
cdcUpdateCounter	integer (int32)	Wijzig de updateteller voor het vastleggen van gegevens.
databaseName	string	Naam van database.
endedOn	string (date-time)	Eindtijd van een migratiestatus.
fullLoadCompletedTables	integer (int32)	Aantal tabellen dat tijdens de migratie van een database wordt geladen.
fullLoadErroredTables	integer (int32)	Aantal tabellen dat fouten ondervindt tijdens de migratie van een database.
fullLoadLoadingTables	integer (int32)	Aantal tabellen dat wordt geladen tijdens de migratie van een database.
fullLoadQueuedTables	integer (int32)	Aantal tabellen in de wachtrij voor de migratie van een database.
incomingChanges	integer (int32)	Gegevens wijzigen Teller voor binnenkomende wijzigingen vastleggen.
latency	integer (int32)	Vertraging in seconden tussen bron en doel tijdens de online fase.
message	string	Eventuele foutmelding voor de migratiestatus.
migrationOperation	string	Migratiebewerking van een database.
migrationState	MigrationDatabaseState	Migratiestatus van een database.
startedOn	string (date-time)	Begintijd van een migratiestatus.

DbLevelValidationStatus

Object

Samenvatting van de validatiestatus voor een database.

Name	Type	Description
databaseName	string	Naam van database.
endedOn	string (date-time)	Eindtijd van een validatie op databaseniveau.
startedOn	string (date-time)	Starttijd van een validatie op databaseniveau.
summary	ValidationSummaryItem[]	Samenvatting van validaties op databaseniveau.

DbServerMetadata

Object

Metagegevens van databaseserver.

Name	Type	Description
location	string	Locatie van de databaseserver.
sku	ServerSku	Rekenlaag en grootte van de databaseserver. Dit object is leeg voor een enkele server van Azure Database for PostgreSQL.
storageMb	integer (int32)	Opslaggrootte (in MB) voor databaseserver.
version	string	Primaire versie van de PostgreSQL-database-engine.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

LogicalReplicationOnSourceServer

Opsomming

Geeft aan of logische replicatie op de bronserver moet worden ingesteld, indien nodig.

Waarde	Description
True	Logische replicatie wordt ingesteld op de bronserver.
False	Logische replicatie wordt niet ingesteld op de bronserver.

MigrateRolesAndPermissions

Opsomming

Geeft aan of rollen en machtigingen moeten worden gemigreerd.

Waarde	Description
True	Rollen en machtigingen worden gemigreerd.
False	Rollen en machtigingen worden niet gemigreerd.

Migration

Object

Eigenschappen van een migratie.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.cancel	Cancel	Geeft aan of annuleren moet worden geactiveerd voor de gehele migratie.
properties.currentStatus	MigrationStatus	Huidige status van een migratie.
properties.dbsToCancelMigrationOn	string[]	Wanneer u annuleren wilt activeren voor specifieke databases, stelt u 'triggerCutover' in op 'True' en de namen van de specifieke databases in deze array.
properties.dbsToMigrate	string[]	Namen van databases die moeten worden gemigreerd.
properties.dbsToTriggerCutoverOn	string[]	Wanneer u de cutover voor specifieke databases wilt activeren, stelt u 'triggerCutover' in op 'True' en de namen van de specifieke databases in deze array.
properties.migrateRoles	MigrateRolesAndPermissions	Geeft aan of rollen en machtigingen moeten worden gemigreerd.
properties.migrationId	string	Identificatie van een migratie.
properties.migrationInstanceResourceId	string (arm-id)	Id van het exemplaar van de privé-eindpuntmigratie.
properties.migrationMode	MigrationMode	Modus die wordt gebruikt om de migratie uit te voeren: Online of Offline.
properties.migrationOption	MigrationOption	Ondersteunde optie voor een migratie.
properties.migrationWindowEndTimeInUtc	string (date-time)	Eindtijd (UTC) voor migratievenster.
properties.migrationWindowStartTimeInUtc	string (date-time)	Begintijd (UTC) voor migratievenster.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Geeft aan of databases op de doelserver kunnen worden overschreven wanneer deze al aanwezig zijn. Als deze optie is ingesteld op 'Onwaar', wacht de migratiewerkstroom op een bevestiging wanneer deze detecteert dat de database al bestaat op de doelserver.
properties.secretParameters	MigrationSecretParameters	Parameters voor migratiegeheim.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Geeft aan of logische replicatie op de bronserver moet worden ingesteld, indien nodig.
properties.sourceDbServerFullyQualifiedDomainName	string	Fully qualified domain name (FQDN) of IP-adres van de bronserver. Deze eigenschap is optioneel. Indien aanwezig, zal de migratieservice deze altijd gebruiken om verbinding te maken met de bronserver.
properties.sourceDbServerMetadata	DbServerMetadata	Metadata van de brondatabaseserver.
properties.sourceDbServerResourceId	string	Id van de brondatabaseserverbron, wanneer 'sourceType' 'PostgreSQLSingleServer' is. Voor andere brontypen moet dit worden ingesteld op ipaddress:port@username of hostname:port@username.
properties.sourceType	SourceType	Bronservertype dat wordt gebruikt voor de migratie: 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 of Supabase_PostgreSQL
properties.sslMode	SslMode	SSL-modus die wordt gebruikt door een migratie. De standaard SSL-modus voor 'PostgreSQLSingleServer' is 'VerifyFull'. De standaard SSL-modus voor andere brontypen is 'Voorkeur'.
properties.startDataMigration	StartDataMigration	Geeft aan of de datamigratie direct moet beginnen.
properties.targetDbServerFullyQualifiedDomainName	string	Fully qualified domain name (FQDN) of IP-adres van de doelserver. Deze eigenschap is optioneel. Indien aanwezig, zal de migratieservice deze altijd gebruiken om verbinding te maken met de doelserver.
properties.targetDbServerMetadata	DbServerMetadata	Metadata van de doeldatabaseserver.
properties.targetDbServerResourceId	string	Identificatie van de serverbron van de doeldatabase.
properties.triggerCutover	TriggerCutover	Geeft aan of de cutover moet worden geactiveerd voor de gehele migratie.
systemData	systemData	Azure Resource Manager metadata met creationBy en modifiedBy informatie.
tags	object	Resourcetags.
type	string	Het type bron. Bijvoorbeeld: "Microsoft. Compute/virtualMachines" of "Microsoft. Opslag/opslagAccounts"

MigrationDatabaseState

Opsomming

Migratiestatus van een database.

Waarde	Description
InProgress	De migratie van de database is aan de gang.
WaitingForCutoverTrigger	De migratie wacht op de cutover-trigger voor de database.
Failed	De migratie van de database is mislukt.
Canceled	De migratie voor de database is geannuleerd.
Succeeded	De migratie van de database is gelukt.
Canceling	De migratie voor de database wordt geannuleerd.

MigrationMode

Opsomming

Modus die wordt gebruikt om de migratie uit te voeren.

Waarde	Description
Offline	Offline migratiemodus.
Online	Online migratiemodus.

MigrationOption

Opsomming

Ondersteunde optie voor een migratie.

Waarde	Description
Validate	Valideer de migratie zonder deze uit te voeren.
Migrate	Voer de migratie uit.
ValidateAndMigrate	Valideer en voer de migratie uit.

MigrationResourceForPatch

Object

Migration.

Name	Type	Description
properties.cancel	Cancel	Geeft aan of annuleren moet worden geactiveerd voor de gehele migratie.
properties.dbsToCancelMigrationOn	string[]	Wanneer u annuleren wilt activeren voor specifieke databases, stelt u 'triggerCutover' in op 'True' en de namen van de specifieke databases in deze array.
properties.dbsToMigrate	string[]	Namen van databases die moeten worden gemigreerd.
properties.dbsToTriggerCutoverOn	string[]	Wanneer u de cutover voor specifieke databases wilt activeren, stelt u 'triggerCutover' in op 'True' en de namen van de specifieke databases in deze array.
properties.migrateRoles	MigrateRolesAndPermissions	Geeft aan of rollen en machtigingen moeten worden gemigreerd.
properties.migrationMode	MigrationMode	Modus die wordt gebruikt om de migratie uit te voeren: Online of Offline.
properties.migrationWindowStartTimeInUtc	string (date-time)	Begintijd (UTC) voor migratievenster.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Geeft aan of databases op de doelserver kunnen worden overschreven wanneer deze al aanwezig zijn. Als deze optie is ingesteld op 'Onwaar', wacht de migratiewerkstroom op een bevestiging wanneer deze detecteert dat de database al bestaat op de doelserver.
properties.secretParameters	MigrationSecretParametersForPatch	Parameters voor migratiegeheim.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Geeft aan of logische replicatie op de bronserver moet worden ingesteld, indien nodig.
properties.sourceDbServerFullyQualifiedDomainName	string	Fully qualified domain name (FQDN) of IP-adres van de bronserver. Deze eigenschap is optioneel. Indien aanwezig, zal de migratieservice deze altijd gebruiken om verbinding te maken met de bronserver.
properties.sourceDbServerResourceId	string	Id van de brondatabaseserverbron, wanneer 'sourceType' 'PostgreSQLSingleServer' is. Voor andere brontypen moet dit worden ingesteld op ipaddress:port@username of hostname:port@username.
properties.startDataMigration	StartDataMigration	Geeft aan of de datamigratie direct moet beginnen.
properties.targetDbServerFullyQualifiedDomainName	string	Fully qualified domain name (FQDN) of IP-adres van de doelserver. Deze eigenschap is optioneel. Indien aanwezig, zal de migratieservice deze altijd gebruiken om verbinding te maken met de doelserver.
properties.triggerCutover	TriggerCutover	Geeft aan of de cutover moet worden geactiveerd voor de gehele migratie.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

MigrationSecretParameters

Object

Parameters voor migratiegeheim.

Name	Type	Description
adminCredentials	AdminCredentials (password)	Referenties van beheerdersgebruikers voor bron- en doelservers.
sourceServerUsername	string	Hiermee haalt u de naam van de gebruiker op of stelt u deze in voor de bronserver. Deze gebruiker hoeft geen beheerder te zijn.
targetServerUsername	string	Hiermee haalt u de naam van de gebruiker op of stelt u deze in voor de doelserver. Deze gebruiker hoeft geen beheerder te zijn.

MigrationSecretParametersForPatch

Object

Parameters voor migratiegeheim.

Name	Type	Description
adminCredentials	AdminCredentialsForPatch (password)	Referenties van beheerdersgebruikers voor bron- en doelservers.
sourceServerUsername	string	Hiermee haalt u de naam van de gebruiker op of stelt u deze in voor de bronserver. Deze gebruiker hoeft geen beheerder te zijn.
targetServerUsername	string	Hiermee haalt u de naam van de gebruiker op of stelt u deze in voor de doelserver. Deze gebruiker hoeft geen beheerder te zijn.

MigrationState

Opsomming

Staat van migratie.

Waarde	Description
InProgress	De migratie is aan de gang.
WaitingForUserAction	De migratie wacht op actie van de gebruiker.
Canceled	De migratie is geannuleerd.
Failed	Migratie is mislukt.
Succeeded	De migratie is geslaagd.
ValidationFailed	De validatie voor de migratie is mislukt.
CleaningUp	Migratie is het opschonen van resources.

MigrationStatus

Object

Staat van migratie.

Name	Type	Description
currentSubStateDetails	MigrationSubstateDetails	Details van de huidige substatus van de migratie.
error	string	Eventuele foutmelding voor de migratiestatus.
state	MigrationState	Staat van migratie.

MigrationSubstate

Opsomming

Substaat van migratie.

Waarde	Description
PerformingPreRequisiteSteps	Het uitvoeren van de vereiste stappen voor de migratie.
WaitingForLogicalReplicationSetupRequestOnSourceDB	Wachten op een verzoek om logische replicatie-instellingen in de brondatabase.
WaitingForDBsToMigrateSpecification	Wachten op databases om de specificatie te migreren.
WaitingForTargetDBOverwriteConfirmation	Wachten op bevestiging van het overschrijven van de doeldatabase.
WaitingForDataMigrationScheduling	Wachten op de planning van de gegevensmigratie.
WaitingForDataMigrationWindow	Wachten op het venster voor gegevensmigratie.
MigratingData	Gegevens migreren.
WaitingForCutoverTrigger	Wachten op cutover-trigger.
CompletingMigration	Migratie voltooien.
Completed	Migratie voltooid.
CancelingRequestedDBMigrations	Geannuleerde aangevraagde databasemigraties.
ValidationInProgress	Validatie in uitvoering.

MigrationSubstateDetails

Object

Details van de migratiesubstaat.

Name	Type	Description
currentSubState	MigrationSubstate	Substaat van migratie.
dbDetails	<string,  DatabaseMigrationState>
validationDetails	ValidationDetails	Details voor de validatie voor migratie.

OverwriteDatabasesOnTargetServer

Opsomming

Geeft aan of databases op de doelserver kunnen worden overschreven wanneer deze al aanwezig zijn.

Waarde	Description
True	Databases op de doelserver kunnen worden overschreven als ze al aanwezig zijn.
False	Databases op de doelserver kunnen niet worden overschreven als ze al aanwezig zijn. Wanneer de migratieworkflow detecteert dat de database al op de doelserver staat, wacht het op bevestiging.

ServerSku

Object

Bereken informatie van een server.

Name	Type	Description
name	string	Rekenlaag en grootte van de databaseserver. Dit object is leeg voor een enkele server van Azure Database for PostgreSQL.
tier	SkuTier	Laag van de rekenkracht die aan een server is toegewezen.

SkuTier

Opsomming

Laag van de rekenkracht die aan een server is toegewezen.

Waarde	Description
Burstable	Kosteneffectieve laag voor onregelmatig CPU-gebruik, ideaal voor het ontwikkelen en testen van workloads met lage prestatievereisten.
GeneralPurpose	Gebalanceerde rekenkracht en geheugen voor de meeste workloads, met schaalbare prestaties en I/O-doorvoer.
MemoryOptimized	Hoge geheugen-tot-coreverhouding voor veeleisende workloads die snelle in-memory verwerking en hoge gelijktijdigheid vereisen.

SourceType

Opsomming

Bronservertype dat voor de migratie wordt gebruikt.

Waarde	Description
OnPremises	On-premises PostgreSQL-server.
AWS	Amazon Web Services PostgreSQL-server.
GCP	Google Cloud Platform PostgreSQL-server.
AzureVM	Azure Virtual Machine PostgreSQL server.
PostgreSQLSingleServer	Azure Database for PostgreSQL single server.
AWS_RDS	Amazon RDS voor PostgreSQL.
AWS_AURORA	Amazon Aurora voor PostgreSQL.
AWS_EC2	Amazon EC2 voor PostgreSQL.
GCP_CloudSQL	Google Cloud SQL voor PostgreSQL.
GCP_AlloyDB	Google Cloud AlloyDB voor PostgreSQL.
GCP_Compute	Google Compute Engine voor PostgreSQL.
EDB	EnterpriseDB PostgreSQL-server.
EDB_Oracle_Server	EnterpriseDB Oracle Server.
EDB_PostgreSQL	EnterpriseDB PostgreSQL-server.
PostgreSQLFlexibleServer	Azure Database for PostgreSQL flexibele server.
PostgreSQLCosmosDB	.NET Cosmos DB voor PostgreSQL
Huawei_RDS	Huawei RDS voor PostgreSQL
Huawei_Compute	Huawei Compute voor PostgreSQL
Heroku_PostgreSQL	Heroku PostgreSQL
Crunchy_PostgreSQL	Knapperige PostgreSQL
ApsaraDB_RDS	ApsaraDB RDS voor PostgreSQL
Digital_Ocean_Droplets	Digitale oceaandruppels voor PostgreSQL
Digital_Ocean_PostgreSQL	Digitale Oceaan PostgreSQL
Supabase_PostgreSQL	Supabase PostgreSQL

SslMode

Opsomming

SSL-modus die wordt gebruikt door een migratie. De standaard SSL-modus voor 'PostgreSQLSingleServer' is 'VerifyFull'. De standaard SSL-modus voor andere brontypen is 'Voorkeur'.

Waarde	Description
Prefer	Geef de voorkeur aan SSL-verbinding. Als de server geen SSL ondersteunt, wordt de verbinding zonder SSL tot stand gebracht.
Require	SSL-verbinding vereist. Als de server geen SSL ondersteunt, mislukt de verbinding.
VerifyCA	Vereist SSL-verbinding en controleer het servercertificaat aan de hand van het CA-certificaat.
VerifyFull	SSL-verbinding vereisen, het servercertificaat verifiëren aan de hand van het CA-certificaat en controleren of de hostnaam van de server overeenkomt met het certificaat.

StartDataMigration

Opsomming

Geeft aan of de datamigratie direct moet beginnen.

Waarde	Description
True	De datamigratie moet direct beginnen.
False	De datamigratie mag niet meteen beginnen.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TriggerCutover

Opsomming

Geeft aan of de cutover moet worden geactiveerd voor de gehele migratie.

Waarde	Description
True	Cutover moet worden geactiveerd voor de gehele migratie.
False	Cutover mag niet worden geactiveerd voor de gehele migratie.

ValidationDetails

Object

Details voor de validatie voor migratie.

Name	Type	Description
dbLevelValidationDetails	DbLevelValidationStatus[]	Details van validaties op serverniveau.
serverLevelValidationDetails	ValidationSummaryItem[]	Details van validaties op serverniveau.
status	ValidationState	Validatiestatus voor migratie.
validationEndTimeInUtc	string (date-time)	Eindtijd (UTC) voor validatie.
validationStartTimeInUtc	string (date-time)	Starttijd (UTC) voor validatie.

ValidationMessage

Object

Object validatiebericht.

Name	Type	Description
message	string	Tekenreeks voor validatieberichten.
state	ValidationState	Ernst van het validatiebericht.

ValidationState

Opsomming

Validatiestaat voor migratie.

Waarde	Description
Failed	Validatie is mislukt.
Succeeded	Validatie is gelukt.
Warning	Validatie is gelukt met waarschuwingen.

ValidationSummaryItem

Object

Object met validatiesamenvatting.

Name	Type	Description
messages	ValidationMessage[]	Validatie berichten.
state	ValidationState	Validatiestatus voor migratie.
type	string	Type validatie.