Migrations - Update

Layanan:

PostgreSQL

Versi API:

2025-08-01

Memperbarui migrasi yang sudah ada. Isi permintaan dapat berisi satu hingga banyak properti yang dapat diubah yang ada dalam definisi migrasi. Pembaruan properti tertentu memulai transisi status migrasi.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
migrationName	path	True	string pattern: ^[a-z][a-z0-9]*$	Nama migrasi.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	Nama server.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.cancel	Cancel	Menunjukkan jika pembatalan harus dipicu untuk seluruh migrasi.
properties.dbsToCancelMigrationOn	string[]	Saat Anda ingin memicu pembatalan untuk database tertentu, atur 'triggerCutover' ke 'True' dan nama database tertentu dalam array ini.
properties.dbsToMigrate	string[]	Nama database yang akan dimigrasikan.
properties.dbsToTriggerCutoverOn	string[]	Saat Anda ingin memicu cutover untuk database tertentu, atur 'triggerCutover' ke 'True' dan nama database tertentu dalam array ini.
properties.migrateRoles	MigrateRolesAndPermissions	Menunjukkan apakah peran dan izin harus dimigrasikan.
properties.migrationMode	MigrationMode	Mode yang digunakan untuk melakukan migrasi: Online atau Offline.
properties.migrationWindowStartTimeInUtc	string (date-time)	Waktu mulai (UTC) untuk jendela migrasi.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Menunjukkan apakah database di server target dapat ditimpa saat sudah ada. Jika diatur ke 'Salah', ketika alur kerja migrasi mendeteksi bahwa database sudah ada di server target, alur kerja akan menunggu konfirmasi.
properties.secretParameters	MigrationSecretParametersForPatch	Parameter rahasia migrasi.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Menunjukkan apakah akan menyiapkan replikasi logis pada server sumber, jika diperlukan.
properties.sourceDbServerFullyQualifiedDomainName	string	Nama domain yang sepenuhnya memenuhi syarat (FQDN) atau alamat IP server sumber. Properti ini bersifat opsional. Ketika disediakan, layanan migrasi akan selalu menggunakannya untuk terhubung ke server sumber.
properties.sourceDbServerResourceId	string	Pengidentifikasi sumber daya server database sumber, ketika 'sourceType' adalah 'PostgreSQLSingleServer'. Untuk jenis sumber lain, ini harus diatur ke ipaddress:port@username atau hostname:port@username.
properties.startDataMigration	StartDataMigration	Menunjukkan apakah migrasi data harus segera dimulai.
properties.targetDbServerFullyQualifiedDomainName	string	Nama domain yang memenuhi syarat (FQDN) atau alamat IP server target. Properti ini bersifat opsional. Ketika disediakan, layanan migrasi akan selalu menggunakannya untuk terhubung ke server target.
properties.triggerCutover	TriggerCutover	Menunjukkan apakah cutover harus dipicu untuk seluruh migrasi.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Respons

Nama	Jenis	Deskripsi
200 OK	Migration	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Update an existing migration.

Permintaan sampel

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

Respon sampel

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

Definisi

