Migrations - List By Target Server

Referencia

Servicio:: PostgreSQL

Versión de la API:: 2024-11-01-preview

Enumere todas las migraciones en un servidor de destino determinado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations?api-version=2024-11-01-preview

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations?api-version=2024-11-01-preview&migrationListFilter={migrationListFilter}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string pattern: ^[-a-z0-9A-Z._()]+[^.]$	Nombre del grupo de recursos del servidor de base de datos de destino.
subscriptionId	path	True	string pattern: ([a-z0-9]){8,8}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){12,12}	Identificador de suscripción del servidor de base de datos de destino.
targetDbServerName	path	True	string pattern: ([-a-z0-9]){3,63}	Nombre del servidor de base de datos de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
migrationListFilter	query		MigrationListFilter	Filtro de lista de migración. Recupera migraciones activas o todas las migraciones.

Respuestas

Nombre	Tipo	Description
200 OK	MigrationResourceListResult	Éxito
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Migrations_ListByTargetServer

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget/migrations?api-version=2024-11-01-preview&migrationListFilter=All

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python migrations_list_by_target_server.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.list_by_target_server(
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
        resource_group_name="testrg",
        target_db_server_name="testtarget",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/Migrations_ListByTargetServer.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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "properties": {
        "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856",
        "currentStatus": {
          "state": "InProgress",
          "error": "",
          "currentSubStateDetails": {
            "currentSubState": "PerformingPreRequisiteSteps"
          }
        },
        "sourceDbServerMetadata": {
          "location": "westus",
          "version": "10",
          "storageMb": 1024,
          "sku": {
            "name": "B_Gen5_2",
            "tier": "Basic"
          }
        },
        "targetDbServerMetadata": {
          "location": "westus",
          "version": "11",
          "storageMb": 2048,
          "sku": {
            "tier": "GeneralPurpose",
            "name": "Standard_D4s_v3"
          }
        },
        "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource",
        "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget",
        "dbsToMigrate": [
          "db1",
          "db2",
          "db3",
          "db4"
        ],
        "setupLogicalReplicationOnSourceDbIfNeeded": "False",
        "overwriteDbsInTarget": "False",
        "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z",
        "startDataMigration": "False",
        "triggerCutover": "False",
        "migrateRoles": "False"
      },
      "location": "westus",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration",
      "name": "testmigration",
      "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations"
    }
  ]
}

Definiciones

Nombre	Description
AdminCredentials	Credenciales de administrador del servidor.
CancelEnum	Para desencadenar la cancelación de toda la migración, es necesario enviar esta marca como True.
createdByType	Tipo de identidad que creó el recurso.
DbLevelValidationStatus	Resumen del estado de validación de una base de datos individual
DbMigrationStatus	Estado de migración de una base de datos individual
DbServerMetadata	Metadatos del servidor de base de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LogicalReplicationOnSourceDbEnum	Indica si se va a configurar LogicalReplicationOnSourceDb, si es necesario.
MigrateRolesEnum	Para migrar roles y permisos, es necesario enviar esta marca como True.
MigrationDbState	Estado de la base de datos de migración de una base de datos individual
MigrationListFilter	Filtro de lista de migración. Recupera migraciones activas o todas las migraciones.
MigrationMode	Hay dos tipos de modos de migración en línea y sin conexión
MigrationOption	Los tipos admitidos de solicitud de migración incluyen Validate, Migrate y ValidateAndMigrate
MigrationResource	Representa un recurso de migración.
MigrationResourceListResult	Lista de recursos de migración.
MigrationSecretParameters	Parámetros de secreto de migración.
MigrationState	Estado de migración.
MigrationStatus	Estado de la migración.
MigrationSubState	Subesitio de migración.
MigrationSubStateDetails	Detalles del sub estado de migración.
OverwriteDbsInTargetEnum	Indica si las bases de datos del servidor de destino se pueden sobrescribir, si ya están presentes. Si se establece en False, el flujo de trabajo de migración esperará una confirmación, si detecta que la base de datos ya existe.
ServerSku	Información de SKU relacionadas con las propiedades de un servidor.
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
SourceType	Tipo de servidor de origen de migración: 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 o Supabase_PostgreSQL
SslMode	Modos SSL admitidos para la migración. VerifyFull es el modo SSL recomendado para la migración de servidor único. Preferir, Requerir son modos SSL recomendados para otros tipos de origen
StartDataMigrationEnum	Indica si la migración de datos debe iniciarse inmediatamente.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TriggerCutoverEnum	Para desencadenar la migración completa, es necesario enviar esta marca como True.
ValidationDetails	Detalles de la validación de la migración
ValidationMessage	Objeto de mensaje de validación
ValidationState	Estado de validación para la migración
ValidationSummaryItem	Objeto de resumen de validación

