Migrations - Update

Служба:

PostgreSQL

Версия API:

2025-08-01

Обновляет существующую миграцию. Текст запроса может содержать одно ко многим из изменяемых свойств, присутствующих в определении миграции. Некоторые обновления свойств инициируют переходы состояния миграции.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
migrationName	path	True	string pattern: ^[a-z][a-z0-9]*$	Название миграции.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	Имени сервера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
properties.cancel	Cancel	Указывает, должна ли быть активирована отмена для всей миграции.
properties.dbsToCancelMigrationOn	string[]	Если вы хотите активировать отмену для определенных баз данных, установите 'triggerCutover' в значение 'True' и имена конкретных баз данных в этом массиве.
properties.dbsToMigrate	string[]	Имена баз данных для переноса.
properties.dbsToTriggerCutoverOn	string[]	Если вы хотите запустить прямой переход для определенных баз данных, установите 'triggerCutover' в значение 'True' и укажите имена конкретных баз данных в этом массиве.
properties.migrateRoles	MigrateRolesAndPermissions	Указывает, необходимо ли перенести роли и разрешения.
properties.migrationMode	MigrationMode	Режим, используемый для выполнения миграции: Онлайн или Офлайн.
properties.migrationWindowStartTimeInUtc	string (date-time)	Время начала (UTC) для окна миграции.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Указывает, могут ли базы данных на целевом сервере быть перезаписаны, если они уже присутствуют. Если установлено значение «False», когда рабочий процесс миграции обнаруживает, что база данных уже существует на целевом сервере, он будет ожидать подтверждения.
properties.secretParameters	MigrationSecretParametersForPatch	Параметры секрета миграции.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Указывает, следует ли при необходимости настроить логическую репликацию на исходном сервере.
properties.sourceDbServerFullyQualifiedDomainName	string	Полное доменное имя (FQDN) или IP-адрес исходного сервера. Это свойство является необязательным. Если услуга предоставлена, служба миграции всегда будет использовать ее для подключения к исходному серверу.
properties.sourceDbServerResourceId	string	Идентификатор ресурса сервера исходной базы данных, когда 'sourceType' равен 'PostgreSQLSingleServer'. Для других типов источников это значение должно быть установлено в ipaddress:port@username или hostname:port@username.
properties.startDataMigration	StartDataMigration	Указывает, должен ли перенос данных начаться немедленно.
properties.targetDbServerFullyQualifiedDomainName	string	Полное доменное имя (FQDN) или IP-адрес целевого сервера. Это свойство является необязательным. Если услуга миграции предоставлена, она всегда будет использовать его для подключения к целевому серверу.
properties.triggerCutover	TriggerCutover	Указывает, должна ли быть активирована прямая миграция для всей миграции.
tags	object	Метаданные, относящиеся к приложению, в виде пар "ключ-значение".

Ответы

Имя	Тип	Описание
200 OK	Migration	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update an existing migration.

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AdminCredentials	Учетные данные пользователей-администраторов для исходного и целевого серверов.
AdminCredentialsForPatch	Учетные данные пользователей-администраторов для исходного и целевого серверов.
Cancel	Указывает, должна ли быть активирована отмена для всей миграции.
createdByType	Тип удостоверения, создавшего ресурс.
DatabaseMigrationState	Состояние миграции базы данных.
DbLevelValidationStatus	Сводка о состоянии проверки базы данных.
DbServerMetadata	Метаданные сервера базы данных.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
LogicalReplicationOnSourceServer	Указывает, следует ли при необходимости настроить логическую репликацию на исходном сервере.
MigrateRolesAndPermissions	Указывает, необходимо ли перенести роли и разрешения.
Migration	Свойства миграции.
MigrationDatabaseState	Состояние миграции базы данных.
MigrationMode	Режим, используемый для выполнения миграции: Онлайн или Офлайн.
MigrationOption	Поддерживаемый вариант миграции
MigrationResourceForPatch	Migration.
MigrationSecretParameters	Параметры секрета миграции.
MigrationSecretParametersForPatch	Параметры секрета миграции.
MigrationState	Состояние миграции.
MigrationStatus	Состояние миграции.
MigrationSubstate	Подсостояние миграции.
MigrationSubstateDetails	Сведения о миграционном субгосударстве.
OverwriteDatabasesOnTargetServer	Указывает, могут ли базы данных на целевом сервере быть перезаписаны, если они уже присутствуют. Если установлено значение «False», когда рабочий процесс миграции обнаруживает, что база данных уже существует на целевом сервере, он будет ожидать подтверждения.
ServerSku	Вычислительная информация сервера.
SkuTier	Уровень вычислительных ресурсов, назначенный серверу.
SourceType	Тип исходного сервера, используемый для миграции: 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 или Supabase_PostgreSQL
SslMode	Режим SSL, используемый при миграции. По умолчанию для 'PostgreSQLSingleServer' используется режим SSL 'VerifyFull'. По умолчанию для других типов источников используется режим SSL "Prefer".
StartDataMigration	Указывает, должен ли перенос данных начаться немедленно.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TriggerCutover	Указывает, должна ли быть активирована прямая миграция для всей миграции.
ValidationDetails	Сведения о проверке для миграции.
ValidationMessage	Объект проверочного сообщения.
ValidationState	Состояние проверки для миграции.
ValidationSummaryItem	Объект сводки валидации.

