Condividi tramite


Microsoft.DBforPostgreSQL flexibleServers/migrations 2024-08-01

Definizione di risorsa Bicep

Il tipo di risorsa flexibleServers/migrations può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DBforPostgreSQL/flexibleServers/migrations, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

AdminCredentials

Nome Descrizione Valore
sourceServerPassword Password per il server di origine. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro. (obbligatorio)
targetServerPassword Password per il server di destinazione. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro. (obbligatorio)

Microsoft.DBforPostgreSQL/flexibleServers/migrations

Nome Descrizione Valore
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Pattern = ^[a-z][a-z0-9]*$ (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: flexibleServers
proprietà Proprietà delle risorse di migrazione. MigrationResourceProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

MigrationResourceProperties

Nome Descrizione Valore
Annulla Per attivare l'annullamento per l'intera migrazione, è necessario inviare questo flag come True 'False'
'True'
dbsToCancelMigrationOn Quando si desidera attivare l'annullamento per database specifici, inviare il flag di annullamento come true e i nomi di database in questa matrice string[]
dbsToMigrate Numero di database di cui eseguire la migrazione string[]
dbsToTriggerCutoverOn Quando si vuole attivare il cutover per database specifici, inviare il flag triggerCutover come true e i nomi di database in questa matrice string[]
migrateRoles Per eseguire la migrazione di ruoli e autorizzazioni, è necessario inviare questo flag come True 'False'
'True'
migrationInstanceResourceId ResourceId dell'istanza di migrazione dell'endpoint privato corda
migrationMode Esistono due tipi di modalità di migrazione online e offline 'Offline'
'Online'
migrationOption Indica l'opzione di migrazione supportata per la migrazione 'Migrate'
'Validate'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Ora di fine in formato UTC per la finestra di migrazione corda
migrationWindowStartTimeInUtc Ora di inizio in formato UTC per la finestra di migrazione corda
overwriteDbsInTarget Indica se i database nel server di destinazione possono essere sovrascritti, se già presenti. Se impostato su False, il flusso di lavoro di migrazione attenderà una conferma, se rileva che il database esiste già. 'False'
'True'
secretParameters Parametri del segreto di migrazione MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded Indica se configurare LogicalReplicationOnSourceDb, se necessario 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nome di dominio completo (FQDN) o indirizzo IP del server di origine. Si tratta di un valore facoltativo, se il cliente lo fornisce, il servizio di migrazione lo userà sempre per la connessione corda
sourceDbServerResourceId ResourceId del server di database di origine nel caso in cui sourceType sia PostgreSQLSingleServer. Per altri tipi di origine, questo deve essere ipaddress:port@username o hostname:port@username corda
sourceType tipo di server di origine della migrazione: 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 Modalità SSL per la migrazione. La modalità SSL predefinita per PostgreSQLSingleServer è VerifyFull e Preferisce per altri tipi di origine 'Prefer'
'Require'
'VerifyCA'
'VerifyFull'
startDataMigration Indica se la migrazione dei dati deve iniziare subito 'False'
'True'
targetDbServerFullyQualifiedDomainName Nome di dominio completo (FQDN) o indirizzo IP del server di destinazione. Si tratta di un valore facoltativo, se il cliente lo fornisce, il servizio di migrazione lo userà sempre per la connessione corda
triggerCutover Per attivare il cutover per l'intera migrazione, è necessario inviare questo flag come True 'False'
'True'

MigrationSecretParameters

Nome Descrizione Valore
adminCredentials Credenziali di amministratore per i server di origine e di destinazione AdminCredentials (obbligatorio)
sourceServerUsername Ottiene o imposta il nome utente per il server di origine. Questo utente non deve essere un amministratore. corda
targetServerNomeutente Ottiene o imposta il nome utente per il server di destinazione. Questo utente non deve essere un amministratore. corda

TrackedResourceTags

Nome Descrizione Valore

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa flexibleServers/migrations può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DBforPostgreSQL/flexibleServers/migrations, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
  "apiVersion": "2024-08-01",
  "name": "string",
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

AdminCredentials

Nome Descrizione Valore
sourceServerPassword Password per il server di origine. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro. (obbligatorio)
targetServerPassword Password per il server di destinazione. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro. (obbligatorio)

Microsoft.DBforPostgreSQL/flexibleServers/migrations

Nome Descrizione Valore
apiVersion Versione dell'API '2024-08-01'
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Pattern = ^[a-z][a-z0-9]*$ (obbligatorio)
proprietà Proprietà delle risorse di migrazione. MigrationResourceProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.DBforPostgreSQL/flexibleServers/migrations'

MigrationResourceProperties

Nome Descrizione Valore
Annulla Per attivare l'annullamento per l'intera migrazione, è necessario inviare questo flag come True 'False'
'True'
dbsToCancelMigrationOn Quando si desidera attivare l'annullamento per database specifici, inviare il flag di annullamento come true e i nomi di database in questa matrice string[]
dbsToMigrate Numero di database di cui eseguire la migrazione string[]
dbsToTriggerCutoverOn Quando si vuole attivare il cutover per database specifici, inviare il flag triggerCutover come true e i nomi di database in questa matrice string[]
migrateRoles Per eseguire la migrazione di ruoli e autorizzazioni, è necessario inviare questo flag come True 'False'
'True'
migrationInstanceResourceId ResourceId dell'istanza di migrazione dell'endpoint privato corda
migrationMode Esistono due tipi di modalità di migrazione online e offline 'Offline'
'Online'
migrationOption Indica l'opzione di migrazione supportata per la migrazione 'Migrate'
'Validate'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Ora di fine in formato UTC per la finestra di migrazione corda
migrationWindowStartTimeInUtc Ora di inizio in formato UTC per la finestra di migrazione corda
overwriteDbsInTarget Indica se i database nel server di destinazione possono essere sovrascritti, se già presenti. Se impostato su False, il flusso di lavoro di migrazione attenderà una conferma, se rileva che il database esiste già. 'False'
'True'
secretParameters Parametri del segreto di migrazione MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded Indica se configurare LogicalReplicationOnSourceDb, se necessario 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nome di dominio completo (FQDN) o indirizzo IP del server di origine. Si tratta di un valore facoltativo, se il cliente lo fornisce, il servizio di migrazione lo userà sempre per la connessione corda
sourceDbServerResourceId ResourceId del server di database di origine nel caso in cui sourceType sia PostgreSQLSingleServer. Per altri tipi di origine, questo deve essere ipaddress:port@username o hostname:port@username corda
sourceType tipo di server di origine della migrazione: 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 Modalità SSL per la migrazione. La modalità SSL predefinita per PostgreSQLSingleServer è VerifyFull e Preferisce per altri tipi di origine 'Prefer'
'Require'
'VerifyCA'
'VerifyFull'
startDataMigration Indica se la migrazione dei dati deve iniziare subito 'False'
'True'
targetDbServerFullyQualifiedDomainName Nome di dominio completo (FQDN) o indirizzo IP del server di destinazione. Si tratta di un valore facoltativo, se il cliente lo fornisce, il servizio di migrazione lo userà sempre per la connessione corda
triggerCutover Per attivare il cutover per l'intera migrazione, è necessario inviare questo flag come True 'False'
'True'

MigrationSecretParameters

Nome Descrizione Valore
adminCredentials Credenziali di amministratore per i server di origine e di destinazione AdminCredentials (obbligatorio)
sourceServerUsername Ottiene o imposta il nome utente per il server di origine. Questo utente non deve essere un amministratore. corda
targetServerNomeutente Ottiene o imposta il nome utente per il server di destinazione. Questo utente non deve essere un amministratore. corda

TrackedResourceTags

Nome Descrizione Valore

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa flexibleServers/migrations può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DBforPostgreSQL/flexibleServers/migrations, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
    }
  })
}

