Compartir a través de

Microsoft.DBforPostgreSQL flexibleServers/migrations

  • Artículo

Definición de recursos de Bicep

El tipo de recurso flexibleServers/migrations se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DBforPostgreSQL/flexibleServers/migrations, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-12-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    cancel: 'string'
    dbsToCancelMigrationOn: [
      'string'
    ]
    dbsToMigrate: [
      'string'
    ]
    dbsToTriggerCutoverOn: [
      'string'
    ]
    migrateRoles: 'string'
    migrationInstanceResourceId: 'string'
    migrationMode: 'string'
    migrationOption: 'string'
    migrationWindowEndTimeInUtc: 'string'
    migrationWindowStartTimeInUtc: 'string'
    overwriteDbsInTarget: 'string'
    secretParameters: {
      adminCredentials: {
        sourceServerPassword: 'string'
        targetServerPassword: 'string'
      }
      sourceServerUsername: 'string'
      targetServerUsername: 'string'
    }
    setupLogicalReplicationOnSourceDbIfNeeded: 'string'
    sourceDbServerFullyQualifiedDomainName: 'string'
    sourceDbServerResourceId: 'string'
    sourceType: 'string'
    sslMode: 'string'
    startDataMigration: 'string'
    targetDbServerFullyQualifiedDomainName: 'string'
    triggerCutover: 'string'
  }
}

Valores de propiedad

flexibleServers/migrations

Nombre Descripción Valor
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: flexibleServers
Propiedades Propiedades de recursos de migración. MigrationResourceProperties

MigrationResourceProperties

Nombre Descripción Valor
Cancelar Para desencadenar la cancelación de toda la migración, es necesario enviar esta marca como True. 'False'
'True'
dbsToCancelMigrationOn 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 string[]
dbsToMigrate Número de bases de datos que se van a migrar string[]

Restricciones:
Longitud máxima = 50
dbsToTriggerCutoverOn 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. string[]
migrateRoles Para migrar roles y permisos, es necesario enviar esta marca como True. 'False'
'True'
migrationInstanceResourceId ResourceId de la instancia de migración del punto de conexión privado cuerda
migrationMode Hay dos tipos de modos de migración en línea y sin conexión 'Sin conexión'
"En línea"
migrationOption Esto indica la opción de migración admitida para la migración. 'Migrar'
'Validar'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Hora de finalización en UTC para la ventana de migración cuerda
migrationWindowStartTimeInUtc Hora de inicio en UTC para la ventana de migración cuerda
overwriteDbsInTarget 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. 'False'
'True'
secretParameters Parámetros del secreto de migración MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded Indica si se va a configurar LogicalReplicationOnSourceDb, si es necesario. 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nombre de dominio o ip completo del servidor de origen. Es un valor opcional, si el cliente lo proporciona, dms siempre lo usará para la conexión. cuerda
sourceDbServerResourceId 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 cuerda
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 o EDB "AWS"
"AWS_AURORA"
"AWS_EC2"
"AWS_RDS"
"AzureVM"
'EDB'
'GCP'
"GCP_AlloyDB"
"GCP_CloudSQL"
"GCP_Compute"
'OnPremises'
'PostgreSQLSingleServer'
sslMode Modos SSL para la migración. El modo SSL predeterminado para PostgreSQLSingleServer es VerifyFull y Preferir para otros tipos de origen 'Prefer'
'Requerir'
'VerifyCA'
'VerifyFull'
startDataMigration Indica si la migración de datos debe iniciarse inmediatamente. 'False'
'True'
targetDbServerFullyQualifiedDomainName Nombre de dominio completo o ip del servidor de destino. Es un valor opcional, si el cliente lo proporciona, dms siempre lo usará para la conexión. cuerda
triggerCutover Para desencadenar la migración completa, es necesario enviar esta marca como True. 'False'
'True'

MigrationSecretParameters

Nombre Descripción Valor
adminCredentials Credenciales de administrador para servidores de origen y destino AdminCredentials (obligatorio)
sourceServerUsername Obtiene o establece el nombre de usuario del servidor de origen. Este usuario no necesita ser administrador. cuerda
targetServerUsername Obtiene o establece el nombre de usuario del servidor de destino. Este usuario no necesita ser administrador. cuerda

AdminCredentials

Nombre Descripción Valor
sourceServerPassword Contraseña para el servidor de origen. string (obligatorio)

Restricciones:
Valor confidencial. Pase como parámetro seguro.
targetServerPassword Contraseña para el servidor de destino. string (obligatorio)

Restricciones:
Valor confidencial. Pase como parámetro seguro.