AdminCredentials

Объект

Учетные данные пользователей-администраторов для исходного и целевого серверов.

Имя	Тип	Описание
sourceServerPassword	string (password)	Пароль для пользователя исходного сервера.
targetServerPassword	string (password)	Пароль для пользователя целевого сервера.

AdminCredentialsForPatch

Объект

Учетные данные пользователей-администраторов для исходного и целевого серверов.

Имя	Тип	Описание
sourceServerPassword	string (password)	Пароль для пользователя исходного сервера.
targetServerPassword	string (password)	Пароль для пользователя целевого сервера.

Cancel

Перечисление

Указывает, должна ли быть активирована отмена для всей миграции.

Значение	Описание
True
False

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DatabaseMigrationState

Объект

Состояние миграции базы данных.

Имя	Тип	Описание
appliedChanges	integer (int32)	Счетчик примененных изменений Change Data Capture Capture.
cdcDeleteCounter	integer (int32)	Изменение счетчика удаления системы Data Capture.
cdcInsertCounter	integer (int32)	Изменение счетчика вставки системы сбора данных.
cdcUpdateCounter	integer (int32)	Изменение счетчика обновлений системы сбора данных.
databaseName	string	Имя базы данных.
endedOn	string (date-time)	Время окончания состояния миграции.
fullLoadCompletedTables	integer (int32)	Количество таблиц, загруженных во время миграции базы данных.
fullLoadErroredTables	integer (int32)	Количество таблиц, в которых возникают ошибки во время миграции базы данных.
fullLoadLoadingTables	integer (int32)	Количество таблиц, загружаемых во время миграции базы данных.
fullLoadQueuedTables	integer (int32)	Количество таблиц, поставленных в очередь для переноса базы данных.
incomingChanges	integer (int32)	Счетчик входящих изменений Change Data Capture.
latency	integer (int32)	Задержка в секундах между исходным и целевым объектами во время фазы подключения.
message	string	Сообщение об ошибке, если таковое имеется, для состояния миграции.
migrationOperation	string	Операция миграции базы данных.
migrationState	MigrationDatabaseState	Состояние миграции базы данных.
startedOn	string (date-time)	Время начала состояния миграции.

DbLevelValidationStatus

Объект

Сводка о состоянии проверки базы данных.

Имя	Тип	Описание
databaseName	string	Имя базы данных.
endedOn	string (date-time)	Время окончания проверки на уровне базы данных.
startedOn	string (date-time)	Время начала валидации на уровне базы данных.
summary	ValidationSummaryItem[]	Сводка проверок на уровне базы данных.

DbServerMetadata

Объект

Метаданные сервера базы данных.

Имя	Тип	Описание
location	string	Расположение сервера базы данных.
sku	ServerSku	Уровень вычислений и размер сервера базы данных. Этот объект пуст для одного сервера Базы данных Azure для PostgreSQL.
storageMb	integer (int32)	Объем хранилища (в МБ) для сервера базы данных.
version	string	Основная версия ядра СУБД PostgreSQL.

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

