Microsoft.DBforPostgreSQL flexibleServers/migrations 2022-05-01-preview
Bicep resource definition
The flexibleServers/migrations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DBforPostgreSQL/flexibleServers/migrations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2022-05-01-preview' = {
location: 'string'
name: 'string'
properties: {
cancel: bool
dBsToCancelMigrationOn: [
'string'
]
dBsToMigrate: [
'string'
]
dBsToTiggerCutoverOn: [
'string'
]
migrationMode: 'string'
migrationWindowStartTimeInUtc: 'string'
overwriteDBsInTarget: bool
secretParameters: {
adminCredentials: {
sourceServerPassword: 'string'
targetServerPassword: 'string'
}
}
setupLogicalReplicationOnSourceDBIfNeeded: bool
sourceDBServerFullyQualifiedDomainName: 'string'
sourceDBServerResourceId: 'string'
startDataMigration: bool
targetDBServerFullyQualifiedDomainName: 'string'
triggerCutover: bool
}
tags: {
{customized property}: 'string'
}
}
Property values
AdminCredentials
| Name | Description | Value |
|---|---|---|
| sourceServerPassword | string Constraints: Sensitive value. Pass in as a secure parameter. (required) |
|
| targetServerPassword | string Constraints: Sensitive value. Pass in as a secure parameter. (required) |
Microsoft.DBforPostgreSQL/flexibleServers/migrations
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-z][a-z0-9]*$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: flexibleServers |
| properties | Migration resource properties. | MigrationResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
MigrationResourceProperties
| Name | Description | Value |
|---|---|---|
| cancel | To trigger cancel for entire migration we need to send this flag as true | bool |
| dBsToCancelMigrationOn | When you want to trigger cancel for specific databases send triggerCutover flag as true and database names in this array | string[] |
| dBsToMigrate | string[] | |
| dBsToTiggerCutoverOn | When you want to trigger cutover for specific databases send triggerCutover flag as true and database names in this array | string[] |
| migrationMode | There are two types of migration modes Online and Offline | 'Offline' 'Online' |
| migrationWindowStartTimeInUtc | string | |
| overwriteDBsInTarget | bool | |
| secretParameters | Migration secret parameters. | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDBIfNeeded | bool | |
| sourceDBServerFullyQualifiedDomainName | string | |
| sourceDBServerResourceId | string | |
| startDataMigration | bool | |
| targetDBServerFullyQualifiedDomainName | string | |
| triggerCutover | To trigger cutover for entire migration we need to send this flag as true | bool |
MigrationSecretParameters
| Name | Description | Value |
|---|---|---|
| adminCredentials | Server admin credentials. | AdminCredentials (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The flexibleServers/migrations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DBforPostgreSQL/flexibleServers/migrations resource, add the following JSON to your template.
{
"type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
"apiVersion": "2022-05-01-preview",
"name": "string",
"location": "string",
"properties": {
"cancel": "bool",
"dBsToCancelMigrationOn": [ "string" ],
"dBsToMigrate": [ "string" ],
"dBsToTiggerCutoverOn": [ "string" ],
"migrationMode": "string",
"migrationWindowStartTimeInUtc": "string",
"overwriteDBsInTarget": "bool",
"secretParameters": {
"adminCredentials": {
"sourceServerPassword": "string",
"targetServerPassword": "string"
}
},
"setupLogicalReplicationOnSourceDBIfNeeded": "bool",
"sourceDBServerFullyQualifiedDomainName": "string",
"sourceDBServerResourceId": "string",
"startDataMigration": "bool",
"targetDBServerFullyQualifiedDomainName": "string",
"triggerCutover": "bool"
},
"tags": {
"{customized property}": "string"
}
}
Property values
AdminCredentials
| Name | Description | Value |
|---|---|---|
| sourceServerPassword | string Constraints: Sensitive value. Pass in as a secure parameter. (required) |
|
| targetServerPassword | string Constraints: Sensitive value. Pass in as a secure parameter. (required) |
Microsoft.DBforPostgreSQL/flexibleServers/migrations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-05-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-z][a-z0-9]*$ (required) |
| properties | Migration resource properties. | MigrationResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DBforPostgreSQL/flexibleServers/migrations' |
MigrationResourceProperties
| Name | Description | Value |
|---|---|---|
| cancel | To trigger cancel for entire migration we need to send this flag as true | bool |
| dBsToCancelMigrationOn | When you want to trigger cancel for specific databases send triggerCutover flag as true and database names in this array | string[] |
| dBsToMigrate | string[] | |
| dBsToTiggerCutoverOn | When you want to trigger cutover for specific databases send triggerCutover flag as true and database names in this array | string[] |
| migrationMode | There are two types of migration modes Online and Offline | 'Offline' 'Online' |
| migrationWindowStartTimeInUtc | string | |
| overwriteDBsInTarget | bool | |
| secretParameters | Migration secret parameters. | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDBIfNeeded | bool | |
| sourceDBServerFullyQualifiedDomainName | string | |
| sourceDBServerResourceId | string | |
| startDataMigration | bool | |
| targetDBServerFullyQualifiedDomainName | string | |
| triggerCutover | To trigger cutover for entire migration we need to send this flag as true | bool |
MigrationSecretParameters
| Name | Description | Value |
|---|---|---|
| adminCredentials | Server admin credentials. | AdminCredentials (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The flexibleServers/migrations resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DBforPostgreSQL/flexibleServers/migrations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2022-05-01-preview"
name = "string"
location = "string"
body = jsonencode({
properties = {
cancel = bool
dBsToCancelMigrationOn = [
"string"
]
dBsToMigrate = [
"string"
]
dBsToTiggerCutoverOn = [
"string"
]
migrationMode = "string"
migrationWindowStartTimeInUtc = "string"
overwriteDBsInTarget = bool
secretParameters = {
adminCredentials = {
sourceServerPassword = "string"
targetServerPassword = "string"
}
}
setupLogicalReplicationOnSourceDBIfNeeded = bool
sourceDBServerFullyQualifiedDomainName = "string"
sourceDBServerResourceId = "string"
startDataMigration = bool
targetDBServerFullyQualifiedDomainName = "string"
triggerCutover = bool
}
})
tags = {
{customized property} = "string"
}
}
Property values
AdminCredentials
| Name | Description | Value |
|---|---|---|
| sourceServerPassword | string Constraints: Sensitive value. Pass in as a secure parameter. (required) |
|
| targetServerPassword | string Constraints: Sensitive value. Pass in as a secure parameter. (required) |
Microsoft.DBforPostgreSQL/flexibleServers/migrations
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-z][a-z0-9]*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: flexibleServers |
| properties | Migration resource properties. | MigrationResourceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2022-05-01-preview" |
MigrationResourceProperties
| Name | Description | Value |
|---|---|---|
| cancel | To trigger cancel for entire migration we need to send this flag as true | bool |
| dBsToCancelMigrationOn | When you want to trigger cancel for specific databases send triggerCutover flag as true and database names in this array | string[] |
| dBsToMigrate | string[] | |
| dBsToTiggerCutoverOn | When you want to trigger cutover for specific databases send triggerCutover flag as true and database names in this array | string[] |
| migrationMode | There are two types of migration modes Online and Offline | 'Offline' 'Online' |
| migrationWindowStartTimeInUtc | string | |
| overwriteDBsInTarget | bool | |
| secretParameters | Migration secret parameters. | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDBIfNeeded | bool | |
| sourceDBServerFullyQualifiedDomainName | string | |
| sourceDBServerResourceId | string | |
| startDataMigration | bool | |
| targetDBServerFullyQualifiedDomainName | string | |
| triggerCutover | To trigger cutover for entire migration we need to send this flag as true | bool |
MigrationSecretParameters
| Name | Description | Value |
|---|---|---|
| adminCredentials | Server admin credentials. | AdminCredentials (required) |
TrackedResourceTags
| Name | Description | Value |
|---|