Valori delle proprietà

AdminCredentials

Nome Descrizione Valore
sourceServerPassword Password per il server di origine. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro. (obbligatorio)
targetServerPassword Password per il server di destinazione. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro. (obbligatorio)

Microsoft.DBforPostgreSQL/flexibleServers/migrations

Nome Descrizione Valore
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Pattern = ^[a-z][a-z0-9]*$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: flexibleServers
proprietà Proprietà delle risorse di migrazione. MigrationResourceProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01"

MigrationResourceProperties

Nome Descrizione Valore
Annulla Per attivare l'annullamento per l'intera migrazione, è necessario inviare questo flag come True 'False'
'True'
dbsToCancelMigrationOn Quando si desidera attivare l'annullamento per database specifici, inviare il flag di annullamento come true e i nomi di database in questa matrice string[]
dbsToMigrate Numero di database di cui eseguire la migrazione string[]
dbsToTriggerCutoverOn Quando si vuole attivare il cutover per database specifici, inviare il flag triggerCutover come true e i nomi di database in questa matrice string[]
migrateRoles Per eseguire la migrazione di ruoli e autorizzazioni, è necessario inviare questo flag come True 'False'
'True'
migrationInstanceResourceId ResourceId dell'istanza di migrazione dell'endpoint privato corda
migrationMode Esistono due tipi di modalità di migrazione online e offline 'Offline'
'Online'
migrationOption Indica l'opzione di migrazione supportata per la migrazione 'Migrate'
'Validate'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Ora di fine in formato UTC per la finestra di migrazione corda
migrationWindowStartTimeInUtc Ora di inizio in formato UTC per la finestra di migrazione corda
overwriteDbsInTarget Indica se i database nel server di destinazione possono essere sovrascritti, se già presenti. Se impostato su False, il flusso di lavoro di migrazione attenderà una conferma, se rileva che il database esiste già. 'False'
'True'
secretParameters Parametri del segreto di migrazione MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeeded Indica se configurare LogicalReplicationOnSourceDb, se necessario 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nome di dominio completo (FQDN) o indirizzo IP del server di origine. Si tratta di un valore facoltativo, se il cliente lo fornisce, il servizio di migrazione lo userà sempre per la connessione corda
sourceDbServerResourceId ResourceId del server di database di origine nel caso in cui sourceType sia PostgreSQLSingleServer. Per altri tipi di origine, questo deve essere ipaddress:port@username o hostname:port@username corda
sourceType tipo di server di origine della migrazione: 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 Modalità SSL per la migrazione. La modalità SSL predefinita per PostgreSQLSingleServer è VerifyFull e Preferisce per altri tipi di origine 'Prefer'
'Require'
'VerifyCA'
'VerifyFull'
startDataMigration Indica se la migrazione dei dati deve iniziare subito 'False'
'True'
targetDbServerFullyQualifiedDomainName Nome di dominio completo (FQDN) o indirizzo IP del server di destinazione. Si tratta di un valore facoltativo, se il cliente lo fornisce, il servizio di migrazione lo userà sempre per la connessione corda
triggerCutover Per attivare il cutover per l'intera migrazione, è necessario inviare questo flag come True 'False'
'True'

MigrationSecretParameters

Nome Descrizione Valore
adminCredentials Credenziali di amministratore per i server di origine e di destinazione AdminCredentials (obbligatorio)
sourceServerUsername Ottiene o imposta il nome utente per il server di origine. Questo utente non deve essere un amministratore. corda
targetServerNomeutente Ottiene o imposta il nome utente per il server di destinazione. Questo utente non deve essere un amministratore. corda

TrackedResourceTags

Nome Descrizione Valore