Nama	Deskripsi
AdminCredentials	Kredensial pengguna administrator untuk server sumber dan target.
AdminCredentialsForPatch	Kredensial pengguna administrator untuk server sumber dan target.
Cancel	Menunjukkan jika pembatalan harus dipicu untuk seluruh migrasi.
createdByType	Jenis identitas yang membuat sumber daya.
DatabaseMigrationState	Status migrasi database.
DbLevelValidationStatus	Ringkasan status validasi untuk database.
DbServerMetadata	Metadata server database.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
LogicalReplicationOnSourceServer	Menunjukkan apakah akan menyiapkan replikasi logis pada server sumber, jika diperlukan.
MigrateRolesAndPermissions	Menunjukkan apakah peran dan izin harus dimigrasikan.
Migration	Properti migrasi.
MigrationDatabaseState	Status migrasi database.
MigrationMode	Mode yang digunakan untuk melakukan migrasi.
MigrationOption	Opsi yang didukung untuk migrasi.
MigrationResourceForPatch	Migration.
MigrationSecretParameters	Parameter rahasia migrasi.
MigrationSecretParametersForPatch	Parameter rahasia migrasi.
MigrationState	Keadaan migrasi.
MigrationStatus	Keadaan migrasi.
MigrationSubstate	Subnegara migrasi.
MigrationSubstateDetails	Rincian subnegara migrasi.
OverwriteDatabasesOnTargetServer	Menunjukkan apakah database di server target dapat ditimpa saat sudah ada.
ServerSku	Menghitung informasi server.
SkuTier	Tingkat komputasi yang ditetapkan ke server.
SourceType	Jenis server sumber yang digunakan untuk migrasi.
SslMode	Mode SSL yang digunakan oleh migrasi. Mode SSL default untuk 'PostgreSQLSingleServer' adalah 'VerifyFull'. Mode SSL default untuk jenis sumber lainnya adalah 'Prefer'.
StartDataMigration	Menunjukkan apakah migrasi data harus segera dimulai.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TriggerCutover	Menunjukkan apakah cutover harus dipicu untuk seluruh migrasi.
ValidationDetails	Detail untuk validasi migrasi.
ValidationMessage	Objek pesan validasi.
ValidationState	Status validasi untuk migrasi.
ValidationSummaryItem	Objek ringkasan validasi.

AdminCredentials

Objek

Kredensial pengguna administrator untuk server sumber dan target.

Nama	Jenis	Deskripsi
sourceServerPassword	string (password)	Kata sandi untuk pengguna server sumber.
targetServerPassword	string (password)	Kata sandi untuk pengguna server target.

AdminCredentialsForPatch

Objek

Kredensial pengguna administrator untuk server sumber dan target.

Nama	Jenis	Deskripsi
sourceServerPassword	string (password)	Kata sandi untuk pengguna server sumber.
targetServerPassword	string (password)	Kata sandi untuk pengguna server target.

Cancel

Enumerasi

Menunjukkan jika pembatalan harus dipicu untuk seluruh migrasi.

Nilai	Deskripsi
True	Batal harus dipicu untuk seluruh migrasi.
False	Batal tidak boleh dipicu untuk seluruh migrasi.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DatabaseMigrationState

Objek

Status migrasi database.

Nama	Jenis	Deskripsi
appliedChanges	integer (int32)	Penghitung perubahan yang diterapkan Change Data Capture.
cdcDeleteCounter	integer (int32)	Ubah penghitung penghapusan Data Capture.
cdcInsertCounter	integer (int32)	Ubah penghitung sisipan Pengambilan Data.
cdcUpdateCounter	integer (int32)	Ubah penghitung pembaruan Data Capture.
databaseName	string	Nama database.
endedOn	string (date-time)	Waktu akhir status migrasi.
fullLoadCompletedTables	integer (int32)	Jumlah tabel yang dimuat selama migrasi database.
fullLoadErroredTables	integer (int32)	Jumlah tabel yang mengalami kesalahan selama migrasi database.
fullLoadLoadingTables	integer (int32)	Jumlah tabel yang dimuat selama migrasi database.
fullLoadQueuedTables	integer (int32)	Jumlah tabel yang diantri untuk migrasi database.
incomingChanges	integer (int32)	Ubah Data Menangkap penghitung perubahan masuk.
latency	integer (int32)	Lag dalam hitungan detik antara sumber dan target selama fase online.
message	string	Pesan kesalahan, jika ada, untuk status migrasi.
migrationOperation	string	Operasi migrasi database.
migrationState	MigrationDatabaseState	Status migrasi database.
startedOn	string (date-time)	Waktu mulai status migrasi.

DbLevelValidationStatus

Objek

Ringkasan status validasi untuk database.

Nama	Jenis	Deskripsi
databaseName	string	Nama database.
endedOn	string (date-time)	Waktu akhir validasi tingkat database.
startedOn	string (date-time)	Waktu mulai validasi tingkat database.
summary	ValidationSummaryItem[]	Ringkasan validasi tingkat database.

DbServerMetadata

Objek

Metadata server database.

Nama	Jenis	Deskripsi
location	string	Lokasi server database.
sku	ServerSku	Tingkat komputasi dan ukuran server database. Objek ini kosong untuk server tunggal Azure Database for PostgreSQL.
storageMb	integer (int32)	Ukuran penyimpanan (dalam MB) untuk server database.
version	string	Versi utama mesin database PostgreSQL.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