AdminCredentials

Object

Credenciales de administrador del servidor.

Nombre	Tipo	Description
sourceServerPassword	string	Contraseña para el servidor de origen.
targetServerPassword	string	Contraseña para el servidor de destino.

CancelEnum

Enumeración

Para desencadenar la cancelación de toda la migración, es necesario enviar esta marca como True.

Valor	Description
False
True

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DbLevelValidationStatus

Object

Resumen del estado de validación de una base de datos individual

Nombre	Tipo	Description
databaseName	string	Nombre de la base de datos
endedOn	string (date-time)	Fecha y hora de finalización de una validación de nivel de base de datos
startedOn	string (date-time)	Fecha y hora de inicio de una validación de nivel de base de datos
summary	ValidationSummaryItem[]	Resumen de validaciones de nivel de base de datos

DbMigrationStatus

Object

Estado de migración de una base de datos individual

Nombre	Tipo	Description
appliedChanges	integer (int32)	Contador de cambios aplicado por CDC
cdcDeleteCounter	integer (int32)	Contador de eliminación CDC
cdcInsertCounter	integer (int32)	Contador de inserción CDC
cdcUpdateCounter	integer (int32)	Contador de actualización CDC
databaseName	string	Nombre de la base de datos
endedOn	string (date-time)	Fecha y hora de finalización de un estado de migración
fullLoadCompletedTables	integer (int32)	Número de tablas cargadas durante la migración de una base de datos
fullLoadErroredTables	integer (int32)	Número de tablas con errores durante la migración de una base de datos
fullLoadLoadingTables	integer (int32)	Número de tablas que se cargan durante la migración de una base de datos
fullLoadQueuedTables	integer (int32)	Número de tablas en cola para la migración de una base de datos
incomingChanges	integer (int32)	Contador de cambios entrantes CDC
latency	integer (int32)	Retraso en segundos entre el origen y el destino durante la fase en línea
message	string	Mensaje de error, si existe, para el estado de migración
migrationOperation	string	Operación de migración de una base de datos individual
migrationState	MigrationDbState	Estado de la base de datos de migración de una base de datos individual
startedOn	string (date-time)	Fecha y hora de inicio de un estado de migración

DbServerMetadata

Object

Metadatos del servidor de base de datos.

Nombre	Tipo	Description
location	string	Ubicación del servidor de bases de datos
sku	ServerSku	SKU para el servidor de bases de datos. Este objeto está vacío para un único servidor PG
storageMb	integer (int32)	Tamaño de almacenamiento en MB para el servidor de bases de datos
version	string	Versión del motor de base de datos

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LogicalReplicationOnSourceDbEnum

Enumeración

Indica si se va a configurar LogicalReplicationOnSourceDb, si es necesario.

Valor	Description
False
True

MigrateRolesEnum

Enumeración

Para migrar roles y permisos, es necesario enviar esta marca como True.

Valor	Description
False
True

MigrationDbState

Enumeración

Estado de la base de datos de migración de una base de datos individual

Valor	Description
Canceled
Canceling
Failed
InProgress
Succeeded
WaitingForCutoverTrigger

MigrationListFilter

Enumeración

Filtro de lista de migración. Recupera migraciones activas o todas las migraciones.

Valor	Description
Active
All

MigrationMode

Enumeración

Hay dos tipos de modos de migración en línea y sin conexión

Valor	Description
Offline
Online

MigrationOption

Enumeración

Los tipos admitidos de solicitud de migración incluyen Validate, Migrate y ValidateAndMigrate

Valor	Description
Migrate
Validate
ValidateAndMigrate

