Share via


PostgreSqlMigration Class

Definition

PostgreSqlMigration.

public class PostgreSqlMigration : Azure.Provisioning.Primitives.ProvisionableResource
type PostgreSqlMigration = class
    inherit ProvisionableResource
Public Class PostgreSqlMigration
Inherits ProvisionableResource
Inheritance

Constructors

Name Description
PostgreSqlMigration(String, String)

Creates a new PostgreSqlMigration.

Properties

Name Description
BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
BicepMetadata

Gets the Bicep metadata for this resource, including decorators and conditions.

(Inherited from ProvisionableResource)
Cancel

Indicates if cancel must be triggered for the entire migration.

CurrentStatus

Current status of a migration.

DbsToCancelMigrationOn

When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.

DbsToMigrate

Names of databases to migrate.

DbsToTriggerCutoverOn

When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
Id

Gets the Id.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
Location

Gets or sets the Location.

MigrateRoles

Indicates if roles and permissions must be migrated.

MigrationId

Identifier of a migration.

MigrationInstanceResourceId

Identifier of the private endpoint migration instance.

MigrationMode

Mode used to perform the migration: Online or Offline.

MigrationOption

Supported option for a migration.

MigrationWindowEndTimeInUtc

End time (UTC) for migration window.

MigrationWindowStartTimeInUtc

Start time (UTC) for migration window.

Name

Name of migration.

OverwriteDbsInTarget

Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation.

Parent

Gets or sets a reference to the parent PostgreSqlFlexibleServer.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
SecretParameters

Migration secret parameters.

SetupLogicalReplicationOnSourceDbIfNeeded

Indicates whether to setup logical replication on source server, if needed.

SourceDbServerFullyQualifiedDomainName

Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server.

SourceDbServerMetadata

Metadata of source database server.

SourceDbServerResourceId

Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username.

SourceType

Source server type used for the migration: 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, or Supabase_PostgreSQL.

SslMode

SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.

StartDataMigration

Indicates if data migration must start right away.

SystemData

Gets the SystemData.

Tags

Gets or sets the Tags.

TargetDbServerFullyQualifiedDomainName

Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server.

TargetDbServerMetadata

Metadata of target database server.

TargetDbServerResourceId

Identifier of the target database server resource.

TriggerCutover

Indicates if cutover must be triggered for the entire migration.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of PostgreSqlMigration.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing PostgreSqlMigration.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to