LogicalReplicationOnSourceServer

Enumerasi

Menunjukkan apakah akan menyiapkan replikasi logis pada server sumber, jika diperlukan.

Nilai	Deskripsi
True	Replikasi logis akan disiapkan di server sumber.
False	Replikasi logis tidak akan disiapkan di server sumber.

MigrateRolesAndPermissions

Enumerasi

Menunjukkan apakah peran dan izin harus dimigrasikan.

Nilai	Deskripsi
True	Peran dan izin akan dimigrasikan.
False	Peran dan izin tidak akan dimigrasikan.

Migration

Objek

Properti migrasi.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.cancel	Cancel	Menunjukkan jika pembatalan harus dipicu untuk seluruh migrasi.
properties.currentStatus	MigrationStatus	Status migrasi saat ini.
properties.dbsToCancelMigrationOn	string[]	Saat Anda ingin memicu pembatalan untuk database tertentu, atur 'triggerCutover' ke 'True' dan nama database tertentu dalam array ini.
properties.dbsToMigrate	string[]	Nama database yang akan dimigrasikan.
properties.dbsToTriggerCutoverOn	string[]	Saat Anda ingin memicu cutover untuk database tertentu, atur 'triggerCutover' ke 'True' dan nama database tertentu dalam array ini.
properties.migrateRoles	MigrateRolesAndPermissions	Menunjukkan apakah peran dan izin harus dimigrasikan.
properties.migrationId	string	Pengidentifikasi migrasi.
properties.migrationInstanceResourceId	string (arm-id)	Pengidentifikasi instans migrasi titik akhir privat.
properties.migrationMode	MigrationMode	Mode yang digunakan untuk melakukan migrasi: Online atau Offline.
properties.migrationOption	MigrationOption	Opsi yang didukung untuk migrasi.
properties.migrationWindowEndTimeInUtc	string (date-time)	Waktu akhir (UTC) untuk jendela migrasi.
properties.migrationWindowStartTimeInUtc	string (date-time)	Waktu mulai (UTC) untuk jendela migrasi.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Menunjukkan apakah database di server target dapat ditimpa saat sudah ada. Jika diatur ke 'Salah', ketika alur kerja migrasi mendeteksi bahwa database sudah ada di server target, alur kerja akan menunggu konfirmasi.
properties.secretParameters	MigrationSecretParameters	Parameter rahasia migrasi.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Menunjukkan apakah akan menyiapkan replikasi logis pada server sumber, jika diperlukan.
properties.sourceDbServerFullyQualifiedDomainName	string	Nama domain yang sepenuhnya memenuhi syarat (FQDN) atau alamat IP server sumber. Properti ini bersifat opsional. Ketika disediakan, layanan migrasi akan selalu menggunakannya untuk terhubung ke server sumber.
properties.sourceDbServerMetadata	DbServerMetadata	Metadata server database sumber.
properties.sourceDbServerResourceId	string	Pengidentifikasi sumber daya server database sumber, ketika 'sourceType' adalah 'PostgreSQLSingleServer'. Untuk jenis sumber lain, ini harus diatur ke ipaddress:port@username atau hostname:port@username.
properties.sourceType	SourceType	Jenis server sumber yang digunakan untuk migrasi: 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, atau Supabase_PostgreSQL
properties.sslMode	SslMode	Mode SSL yang digunakan oleh migrasi. Mode SSL default untuk 'PostgreSQLSingleServer' adalah 'VerifyFull'. Mode SSL default untuk jenis sumber lainnya adalah 'Prefer'.
properties.startDataMigration	StartDataMigration	Menunjukkan apakah migrasi data harus segera dimulai.
properties.targetDbServerFullyQualifiedDomainName	string	Nama domain yang memenuhi syarat (FQDN) atau alamat IP server target. Properti ini bersifat opsional. Ketika disediakan, layanan migrasi akan selalu menggunakannya untuk terhubung ke server target.
properties.targetDbServerMetadata	DbServerMetadata	Metadata server database target.
properties.targetDbServerResourceId	string	Pengidentifikasi sumber daya server database target.
properties.triggerCutover	TriggerCutover	Menunjukkan apakah cutover harus dipicu untuk seluruh migrasi.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