LogicalReplicationOnSourceServer

Перечисление

Указывает, следует ли при необходимости настроить логическую репликацию на исходном сервере.

Значение	Описание
True
False

MigrateRolesAndPermissions

Перечисление

Указывает, необходимо ли перенести роли и разрешения.

Значение	Описание
True
False

Migration

Объект

Свойства миграции.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.cancel	Cancel	Указывает, должна ли быть активирована отмена для всей миграции.
properties.currentStatus	MigrationStatus	Текущее состояние миграции.
properties.dbsToCancelMigrationOn	string[]	Если вы хотите активировать отмену для определенных баз данных, установите 'triggerCutover' в значение 'True' и имена конкретных баз данных в этом массиве.
properties.dbsToMigrate	string[]	Имена баз данных для переноса.
properties.dbsToTriggerCutoverOn	string[]	Если вы хотите запустить прямой переход для определенных баз данных, установите 'triggerCutover' в значение 'True' и укажите имена конкретных баз данных в этом массиве.
properties.migrateRoles	MigrateRolesAndPermissions	Указывает, необходимо ли перенести роли и разрешения.
properties.migrationId	string	Идентификатор миграции.
properties.migrationInstanceResourceId	string (arm-id)	Идентификатор экземпляра миграции частной конечной точки.
properties.migrationMode	MigrationMode	Режим, используемый для выполнения миграции: Онлайн или Офлайн.
properties.migrationOption	MigrationOption	Поддерживается вариант миграции.
properties.migrationWindowEndTimeInUtc	string (date-time)	Время окончания (UTC) для окна миграции.
properties.migrationWindowStartTimeInUtc	string (date-time)	Время начала (UTC) для окна миграции.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Указывает, могут ли базы данных на целевом сервере быть перезаписаны, если они уже присутствуют. Если установлено значение «False», когда рабочий процесс миграции обнаруживает, что база данных уже существует на целевом сервере, он будет ожидать подтверждения.
properties.secretParameters	MigrationSecretParameters	Параметры секрета миграции.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Указывает, следует ли при необходимости настроить логическую репликацию на исходном сервере.
properties.sourceDbServerFullyQualifiedDomainName	string	Полное доменное имя (FQDN) или IP-адрес исходного сервера. Это свойство является необязательным. Если услуга предоставлена, служба миграции всегда будет использовать ее для подключения к исходному серверу.
properties.sourceDbServerMetadata	DbServerMetadata	Метаданные исходного сервера базы данных.
properties.sourceDbServerResourceId	string	Идентификатор ресурса сервера исходной базы данных, когда 'sourceType' равен 'PostgreSQLSingleServer'. Для других типов источников это значение должно быть установлено в ipaddress:port@username или hostname:port@username.
properties.sourceType	SourceType	Тип исходного сервера, используемый для миграции: 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 или Supabase_PostgreSQL
properties.sslMode	SslMode	Режим SSL, используемый при миграции. По умолчанию для 'PostgreSQLSingleServer' используется режим SSL 'VerifyFull'. По умолчанию для других типов источников используется режим SSL "Prefer".
properties.startDataMigration	StartDataMigration	Указывает, должен ли перенос данных начаться немедленно.
properties.targetDbServerFullyQualifiedDomainName	string	Полное доменное имя (FQDN) или IP-адрес целевого сервера. Это свойство является необязательным. Если услуга миграции предоставлена, она всегда будет использовать его для подключения к целевому серверу.
properties.targetDbServerMetadata	DbServerMetadata	Метаданные целевого сервера базы данных.
properties.targetDbServerResourceId	string	Идентификатор ресурса целевого сервера базы данных.
properties.triggerCutover	TriggerCutover	Указывает, должна ли быть активирована прямая миграция для всей миграции.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

MigrationDatabaseState

Перечисление

Состояние миграции базы данных.

Значение	Описание
InProgress
WaitingForCutoverTrigger
Failed
Canceled
Succeeded
Canceling

MigrationMode

Перечисление

Режим, используемый для выполнения миграции: Онлайн или Офлайн.