Definición de recursos de plantilla de ARM

El tipo de recurso flexibleServers/migrations se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DBforPostgreSQL/flexibleServers/migrations, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
  "apiVersion": "2023-12-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "cancel": "string",
    "dbsToCancelMigrationOn": [ "string" ],
    "dbsToMigrate": [ "string" ],
    "dbsToTriggerCutoverOn": [ "string" ],
    "migrateRoles": "string",
    "migrationInstanceResourceId": "string",
    "migrationMode": "string",
    "migrationOption": "string",
    "migrationWindowEndTimeInUtc": "string",
    "migrationWindowStartTimeInUtc": "string",
    "overwriteDbsInTarget": "string",
    "secretParameters": {
      "adminCredentials": {
        "sourceServerPassword": "string",
        "targetServerPassword": "string"
      },
      "sourceServerUsername": "string",
      "targetServerUsername": "string"
    },
    "setupLogicalReplicationOnSourceDbIfNeeded": "string",
    "sourceDbServerFullyQualifiedDomainName": "string",
    "sourceDbServerResourceId": "string",
    "sourceType": "string",
    "sslMode": "string",
    "startDataMigration": "string",
    "targetDbServerFullyQualifiedDomainName": "string",
    "triggerCutover": "string"
  }
}

Valores de propiedad

flexibleServers/migrations

Nombre Descripción Valor
tipo El tipo de recurso 'Microsoft.DBforPostgreSQL/flexibleServers/migrations'
apiVersion La versión de la API de recursos '2023-12-01-preview'
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
Propiedades Propiedades de recursos de migración. MigrationResourceProperties

MigrationResourceProperties

Nombre Descripción Valor
Cancelar Para desencadenar la cancelación de toda la migración, es necesario enviar esta marca como True. 'False'
'True'
dbsToCancelMigrationOn 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 string[]
dbsToMigrate Número de bases de datos que se van a migrar string[]

Restricciones:
Longitud máxima = 50
dbsToTriggerCutoverOn 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. string[]
migrateRoles Para migrar roles y permisos, es necesario enviar esta marca como True. 'False'
'True'
migrationInstanceResourceId ResourceId de la instancia de migración del punto de conexión privado cuerda
migrationMode Hay dos tipos de modos de migración en línea y sin conexión 'Sin conexión'
"En línea"
migrationOption Esto indica la opción de migración admitida para la migración. 'Migrar'
'Validar'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Hora de finalización en UTC para la ventana de migración cuerda
migrationWindowStartTimeInUtc Hora de inicio en UTC para la ventana de migración cuerda
overwriteDbsInTarget 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. 'False'
'True'
secretParameters Parámetros del secreto de migración MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded Indica si se va a configurar LogicalReplicationOnSourceDb, si es necesario. 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nombre de dominio o ip completo del servidor de origen. Es un valor opcional, si el cliente lo proporciona, dms siempre lo usará para la conexión. cuerda
sourceDbServerResourceId 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 cuerda
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 o EDB "AWS"
"AWS_AURORA"
"AWS_EC2"
"AWS_RDS"
"AzureVM"
'EDB'
'GCP'
"GCP_AlloyDB"
"GCP_CloudSQL"
"GCP_Compute"
'OnPremises'
'PostgreSQLSingleServer'
sslMode Modos SSL para la migración. El modo SSL predeterminado para PostgreSQLSingleServer es VerifyFull y Preferir para otros tipos de origen 'Prefer'
'Requerir'
'VerifyCA'
'VerifyFull'
startDataMigration Indica si la migración de datos debe iniciarse inmediatamente. 'False'
'True'
targetDbServerFullyQualifiedDomainName Nombre de dominio completo o ip del servidor de destino. Es un valor opcional, si el cliente lo proporciona, dms siempre lo usará para la conexión. cuerda
triggerCutover Para desencadenar la migración completa, es necesario enviar esta marca como True. 'False'
'True'

MigrationSecretParameters

Nombre Descripción Valor
adminCredentials Credenciales de administrador para servidores de origen y destino AdminCredentials (obligatorio)
sourceServerUsername Obtiene o establece el nombre de usuario del servidor de origen. Este usuario no necesita ser administrador. cuerda
targetServerUsername Obtiene o establece el nombre de usuario del servidor de destino. Este usuario no necesita ser administrador. cuerda

AdminCredentials

Nombre Descripción Valor
sourceServerPassword Contraseña para el servidor de origen. string (obligatorio)

Restricciones:
Valor confidencial. Pase como parámetro seguro.
targetServerPassword Contraseña para el servidor de destino. string (obligatorio)