MigrationResource

Object

Representa un recurso de migración.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.cancel	CancelEnum	Para desencadenar la cancelación de toda la migración, es necesario enviar esta marca como True.
properties.currentStatus	MigrationStatus	Estado actual de la migración
properties.dbsToCancelMigrationOn	string[]	Si desea desencadenar la cancelación para bases de datos específicas, envíe la marca de cancelación como True y los nombres de base de datos de esta matriz
properties.dbsToMigrate	string[]	Número de bases de datos que se van a migrar
properties.dbsToTriggerCutoverOn	string[]	Si desea desencadenar la migración por migración para bases de datos específicas, envíe la marca triggerCutover como true y los nombres de base de datos de esta matriz.
properties.migrateRoles	MigrateRolesEnum	Para migrar roles y permisos, es necesario enviar esta marca como True.
properties.migrationId	string	Identificador para la migración, un GUID.
properties.migrationInstanceResourceId	string (arm-id)	ResourceId de la instancia de migración del punto de conexión privado
properties.migrationMode	MigrationMode	Hay dos tipos de modos de migración en línea y sin conexión
properties.migrationOption	MigrationOption	Esto indica la opción de migración admitida para la migración.
properties.migrationWindowEndTimeInUtc	string (date-time)	Hora de finalización en UTC para la ventana de migración
properties.migrationWindowStartTimeInUtc	string (date-time)	Hora de inicio en UTC para la ventana de migración
properties.overwriteDbsInTarget	OverwriteDbsInTargetEnum	Indica si las bases de datos del servidor de destino se pueden sobrescribir, si ya están presentes. Si se establece en False, el flujo de trabajo de migración esperará una confirmación, si detecta que la base de datos ya existe.
properties.secretParameters	MigrationSecretParameters	Parámetros del secreto de migración
properties.setupLogicalReplicationOnSourceDbIfNeeded	LogicalReplicationOnSourceDbEnum	Indica si se va a configurar LogicalReplicationOnSourceDb, si es necesario.
properties.sourceDbServerFullyQualifiedDomainName	string	Nombre de dominio completo (FQDN) o dirección IP del servidor de origen. Es un valor opcional, si el cliente lo proporciona, el servicio de migración siempre lo usará para la conexión.
properties.sourceDbServerMetadata	DbServerMetadata	Metadatos del servidor de base de datos de origen
properties.sourceDbServerResourceId	string	ResourceId del servidor de base de datos de origen en caso de que sourceType sea PostgreSQLSingleServer. Para otros tipos de origen, debe ser ipaddress:port@username o hostname:port@username
properties.sourceType	SourceType	tipo de servidor de origen de migración: 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 o Supabase_PostgreSQL
properties.sslMode	SslMode	Modos SSL para la migración. El modo SSL predeterminado para PostgreSQLSingleServer es VerifyFull y Preferir para otros tipos de origen
properties.startDataMigration	StartDataMigrationEnum	Indica si la migración de datos debe iniciarse inmediatamente.
properties.targetDbServerFullyQualifiedDomainName	string	Nombre de dominio completo (FQDN) o dirección IP del servidor de destino. Es un valor opcional, si el cliente lo proporciona, el servicio de migración siempre lo usará para la conexión.
properties.targetDbServerMetadata	DbServerMetadata	Metadatos del servidor de base de datos de destino
properties.targetDbServerResourceId	string	ResourceId del servidor de base de datos de origen
properties.triggerCutover	TriggerCutoverEnum	Para desencadenar la migración completa, es necesario enviar esta marca como True.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

MigrationResourceListResult

Object

Lista de recursos de migración.

Nombre	Tipo	Description
nextLink	string	Vínculo que se usa para obtener la página siguiente de migraciones.
value	MigrationResource[]	Lista de recursos de migración.

MigrationSecretParameters

Object

Parámetros de secreto de migración.

Nombre	Tipo	Description
adminCredentials	AdminCredentials	Credenciales de administrador para servidores de origen y destino
sourceServerUsername	string	Obtiene o establece el nombre de usuario del servidor de origen. Este usuario no necesita ser administrador.
targetServerUsername	string	Obtiene o establece el nombre de usuario del servidor de destino. Este usuario no necesita ser administrador.