Значение	Описание
Offline
Online

MigrationOption

Перечисление

Поддерживаемый вариант миграции

Значение	Описание
Validate
Migrate
ValidateAndMigrate

MigrationResourceForPatch

Объект

Migration.

Имя	Тип	Описание
properties.cancel	Cancel	Указывает, должна ли быть активирована отмена для всей миграции.
properties.dbsToCancelMigrationOn	string[]	Если вы хотите активировать отмену для определенных баз данных, установите 'triggerCutover' в значение 'True' и имена конкретных баз данных в этом массиве.
properties.dbsToMigrate	string[]	Имена баз данных для переноса.
properties.dbsToTriggerCutoverOn	string[]	Если вы хотите запустить прямой переход для определенных баз данных, установите 'triggerCutover' в значение 'True' и укажите имена конкретных баз данных в этом массиве.
properties.migrateRoles	MigrateRolesAndPermissions	Указывает, необходимо ли перенести роли и разрешения.
properties.migrationMode	MigrationMode	Режим, используемый для выполнения миграции: Онлайн или Офлайн.
properties.migrationWindowStartTimeInUtc	string (date-time)	Время начала (UTC) для окна миграции.
properties.overwriteDbsInTarget	OverwriteDatabasesOnTargetServer	Указывает, могут ли базы данных на целевом сервере быть перезаписаны, если они уже присутствуют. Если установлено значение «False», когда рабочий процесс миграции обнаруживает, что база данных уже существует на целевом сервере, он будет ожидать подтверждения.
properties.secretParameters	MigrationSecretParametersForPatch	Параметры секрета миграции.
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceServer	Указывает, следует ли при необходимости настроить логическую репликацию на исходном сервере.
properties.sourceDbServerFullyQualifiedDomainName	string	Полное доменное имя (FQDN) или IP-адрес исходного сервера. Это свойство является необязательным. Если услуга предоставлена, служба миграции всегда будет использовать ее для подключения к исходному серверу.
properties.sourceDbServerResourceId	string	Идентификатор ресурса сервера исходной базы данных, когда 'sourceType' равен 'PostgreSQLSingleServer'. Для других типов источников это значение должно быть установлено в ipaddress:port@username или hostname:port@username.
properties.startDataMigration	StartDataMigration	Указывает, должен ли перенос данных начаться немедленно.
properties.targetDbServerFullyQualifiedDomainName	string	Полное доменное имя (FQDN) или IP-адрес целевого сервера. Это свойство является необязательным. Если услуга миграции предоставлена, она всегда будет использовать его для подключения к целевому серверу.
properties.triggerCutover	TriggerCutover	Указывает, должна ли быть активирована прямая миграция для всей миграции.
tags	object	Метаданные, относящиеся к приложению, в виде пар "ключ-значение".

MigrationSecretParameters

Объект

Параметры секрета миграции.

Имя	Тип	Описание
adminCredentials	AdminCredentials (password)	Учетные данные пользователей-администраторов для исходного и целевого серверов.
sourceServerUsername	string	Получает или задает имя пользователя для исходного сервера. Этот пользователь не обязательно должен быть администратором.
targetServerUsername	string	Получает или задает имя пользователя для целевого сервера. Этот пользователь не обязательно должен быть администратором.

MigrationSecretParametersForPatch

Объект

Параметры секрета миграции.

Имя	Тип	Описание
adminCredentials	AdminCredentialsForPatch (password)	Учетные данные пользователей-администраторов для исходного и целевого серверов.
sourceServerUsername	string	Получает или задает имя пользователя для исходного сервера. Этот пользователь не обязательно должен быть администратором.
targetServerUsername	string	Получает или задает имя пользователя для целевого сервера. Этот пользователь не обязательно должен быть администратором.

MigrationState

Перечисление

Состояние миграции.

Значение	Описание
InProgress
WaitingForUserAction
Canceled
Failed
Succeeded
ValidationFailed
CleaningUp

MigrationStatus

Объект

Состояние миграции.

Имя	Тип	Описание
currentSubStateDetails	MigrationSubstateDetails	Сведения о текущем подсостоянии миграции.
error	string	Сообщение об ошибке, если таковое имеется, для состояния миграции.
state	MigrationState	Состояние миграции.