MigrationDatabaseState

Enumerasi

Status migrasi database.

Nilai	Deskripsi
InProgress	Migrasi sedang berlangsung untuk database.
WaitingForCutoverTrigger	Migrasi sedang menunggu pemicu cutover untuk database.
Failed	Migrasi telah gagal untuk database.
Canceled	Migrasi telah dibatalkan untuk database.
Succeeded	Migrasi telah berhasil untuk database.
Canceling	Migrasi dibatalkan untuk database.

MigrationMode

Enumerasi

Mode yang digunakan untuk melakukan migrasi.

Nilai	Deskripsi
Offline	Mode migrasi offline.
Online	Mode migrasi online.

MigrationOption

Enumerasi

Opsi yang didukung untuk migrasi.

Nilai	Deskripsi
Validate	Validasi migrasi tanpa melakukannya.
Migrate	Lakukan migrasi.
ValidateAndMigrate	Validasi dan lakukan migrasi.

MigrationResourceForPatch

Objek

Migration.

Nama	Jenis	Deskripsi
properties.cancel	Cancel	Menunjukkan jika pembatalan harus dipicu untuk seluruh migrasi.
properties.dbsToCancelMigrationOn	string[]	Saat Anda ingin memicu pembatalan untuk database tertentu, atur 'triggerCutover' ke 'True' dan nama database tertentu dalam array ini.
properties.dbsToMigrate	string[]	Nama database yang akan dimigrasikan.
properties.dbsToTriggerCutoverOn	string[]	Saat Anda ingin memicu cutover untuk database tertentu, atur 'triggerCutover' ke 'True' dan nama database tertentu dalam array ini.
properties.migrateRoles	MigrateRolesAndPermissions	Menunjukkan apakah peran dan izin harus dimigrasikan.
properties.migrationMode	MigrationMode	Mode yang digunakan untuk melakukan migrasi: Online atau Offline.
properties.migrationWindowStartTimeInUtc	string (date-time)	Waktu mulai (UTC) untuk jendela migrasi.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Menunjukkan apakah database di server target dapat ditimpa saat sudah ada. Jika diatur ke 'Salah', ketika alur kerja migrasi mendeteksi bahwa database sudah ada di server target, alur kerja akan menunggu konfirmasi.
properties.secretParameters	MigrationSecretParametersForPatch	Parameter rahasia migrasi.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Menunjukkan apakah akan menyiapkan replikasi logis pada server sumber, jika diperlukan.
properties.sourceDbServerFullyQualifiedDomainName	string	Nama domain yang sepenuhnya memenuhi syarat (FQDN) atau alamat IP server sumber. Properti ini bersifat opsional. Ketika disediakan, layanan migrasi akan selalu menggunakannya untuk terhubung ke server sumber.
properties.sourceDbServerResourceId	string	Pengidentifikasi sumber daya server database sumber, ketika 'sourceType' adalah 'PostgreSQLSingleServer'. Untuk jenis sumber lain, ini harus diatur ke ipaddress:port@username atau hostname:port@username.
properties.startDataMigration	StartDataMigration	Menunjukkan apakah migrasi data harus segera dimulai.
properties.targetDbServerFullyQualifiedDomainName	string	Nama domain yang memenuhi syarat (FQDN) atau alamat IP server target. Properti ini bersifat opsional. Ketika disediakan, layanan migrasi akan selalu menggunakannya untuk terhubung ke server target.
properties.triggerCutover	TriggerCutover	Menunjukkan apakah cutover harus dipicu untuk seluruh migrasi.
tags	object	Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

MigrationSecretParameters

Objek

Parameter rahasia migrasi.

Nama	Jenis	Deskripsi
adminCredentials	AdminCredentials (password)	Kredensial pengguna administrator untuk server sumber dan target.
sourceServerUsername	string	Mendapatkan atau mengatur nama pengguna untuk server sumber. Pengguna ini tidak perlu menjadi administrator.
targetServerUsername	string	Mendapatkan atau mengatur nama pengguna untuk server target. Pengguna ini tidak perlu menjadi administrator.

MigrationSecretParametersForPatch

Objek

Parameter rahasia migrasi.

