Partager via

Microsoft.DBforPostgreSQL flexibleServers/migrations

  • Article

Définition de ressource Bicep

Le type de ressource flexibleServers/migrations peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DBforPostgreSQL/flexibleServers/migrations, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01' = {
  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'
  }
}

Valeurs de propriété

AdminCredentials

Nom Description Valeur
sourceServerPassword Mot de passe pour le serveur source. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
targetServerPassword Mot de passe du serveur cible. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

Microsoft.DBforPostgreSQL/flexibleServers/migrations

Nom Description Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Modèle = ^[a-z][a-z0-9]*$ (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : flexibleServers
Propriétés Propriétés des ressources de migration. MigrationResourceProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

MigrationResourceProperties

Nom Description Valeur
Annuler Pour déclencher l’annulation de l’intégralité de la migration, nous devons envoyer cet indicateur en tant que True 'False'
'True'
dbsToCancelMigrationOn Lorsque vous souhaitez déclencher l’annulation pour des bases de données spécifiques, envoyez l’indicateur d’annulation en tant que noms true et de base de données dans ce tableau string[]
dbsToMigrate Nombre de bases de données à migrer string[]
dbsToTriggerCutoverOn Lorsque vous souhaitez déclencher le basculement pour des bases de données spécifiques, envoyez l’indicateur triggerCutover en tant que true et les noms de base de données dans ce tableau string[]
migrateRoles Pour migrer des rôles et des autorisations, nous devons envoyer cet indicateur en tant que True 'False'
'True'
migrationInstanceResourceId ResourceId de l’instance de migration de point de terminaison privé corde
migrationMode Il existe deux types de modes de migration en ligne et hors connexion 'Hors connexion'
'Online'
migrationOption Cela indique l’option migration prise en charge pour la migration 'Migrate'
'Valider'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Heure de fin au format UTC pour la fenêtre de migration corde
migrationWindowStartTimeInUtc Heure de début au format UTC pour la fenêtre de migration corde
overwriteDbsInTarget Indique si les bases de données sur le serveur cible peuvent être remplacées, si elles sont déjà présentes. Si la valeur est False, le flux de travail de migration attend une confirmation, s’il détecte que la base de données existe déjà. 'False'
'True'
secretParameters Paramètres de secret de migration MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeededed Indique s’il faut configurer LogicalReplicationOnSourceDb, si nécessaire 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nom de domaine complet du serveur source (FQDN) ou adresse IP. Il s’agit d’une valeur facultative, si le client le fournit, le service de migration l’utilisera toujours pour la connexion. corde
sourceDbServerResourceId ResourceId du serveur de base de données source dans le cas où le sourceType est PostgreSQLSingleServer. Pour les autres types sources, il doit s’agir d’ipaddress :port@username ou de nom d’hôte :port@username corde
sourceType type de serveur source de migration : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute ou EDB 'AWS'
'AWS_AURORA'
'AWS_EC2'
'AWS_RDS'
'AzureVM'
'EDB'
'GCP'
'GCP_AlloyDB'
'GCP_CloudSQL'
'GCP_Compute'
'OnPremises'
'PostgreSQLSingleServer'
sslMode Modes SSL pour la migration. Le mode SSL par défaut pour PostgreSQLSingleServer est VerifyFull et Préfère pour d’autres types sources 'Prefer'
'Exiger'
'VerifyCA'
'VerifyFull'
startDataMigration Indique si la migration de données doit commencer immédiatement 'False'
'True'
targetDbServerFullyQualifiedDomainName Nom de domaine complet du serveur cible (FQDN) ou adresse IP. Il s’agit d’une valeur facultative, si le client le fournit, le service de migration l’utilisera toujours pour la connexion. corde
triggerCutover Pour déclencher le basculement pour toute la migration, nous devons envoyer cet indicateur comme true 'False'
'True'

MigrationSecretParameters

Nom Description Valeur
adminCredentials Informations d’identification d’administrateur pour les serveurs source et cible AdminCredentials (obligatoire)
sourceServerUsername Obtient ou définit le nom d’utilisateur du serveur source. Cet utilisateur n’a pas besoin d’être administrateur. corde
targetServerUsername Obtient ou définit le nom d’utilisateur du serveur cible. Cet utilisateur n’a pas besoin d’être administrateur. corde

TrackedResourceTags

Nom Description Valeur

Définition de ressource de modèle ARM

Le type de ressource flexibleServers/migrations peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DBforPostgreSQL/flexibleServers/migrations, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

AdminCredentials

Nom Description Valeur
sourceServerPassword Mot de passe pour le serveur source. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
targetServerPassword Mot de passe du serveur cible. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

Microsoft.DBforPostgreSQL/flexibleServers/migrations

Nom Description Valeur
apiVersion Version de l’API '2024-08-01'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Modèle = ^[a-z][a-z0-9]*$ (obligatoire)
Propriétés Propriétés des ressources de migration. MigrationResourceProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DBforPostgreSQL/flexibleServers/migrations'

MigrationResourceProperties

Nom Description Valeur
Annuler Pour déclencher l’annulation de l’intégralité de la migration, nous devons envoyer cet indicateur en tant que True 'False'
'True'
dbsToCancelMigrationOn Lorsque vous souhaitez déclencher l’annulation pour des bases de données spécifiques, envoyez l’indicateur d’annulation en tant que noms true et de base de données dans ce tableau string[]
dbsToMigrate Nombre de bases de données à migrer string[]
dbsToTriggerCutoverOn Lorsque vous souhaitez déclencher le basculement pour des bases de données spécifiques, envoyez l’indicateur triggerCutover en tant que true et les noms de base de données dans ce tableau string[]
migrateRoles Pour migrer des rôles et des autorisations, nous devons envoyer cet indicateur en tant que True 'False'
'True'
migrationInstanceResourceId ResourceId de l’instance de migration de point de terminaison privé corde
migrationMode Il existe deux types de modes de migration en ligne et hors connexion 'Hors connexion'
'Online'
migrationOption Cela indique l’option migration prise en charge pour la migration 'Migrate'
'Valider'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Heure de fin au format UTC pour la fenêtre de migration corde
migrationWindowStartTimeInUtc Heure de début au format UTC pour la fenêtre de migration corde
overwriteDbsInTarget Indique si les bases de données sur le serveur cible peuvent être remplacées, si elles sont déjà présentes. Si la valeur est False, le flux de travail de migration attend une confirmation, s’il détecte que la base de données existe déjà. 'False'
'True'
secretParameters Paramètres de secret de migration MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeededed Indique s’il faut configurer LogicalReplicationOnSourceDb, si nécessaire 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nom de domaine complet du serveur source (FQDN) ou adresse IP. Il s’agit d’une valeur facultative, si le client le fournit, le service de migration l’utilisera toujours pour la connexion. corde
sourceDbServerResourceId ResourceId du serveur de base de données source dans le cas où le sourceType est PostgreSQLSingleServer. Pour les autres types sources, il doit s’agir d’ipaddress :port@username ou de nom d’hôte :port@username corde
sourceType type de serveur source de migration : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute ou EDB 'AWS'
'AWS_AURORA'
'AWS_EC2'
'AWS_RDS'
'AzureVM'
'EDB'
'GCP'
'GCP_AlloyDB'
'GCP_CloudSQL'
'GCP_Compute'
'OnPremises'
'PostgreSQLSingleServer'
sslMode Modes SSL pour la migration. Le mode SSL par défaut pour PostgreSQLSingleServer est VerifyFull et Préfère pour d’autres types sources 'Prefer'
'Exiger'
'VerifyCA'
'VerifyFull'
startDataMigration Indique si la migration de données doit commencer immédiatement 'False'
'True'
targetDbServerFullyQualifiedDomainName Nom de domaine complet du serveur cible (FQDN) ou adresse IP. Il s’agit d’une valeur facultative, si le client le fournit, le service de migration l’utilisera toujours pour la connexion. corde
triggerCutover Pour déclencher le basculement pour toute la migration, nous devons envoyer cet indicateur comme true 'False'
'True'

MigrationSecretParameters

Nom Description Valeur
adminCredentials Informations d’identification d’administrateur pour les serveurs source et cible AdminCredentials (obligatoire)
sourceServerUsername Obtient ou définit le nom d’utilisateur du serveur source. Cet utilisateur n’a pas besoin d’être administrateur. corde
targetServerUsername Obtient ou définit le nom d’utilisateur du serveur cible. Cet utilisateur n’a pas besoin d’être administrateur. corde

TrackedResourceTags

Nom Description Valeur

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource flexibleServers/migrations peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DBforPostgreSQL/flexibleServers/migrations, ajoutez le terraform suivant à votre modèle.

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

Valeurs de propriété

AdminCredentials

Nom Description Valeur
sourceServerPassword Mot de passe pour le serveur source. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)
targetServerPassword Mot de passe du serveur cible. corde