Restricciones:
Valor confidencial. Pase como parámetro seguro.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso flexibleServers/migrations se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DBforPostgreSQL/flexibleServers/migrations, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-12-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      cancel = "string"
      dbsToCancelMigrationOn = [
        "string"
      ]
      dbsToMigrate = [
        "string"
      ]
      dbsToTriggerCutoverOn = [
        "string"
      ]
      migrateRoles = "string"
      migrationInstanceResourceId = "string"
      migrationMode = "string"
      migrationOption = "string"
      migrationWindowEndTimeInUtc = "string"
      migrationWindowStartTimeInUtc = "string"
      overwriteDbsInTarget = "string"
      secretParameters = {
        adminCredentials = {
          sourceServerPassword = "string"
          targetServerPassword = "string"
        }
        sourceServerUsername = "string"
        targetServerUsername = "string"
      }
      setupLogicalReplicationOnSourceDbIfNeeded = "string"
      sourceDbServerFullyQualifiedDomainName = "string"
      sourceDbServerResourceId = "string"
      sourceType = "string"
      sslMode = "string"
      startDataMigration = "string"
      targetDbServerFullyQualifiedDomainName = "string"
      triggerCutover = "string"
    }
  })
}

Valores de propiedad

flexibleServers/migrations

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-12-01-preview"
nombre El nombre del recurso string (obligatorio)
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: flexibleServers
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta.
Propiedades Propiedades de recursos de migración. MigrationResourceProperties

MigrationResourceProperties

Nombre Descripción Valor
Cancelar Para desencadenar la cancelación de toda la migración, es necesario enviar esta marca como True. "False"
"True"
dbsToCancelMigrationOn 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 string[]
dbsToMigrate Número de bases de datos que se van a migrar string[]

Restricciones:
Longitud máxima = 50
dbsToTriggerCutoverOn 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. string[]
migrateRoles Para migrar roles y permisos, es necesario enviar esta marca como True. "False"
"True"
migrationInstanceResourceId ResourceId de la instancia de migración del punto de conexión privado cuerda
migrationMode Hay dos tipos de modos de migración en línea y sin conexión "Sin conexión"
"En línea"
migrationOption Esto indica la opción de migración admitida para la migración. "Migrar"
"Validar"
"ValidateAndMigrate"
migrationWindowEndTimeInUtc Hora de finalización en UTC para la ventana de migración cuerda
migrationWindowStartTimeInUtc Hora de inicio en UTC para la ventana de migración cuerda
overwriteDbsInTarget 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. "False"
"True"
secretParameters Parámetros del secreto de migración MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded Indica si se va a configurar LogicalReplicationOnSourceDb, si es necesario. "False"
"True"
sourceDbServerFullyQualifiedDomainName Nombre de dominio o ip completo del servidor de origen. Es un valor opcional, si el cliente lo proporciona, dms siempre lo usará para la conexión. cuerda
sourceDbServerResourceId 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 cuerda
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 o EDB "AWS"
"AWS_AURORA"
"AWS_EC2"
"AWS_RDS"
"AzureVM"
"EDB"
"GCP"
"GCP_AlloyDB"
"GCP_CloudSQL"
"GCP_Compute"
"OnPremises"
"PostgreSQLSingleServer"
sslMode Modos SSL para la migración. El modo SSL predeterminado para PostgreSQLSingleServer es VerifyFull y Preferir para otros tipos de origen "Preferir"
"Requerir"
"VerifyCA"
"VerifyFull"
startDataMigration Indica si la migración de datos debe iniciarse inmediatamente. "False"
"True"
targetDbServerFullyQualifiedDomainName Nombre de dominio completo o ip del servidor de destino. Es un valor opcional, si el cliente lo proporciona, dms siempre lo usará para la conexión. cuerda
triggerCutover Para desencadenar la migración completa, es necesario enviar esta marca como True. "False"
"True"

MigrationSecretParameters

Nombre Descripción Valor
adminCredentials Credenciales de administrador para servidores de origen y destino AdminCredentials (obligatorio)
sourceServerUsername Obtiene o establece el nombre de usuario del servidor de origen. Este usuario no necesita ser administrador. cuerda
targetServerUsername Obtiene o establece el nombre de usuario del servidor de destino. Este usuario no necesita ser administrador. cuerda

AdminCredentials

Nombre Descripción Valor
sourceServerPassword Contraseña para el servidor de origen. string (obligatorio)

Restricciones:
Valor confidencial. Pase como parámetro seguro.
targetServerPassword Contraseña para el servidor de destino. string (obligatorio)

Restricciones:
Valor confidencial. Pase como parámetro seguro.