Nama	Jenis	Deskripsi
adminCredentials	AdminCredentialsForPatch (password)	Kredensial pengguna administrator untuk server sumber dan target.
sourceServerUsername	string	Mendapatkan atau mengatur nama pengguna untuk server sumber. Pengguna ini tidak perlu menjadi administrator.
targetServerUsername	string	Mendapatkan atau mengatur nama pengguna untuk server target. Pengguna ini tidak perlu menjadi administrator.

MigrationState

Enumerasi

Keadaan migrasi.

Nilai	Deskripsi
InProgress	Migrasi sedang berlangsung.
WaitingForUserAction	Migrasi sedang menunggu tindakan pengguna.
Canceled	Migrasi telah dibatalkan.
Failed	Migrasi gagal.
Succeeded	Migrasi telah berhasil.
ValidationFailed	Validasi untuk migrasi telah gagal.
CleaningUp	Migrasi membersihkan sumber daya.

MigrationStatus

Objek

Keadaan migrasi.

Nama	Jenis	Deskripsi
currentSubStateDetails	MigrationSubstateDetails	Detail substatus migrasi saat ini.
error	string	Pesan kesalahan, jika ada, untuk status migrasi.
state	MigrationState	Keadaan migrasi.

MigrationSubstate

Enumerasi

Subnegara migrasi.

Nilai	Deskripsi
PerformingPreRequisiteSteps	Melakukan langkah-langkah prasyarat untuk migrasi.
WaitingForLogicalReplicationSetupRequestOnSourceDB	Menunggu permintaan penyiapan replikasi logis pada database sumber.
WaitingForDBsToMigrateSpecification	Menunggu database untuk memigrasikan spesifikasi.
WaitingForTargetDBOverwriteConfirmation	Menunggu konfirmasi penimpaan database target.
WaitingForDataMigrationScheduling	Menunggu penjadwalan migrasi data.
WaitingForDataMigrationWindow	Menunggu jendela migrasi data.
MigratingData	Memigrasikan data.
WaitingForCutoverTrigger	Menunggu pemicu cutover.
CompletingMigration	Menyelesaikan migrasi.
Completed	Migrasi selesai.
CancelingRequestedDBMigrations	Membatalkan migrasi database yang diminta.
ValidationInProgress	Validasi sedang berlangsung.

MigrationSubstateDetails

Objek

Rincian subnegara migrasi.

Nama	Jenis	Deskripsi
currentSubState	MigrationSubstate	Subnegara migrasi.
dbDetails	<string,  DatabaseMigrationState>
validationDetails	ValidationDetails	Detail untuk validasi migrasi.

OverwriteDatabasesOnTargetServer

Enumerasi

Menunjukkan apakah database di server target dapat ditimpa saat sudah ada.

Nilai	Deskripsi
True	Database di server target dapat ditimpa saat sudah ada.
False	Database di server target tidak dapat ditimpa saat sudah ada. Ketika alur kerja migrasi mendeteksi bahwa database sudah ada di server target, alur kerja akan menunggu konfirmasi.

ServerSku

Objek

Menghitung informasi server.

Nama	Jenis	Deskripsi
name	string	Tingkat komputasi dan ukuran server database. Objek ini kosong untuk server tunggal Azure Database for PostgreSQL.
tier	SkuTier	Tingkat komputasi yang ditetapkan ke server.

SkuTier

Enumerasi

Tingkat komputasi yang ditetapkan ke server.

Nilai	Deskripsi
Burstable	Tingkat hemat biaya untuk penggunaan CPU yang jarang, ideal untuk pengembangan dan pengujian beban kerja dengan persyaratan performa rendah.
GeneralPurpose	Komputasi dan memori yang seimbang untuk sebagian besar beban kerja, menawarkan performa yang dapat diskalakan dan throughput I/O.
MemoryOptimized	Rasio memori terhadap inti yang tinggi untuk beban kerja yang menuntut yang membutuhkan pemrosesan dalam memori yang cepat dan konkurensi tinggi.

SourceType

Enumerasi

Jenis server sumber yang digunakan untuk migrasi.