MigrationState

Enumeración

Estado de migración.

Valor	Description
Canceled
CleaningUp
Failed
InProgress
Succeeded
ValidationFailed
WaitingForUserAction

MigrationStatus

Object

Estado de la migración.

Nombre	Tipo	Description
currentSubStateDetails	MigrationSubStateDetails	Detalles del sub estado de migración actual.
error	string	Mensaje de error, si existe, para el estado de migración
state	MigrationState	Estado de la migración

MigrationSubState

Enumeración

Subesitio de migración.

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

MigrationSubStateDetails

Object

Detalles del sub estado de migración.

Nombre	Tipo	Description
currentSubState	MigrationSubState	Subesitio de migración.
dbDetails	<string, DbMigrationStatus>
validationDetails	ValidationDetails	Detalles de la validación de la migración

OverwriteDbsInTargetEnum

Enumeración

Indica si las bases de datos del servidor de destino se pueden sobrescribir, si ya están presentes. Si se establece en False, el flujo de trabajo de migración esperará una confirmación, si detecta que la base de datos ya existe.

Valor	Description
False
True

ServerSku

Object

Información de SKU relacionadas con las propiedades de un servidor.

Nombre	Tipo	Description
name	string	Nombre de la SKU, normalmente, nivel + familia + núcleos, por ejemplo, Standard_D4s_v3.
tier	SkuTier	Nivel de la SKU concreta, por ejemplo, Ampliable.

SkuTier

Enumeración

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor	Description
Basic
Free
Premium
Standard

SourceType

Enumeración

Tipo de servidor de origen de migración: 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 o Supabase_PostgreSQL

Valor	Description
AWS
AWS_AURORA
AWS_EC2
AWS_RDS
ApsaraDB_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

Enumeración

Modos SSL admitidos para la migración. VerifyFull es el modo SSL recomendado para la migración de servidor único. Preferir, Requerir son modos SSL recomendados para otros tipos de origen

Valor	Description
Prefer
Require
VerifyCA
VerifyFull

StartDataMigrationEnum

Enumeración

Indica si la migración de datos debe iniciarse inmediatamente.

Valor	Description
False
True

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TriggerCutoverEnum

Enumeración

Para desencadenar la migración completa, es necesario enviar esta marca como True.

Valor	Description
False
True

ValidationDetails

Object

Detalles de la validación de la migración

Nombre	Tipo	Description
dbLevelValidationDetails	DbLevelValidationStatus[]	Detalles de las validaciones de nivel de servidor
serverLevelValidationDetails	ValidationSummaryItem[]	Detalles de las validaciones de nivel de servidor
status	ValidationState	Estado de validación para la migración
validationEndTimeInUtc	string (date-time)	Fecha y hora de finalización de validación en UTC
validationStartTimeInUtc	string (date-time)	Fecha y hora de inicio de validación en UTC

ValidationMessage

Object

Objeto de mensaje de validación

Nombre	Tipo	Description
message	string	Cadena de mensaje de validación
state	ValidationState	Gravedad del mensaje de validación

ValidationState

Enumeración

Estado de validación para la migración

Valor	Description
Failed
Succeeded
Warning

ValidationSummaryItem

Object

Objeto de resumen de validación

Nombre	Tipo	Description
messages	ValidationMessage[]	Mensajes de validación
state	ValidationState	Estado de validación para la migración
type	string	Tipo de validación

Compartir a través de

Migrations - List By Target Server

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Migrations_ListByTargetServer

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdminCredentials

CancelEnum

createdByType

DbLevelValidationStatus

DbMigrationStatus

DbServerMetadata

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogicalReplicationOnSourceDbEnum

MigrateRolesEnum

MigrationDbState

MigrationListFilter

MigrationMode

MigrationOption

MigrationResource

MigrationResourceListResult

MigrationSecretParameters

MigrationState

MigrationStatus

MigrationSubState

MigrationSubStateDetails

OverwriteDbsInTargetEnum

ServerSku

SkuTier

SourceType

SslMode

StartDataMigrationEnum

systemData

TriggerCutoverEnum

ValidationDetails

ValidationMessage

ValidationState

ValidationSummaryItem