Contraintes:
Valeur sensible. Passez en tant que paramètre sécurisé. (obligatoire)

Microsoft.DBforPostgreSQL/flexibleServers/migrations

Nom Description Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Modèle = ^[a-z][a-z0-9]*$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : flexibleServers
Propriétés Propriétés des ressources de migration. MigrationResourceProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01 »

MigrationResourceProperties

Nom Description Valeur
Annuler Pour déclencher l’annulation de l’intégralité de la migration, nous devons envoyer cet indicateur en tant que True 'False'
'True'
dbsToCancelMigrationOn Lorsque vous souhaitez déclencher l’annulation pour des bases de données spécifiques, envoyez l’indicateur d’annulation en tant que noms true et de base de données dans ce tableau string[]
dbsToMigrate Nombre de bases de données à migrer string[]
dbsToTriggerCutoverOn Lorsque vous souhaitez déclencher le basculement pour des bases de données spécifiques, envoyez l’indicateur triggerCutover en tant que true et les noms de base de données dans ce tableau string[]
migrateRoles Pour migrer des rôles et des autorisations, nous devons envoyer cet indicateur en tant que True 'False'
'True'
migrationInstanceResourceId ResourceId de l’instance de migration de point de terminaison privé corde
migrationMode Il existe deux types de modes de migration en ligne et hors connexion 'Hors connexion'
'Online'
migrationOption Cela indique l’option migration prise en charge pour la migration 'Migrate'
'Valider'
'ValidateAndMigrate'
migrationWindowEndTimeInUtc Heure de fin au format UTC pour la fenêtre de migration corde
migrationWindowStartTimeInUtc Heure de début au format UTC pour la fenêtre de migration corde
overwriteDbsInTarget Indique si les bases de données sur le serveur cible peuvent être remplacées, si elles sont déjà présentes. Si la valeur est False, le flux de travail de migration attend une confirmation, s’il détecte que la base de données existe déjà. 'False'
'True'
secretParameters Paramètres de secret de migration MigrationSecretParameters
setupLogicalReplicationOnSourceDbIfNeededed Indique s’il faut configurer LogicalReplicationOnSourceDb, si nécessaire 'False'
'True'
sourceDbServerFullyQualifiedDomainName Nom de domaine complet du serveur source (FQDN) ou adresse IP. Il s’agit d’une valeur facultative, si le client le fournit, le service de migration l’utilisera toujours pour la connexion. corde
sourceDbServerResourceId ResourceId du serveur de base de données source dans le cas où le sourceType est PostgreSQLSingleServer. Pour les autres types sources, il doit s’agir d’ipaddress :port@username ou de nom d’hôte :port@username corde
sourceType type de serveur source de migration : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute ou EDB 'AWS'
'AWS_AURORA'
'AWS_EC2'
'AWS_RDS'
'AzureVM'
'EDB'
'GCP'
'GCP_AlloyDB'
'GCP_CloudSQL'
'GCP_Compute'
'OnPremises'
'PostgreSQLSingleServer'
sslMode Modes SSL pour la migration. Le mode SSL par défaut pour PostgreSQLSingleServer est VerifyFull et Préfère pour d’autres types sources 'Prefer'
'Exiger'
'VerifyCA'
'VerifyFull'
startDataMigration Indique si la migration de données doit commencer immédiatement 'False'
'True'
targetDbServerFullyQualifiedDomainName Nom de domaine complet du serveur cible (FQDN) ou adresse IP. Il s’agit d’une valeur facultative, si le client le fournit, le service de migration l’utilisera toujours pour la connexion. corde
triggerCutover Pour déclencher le basculement pour toute la migration, nous devons envoyer cet indicateur comme true 'False'
'True'

MigrationSecretParameters

Nom Description Valeur
adminCredentials Informations d’identification d’administrateur pour les serveurs source et cible AdminCredentials (obligatoire)
sourceServerUsername Obtient ou définit le nom d’utilisateur du serveur source. Cet utilisateur n’a pas besoin d’être administrateur. corde
targetServerUsername Obtient ou définit le nom d’utilisateur du serveur cible. Cet utilisateur n’a pas besoin d’être administrateur. corde

TrackedResourceTags

Nom Description Valeur