Microsoft.DBforPostgreSQL flexibleServers/migrations 2024-08-01
Bicep リソース定義
flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、次の Bicep をテンプレートに追加します。
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'
}
}
プロパティ値
AdminCredentials
| 名前 | 形容 | 価値 |
|---|---|---|
| sourceServerPassword | ソース サーバーのパスワード。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| targetServerPassword | ターゲット サーバーのパスワード。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
Microsoft.DBforPostgreSQL/flexibleServers/migrations
| 名前 | 形容 | 価値 |
|---|---|---|
| 場所 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約： パターン = ^[a-z][a-z0-9]*$ (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: flexibleServers |
| プロパティ | 移行リソースのプロパティ。 | MigrationResourceProperties |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
MigrationResourceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| キャンセル | 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
| dbsToCancelMigrationOn | 特定のデータベースの取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| dbsToMigrate | 移行するデータベースの数 | string[] |
| dbsToTriggerCutoverOn | 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| migrateRoles | ロールとアクセス許可を移行するには、このフラグを True として送信する必要があります | 'False' 'True' |
| migrationInstanceResourceId | プライベート エンドポイント移行インスタンスの ResourceId | 糸 |
| migrationMode | オンラインとオフラインの 2 種類の移行モードがあります | 'オフライン' 'Online' |
| migrationOption | これは、移行でサポートされている移行オプションを示します | 'Migrate' 'Validate' 'ValidateAndMigrate' |
| migrationWindowEndTimeInUtc | 移行期間の終了時刻 (UTC) | 糸 |
| migrationWindowStartTimeInUtc | 移行期間の UTC での開始時刻 | 糸 |
| overwriteDbsInTarget | ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 | 'False' 'True' |
| secretParameters | 移行シークレット パラメーター | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDbIfNeeded | 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します | 'False' 'True' |
| sourceDbServerFullyQualifiedDomainName | ソース サーバーの完全修飾ドメイン名 (FQDN) または IP アドレス。 これは省略可能な値です。顧客が指定した場合、移行サービスは常に接続に使用します | 糸 |
| sourceDbServerResourceId | sourceType が PostgreSQLSingleServer の場合のソース データベース サーバーの ResourceId。 その他のソースの種類の場合、これは ipaddress:port@username または hostname:port@username である必要があります | 糸 |
| sourceType | 移行元サーバーの種類: OnPremises、AWS、GCP、AzureVM、PostgreSQLSingleServer、AWS_RDS、AWS_AURORA、AWS_EC2、GCP_CloudSQL、GCP_AlloyDB、GCP_Compute、または EDB | 'AWS' 'AWS_AURORA' 'AWS_EC2' 'AWS_RDS' 'AzureVM' 'EDB' 'GCP' 'GCP_AlloyDB' 'GCP_CloudSQL' 'GCP_Compute' 'OnPremises' 'PostgreSQLSingleServer' |
| sslMode | 移行用の SSL モード。 PostgreSQLSingleServer の既定の SSL モードは VerifyFull であり、他のソースの種類には優先されます | 'Prefer' 'Require' 'VerifyCA' 'VerifyFull' |
| startDataMigration | データ移行をすぐに開始するかどうかを示します | 'False' 'True' |
| targetDbServerFullyQualifiedDomainName | ターゲット サーバーの完全修飾ドメイン名 (FQDN) または IP アドレス。 これは省略可能な値です。顧客が指定した場合、移行サービスは常に接続に使用します | 糸 |
| triggerCutover | 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
MigrationSecretParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| adminCredentials | ソース サーバーとターゲット サーバーの管理者資格情報 | AdminCredentials (必須) |
| sourceServerUsername | ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
| targetServerUsername | ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
TrackedResourceTags
| 名前 | 形容 | 価値 |
|---|
ARM テンプレート リソース定義
flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、テンプレートに次の JSON を追加します。
{
"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"
}
}
プロパティ値
AdminCredentials
| 名前 | 形容 | 価値 |
|---|---|---|
| sourceServerPassword | ソース サーバーのパスワード。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| targetServerPassword | ターゲット サーバーのパスワード。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
Microsoft.DBforPostgreSQL/flexibleServers/migrations
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2024-08-01' |
| 場所 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約： パターン = ^[a-z][a-z0-9]*$ (必須) |
| プロパティ | 移行リソースのプロパティ。 | MigrationResourceProperties |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
| 種類 | リソースの種類 | 'Microsoft.DBforPostgreSQL/flexibleServers/migrations' |
MigrationResourceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| キャンセル | 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
| dbsToCancelMigrationOn | 特定のデータベースの取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| dbsToMigrate | 移行するデータベースの数 | string[] |
| dbsToTriggerCutoverOn | 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| migrateRoles | ロールとアクセス許可を移行するには、このフラグを True として送信する必要があります | 'False' 'True' |
| migrationInstanceResourceId | プライベート エンドポイント移行インスタンスの ResourceId | 糸 |
| migrationMode | オンラインとオフラインの 2 種類の移行モードがあります | 'オフライン' 'Online' |
| migrationOption | これは、移行でサポートされている移行オプションを示します | 'Migrate' 'Validate' 'ValidateAndMigrate' |
| migrationWindowEndTimeInUtc | 移行期間の終了時刻 (UTC) | 糸 |
| migrationWindowStartTimeInUtc | 移行期間の UTC での開始時刻 | 糸 |
| overwriteDbsInTarget | ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 | 'False' 'True' |
| secretParameters | 移行シークレット パラメーター | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDbIfNeeded | 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します | 'False' 'True' |
| sourceDbServerFullyQualifiedDomainName | ソース サーバーの完全修飾ドメイン名 (FQDN) または IP アドレス。 これは省略可能な値です。顧客が指定した場合、移行サービスは常に接続に使用します | 糸 |
| sourceDbServerResourceId | sourceType が PostgreSQLSingleServer の場合のソース データベース サーバーの ResourceId。 その他のソースの種類の場合、これは ipaddress:port@username または hostname:port@username である必要があります | 糸 |
| sourceType | 移行元サーバーの種類: OnPremises、AWS、GCP、AzureVM、PostgreSQLSingleServer、AWS_RDS、AWS_AURORA、AWS_EC2、GCP_CloudSQL、GCP_AlloyDB、GCP_Compute、または EDB | 'AWS' 'AWS_AURORA' 'AWS_EC2' 'AWS_RDS' 'AzureVM' 'EDB' 'GCP' 'GCP_AlloyDB' 'GCP_CloudSQL' 'GCP_Compute' 'OnPremises' 'PostgreSQLSingleServer' |
| sslMode | 移行用の SSL モード。 PostgreSQLSingleServer の既定の SSL モードは VerifyFull であり、他のソースの種類には優先されます | 'Prefer' 'Require' 'VerifyCA' 'VerifyFull' |
| startDataMigration | データ移行をすぐに開始するかどうかを示します | 'False' 'True' |
| targetDbServerFullyQualifiedDomainName | ターゲット サーバーの完全修飾ドメイン名 (FQDN) または IP アドレス。 これは省略可能な値です。顧客が指定した場合、移行サービスは常に接続に使用します | 糸 |
| triggerCutover | 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
MigrationSecretParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| adminCredentials | ソース サーバーとターゲット サーバーの管理者資格情報 | AdminCredentials (必須) |
| sourceServerUsername | ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
| targetServerUsername | ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
TrackedResourceTags
| 名前 | 形容 | 価値 |
|---|
Terraform (AzAPI プロバイダー) リソース定義
flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、次の Terraform をテンプレートに追加します。
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"
}
}
プロパティ値
AdminCredentials
| 名前 | 形容 | 価値 |
|---|---|---|
| sourceServerPassword | ソース サーバーのパスワード。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| targetServerPassword | ターゲット サーバーのパスワード。 | 糸 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
Microsoft.DBforPostgreSQL/flexibleServers/migrations
| 名前 | 形容 | 価値 |
|---|---|---|
| 場所 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約： パターン = ^[a-z][a-z0-9]*$ (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: flexibleServers |
| プロパティ | 移行リソースのプロパティ。 | MigrationResourceProperties |
| タグ | リソース タグ | タグ名と値のディクショナリ。 |
| 種類 | リソースの種類 | "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2024-08-01" |
MigrationResourceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| キャンセル | 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
| dbsToCancelMigrationOn | 特定のデータベースの取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| dbsToMigrate | 移行するデータベースの数 | string[] |
| dbsToTriggerCutoverOn | 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| migrateRoles | ロールとアクセス許可を移行するには、このフラグを True として送信する必要があります | 'False' 'True' |
| migrationInstanceResourceId | プライベート エンドポイント移行インスタンスの ResourceId | 糸 |
| migrationMode | オンラインとオフラインの 2 種類の移行モードがあります | 'オフライン' 'Online' |
| migrationOption | これは、移行でサポートされている移行オプションを示します | 'Migrate' 'Validate' 'ValidateAndMigrate' |
| migrationWindowEndTimeInUtc | 移行期間の終了時刻 (UTC) | 糸 |
| migrationWindowStartTimeInUtc | 移行期間の UTC での開始時刻 | 糸 |
| overwriteDbsInTarget | ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 | 'False' 'True' |
| secretParameters | 移行シークレット パラメーター | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDbIfNeeded | 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します | 'False' 'True' |
| sourceDbServerFullyQualifiedDomainName | ソース サーバーの完全修飾ドメイン名 (FQDN) または IP アドレス。 これは省略可能な値です。顧客が指定した場合、移行サービスは常に接続に使用します | 糸 |
| sourceDbServerResourceId | sourceType が PostgreSQLSingleServer の場合のソース データベース サーバーの ResourceId。 その他のソースの種類の場合、これは ipaddress:port@username または hostname:port@username である必要があります | 糸 |
| sourceType | 移行元サーバーの種類: OnPremises、AWS、GCP、AzureVM、PostgreSQLSingleServer、AWS_RDS、AWS_AURORA、AWS_EC2、GCP_CloudSQL、GCP_AlloyDB、GCP_Compute、または EDB | 'AWS' 'AWS_AURORA' 'AWS_EC2' 'AWS_RDS' 'AzureVM' 'EDB' 'GCP' 'GCP_AlloyDB' 'GCP_CloudSQL' 'GCP_Compute' 'OnPremises' 'PostgreSQLSingleServer' |
| sslMode | 移行用の SSL モード。 PostgreSQLSingleServer の既定の SSL モードは VerifyFull であり、他のソースの種類には優先されます | 'Prefer' 'Require' 'VerifyCA' 'VerifyFull' |
| startDataMigration | データ移行をすぐに開始するかどうかを示します | 'False' 'True' |
| targetDbServerFullyQualifiedDomainName | ターゲット サーバーの完全修飾ドメイン名 (FQDN) または IP アドレス。 これは省略可能な値です。顧客が指定した場合、移行サービスは常に接続に使用します | 糸 |
| triggerCutover | 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
MigrationSecretParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| adminCredentials | ソース サーバーとターゲット サーバーの管理者資格情報 | AdminCredentials (必須) |
| sourceServerUsername | ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
| targetServerUsername | ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
TrackedResourceTags
| 名前 | 形容 | 価値 |
|---|