MigrationSubstate

Перечисление

Подсостояние миграции.

Значение	Описание
PerformingPreRequisiteSteps
WaitingForLogicalReplicationSetupRequestOnSourceDB
WaitingForDBsToMigrateSpecification
WaitingForTargetDBOverwriteConfirmation
WaitingForDataMigrationScheduling
WaitingForDataMigrationWindow
MigratingData
WaitingForCutoverTrigger
CompletingMigration
Completed
CancelingRequestedDBMigrations
ValidationInProgress

MigrationSubstateDetails

Объект

Сведения о миграционном субгосударстве.

Имя	Тип	Описание
currentSubState	MigrationSubstate	Подсостояние миграции.
dbDetails	<string,  DatabaseMigrationState>
validationDetails	ValidationDetails	Сведения о проверке для миграции.

OverwriteDatabasesOnTargetServer

Перечисление

Указывает, могут ли базы данных на целевом сервере быть перезаписаны, если они уже присутствуют. Если установлено значение «False», когда рабочий процесс миграции обнаруживает, что база данных уже существует на целевом сервере, он будет ожидать подтверждения.

Значение	Описание
True
False

ServerSku

Объект

Вычислительная информация сервера.

Имя	Тип	Описание
name	string	Уровень вычислений и размер сервера базы данных. Этот объект пуст для одного сервера Базы данных Azure для PostgreSQL.
tier	SkuTier	Уровень вычислительных ресурсов, назначенный серверу.

SkuTier

Перечисление

Уровень вычислительных ресурсов, назначенный серверу.

Значение	Описание
Burstable
GeneralPurpose
MemoryOptimized

SourceType

Перечисление

Тип исходного сервера, используемый для миграции: 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 или Supabase_PostgreSQL

Значение	Описание
OnPremises
AWS
GCP
AzureVM
PostgreSQLSingleServer
AWS_RDS
AWS_AURORA
AWS_EC2
GCP_CloudSQL
GCP_AlloyDB
GCP_Compute
EDB
EDB_Oracle_Server
EDB_PostgreSQL
PostgreSQLFlexibleServer
PostgreSQLCosmosDB
Huawei_RDS
Huawei_Compute
Heroku_PostgreSQL
Crunchy_PostgreSQL
ApsaraDB_RDS
Digital_Ocean_Droplets
Digital_Ocean_PostgreSQL
Supabase_PostgreSQL

SslMode

Перечисление

Режим SSL, используемый при миграции. По умолчанию для 'PostgreSQLSingleServer' используется режим SSL 'VerifyFull'. По умолчанию для других типов источников используется режим SSL "Prefer".

Значение	Описание
Prefer
Require
VerifyCA
VerifyFull

StartDataMigration

Перечисление

Указывает, должен ли перенос данных начаться немедленно.

Значение	Описание
True
False

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TriggerCutover

Перечисление

Указывает, должна ли быть активирована прямая миграция для всей миграции.

Значение	Описание
True
False

ValidationDetails

Объект

Сведения о проверке для миграции.

Имя	Тип	Описание
dbLevelValidationDetails	DbLevelValidationStatus[]	Сведения о проверках на уровне сервера.
serverLevelValidationDetails	ValidationSummaryItem[]	Сведения о проверках на уровне сервера.
status	ValidationState	Состояние проверки для миграции.
validationEndTimeInUtc	string (date-time)	Время окончания (UTC) для валидации.
validationStartTimeInUtc	string (date-time)	Время начала (UTC) для валидации.

ValidationMessage

Объект

Объект проверочного сообщения.

Имя	Тип	Описание
message	string	Строка сообщения о валидации.
state	ValidationState	Серьезность сообщения о проверке.

ValidationState

Перечисление

Состояние проверки для миграции.

Значение	Описание
Failed
Succeeded
Warning

ValidationSummaryItem

Объект

Объект сводки валидации.

Имя	Тип	Описание
messages	ValidationMessage[]	Сообщения о валидации.
state	ValidationState	Состояние проверки для миграции.
type	string	Тип валидации.