Nilai	Deskripsi
OnPremises	Server PostgreSQL lokal.
AWS	Server PostgreSQL Amazon Web Services.
GCP	Server PostgreSQL Google Cloud Platform.
AzureVM	Server PostgreSQL Komputer Virtual Azure.
PostgreSQLSingleServer	Azure Database for PostgreSQL server tunggal.
AWS_RDS	Amazon RDS untuk PostgreSQL.
AWS_AURORA	Amazon Aurora untuk PostgreSQL.
AWS_EC2	Amazon EC2 untuk PostgreSQL.
GCP_CloudSQL	Google Cloud SQL untuk PostgreSQL.
GCP_AlloyDB	Google Cloud AlloyDB untuk PostgreSQL.
GCP_Compute	Google Compute Engine untuk PostgreSQL.
EDB	Server PostgreSQL EnterpriseDB.
EDB_Oracle_Server	Server Oracle EnterpriseDB.
EDB_PostgreSQL	Server PostgreSQL EnterpriseDB.
PostgreSQLFlexibleServer	Server fleksibel Azure Database for PostgreSQL.
PostgreSQLCosmosDB	.NET Cosmos DB untuk PostgreSQL
Huawei_RDS	Huawei RDS untuk PostgreSQL
Huawei_Compute	Huawei Compute untuk PostgreSQL
Heroku_PostgreSQL	Heroku PostgreSQL
Crunchy_PostgreSQL	PostgreSQL Renyah
ApsaraDB_RDS	ApsaraDB RDS untuk PostgreSQL
Digital_Ocean_Droplets	Tetesan Lautan Digital untuk PostgreSQL
Digital_Ocean_PostgreSQL	PostgreSQL Samudra Digital
Supabase_PostgreSQL	Supabase PostgreSQL

SslMode

Enumerasi

Mode SSL yang digunakan oleh migrasi. Mode SSL default untuk 'PostgreSQLSingleServer' adalah 'VerifyFull'. Mode SSL default untuk jenis sumber lainnya adalah 'Prefer'.

Nilai	Deskripsi
Prefer	Lebih suka koneksi SSL. Jika server tidak mendukung SSL, koneksi akan dibuat tanpa SSL.
Require	Memerlukan koneksi SSL. Jika server tidak mendukung SSL, koneksi akan gagal.
VerifyCA	Memerlukan koneksi SSL dan memverifikasi sertifikat server terhadap sertifikat CA.
VerifyFull	Memerlukan koneksi SSL, memverifikasi sertifikat server terhadap sertifikat CA, dan memverifikasi bahwa nama host server cocok dengan sertifikat.

StartDataMigration

Enumerasi

Menunjukkan apakah migrasi data harus segera dimulai.

Nilai	Deskripsi
True	Migrasi data harus segera dimulai.
False	Migrasi data tidak boleh langsung dimulai.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

TriggerCutover

Enumerasi

Menunjukkan apakah cutover harus dipicu untuk seluruh migrasi.

Nilai	Deskripsi
True	Cutover harus dipicu untuk seluruh migrasi.
False	Cutover tidak boleh dipicu untuk seluruh migrasi.

ValidationDetails

Objek

Detail untuk validasi migrasi.

Nama	Jenis	Deskripsi
dbLevelValidationDetails	DbLevelValidationStatus[]	Detail validasi tingkat server.
serverLevelValidationDetails	ValidationSummaryItem[]	Detail validasi tingkat server.
status	ValidationState	Status validasi untuk migrasi.
validationEndTimeInUtc	string (date-time)	Waktu akhir (UTC) untuk validasi.
validationStartTimeInUtc	string (date-time)	Waktu mulai (UTC) untuk validasi.

ValidationMessage

Objek

Objek pesan validasi.

Nama	Jenis	Deskripsi
message	string	String pesan validasi.
state	ValidationState	Tingkat keparahan pesan validasi.

ValidationState

Enumerasi

Status validasi untuk migrasi.

Nilai	Deskripsi
Failed	Validasi gagal.
Succeeded	Validasi telah berhasil.
Warning	Validasi telah berhasil dengan peringatan.

ValidationSummaryItem

Objek

Objek ringkasan validasi.

Nama	Jenis	Deskripsi
messages	ValidationMessage[]	Pesan validasi.
state	ValidationState	Status validasi untuk migrasi.
type	string	Jenis validasi.