Microsoft.DBforPostgreSQL flexibleServers/migrations 2023-03-01-preview
Bicep リソース定義
flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
cancel: 'string'
dbsToCancelMigrationOn: [
'string'
]
dbsToMigrate: [
'string'
]
dbsToTriggerCutoverOn: [
'string'
]
migrationMode: 'string'
migrationWindowEndTimeInUtc: 'string'
migrationWindowStartTimeInUtc: 'string'
overwriteDbsInTarget: 'string'
secretParameters: {
adminCredentials: {
sourceServerPassword: 'string'
targetServerPassword: 'string'
}
sourceServerUsername: 'string'
targetServerUsername: 'string'
}
setupLogicalReplicationOnSourceDbIfNeeded: 'string'
sourceDbServerFullyQualifiedDomainName: 'string'
sourceDbServerResourceId: 'string'
startDataMigration: 'string'
targetDbServerFullyQualifiedDomainName: 'string'
triggerCutover: 'string'
}
}
プロパティ値
flexibleServers/migrations
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 Bicepで子リソースの名前と種類 |
string (必須) |
| 場所 | リソースが存在する地理的な場所 | string (必須) |
| タグ | リソース タグ。 | タグ名と値のディクショナリ。 テンプレート の |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: flexibleServers |
| プロパティ | 移行リソースのプロパティ。 | MigrationResourceProperties |
MigrationResourceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| キャンセル | 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
| dbsToCancelMigrationOn | 特定のデータベースの取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| dbsToMigrate | 移行するデータベースの数 | string[] 制約： 最大長 = 50 |
| dbsToTriggerCutoverOn | 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| migrationMode | オンラインとオフラインの 2 種類の移行モードがあります | 'オフライン' 'Online' |
| migrationWindowEndTimeInUtc | 移行期間の終了時刻 (UTC) | 糸 |
| migrationWindowStartTimeInUtc | 移行期間の UTC での開始時刻 | 糸 |
| overwriteDbsInTarget | ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 | 'False' 'True' |
| secretParameters | 移行シークレット パラメーター | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDbIfNeeded | 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します | 'False' 'True' |
| sourceDbServerFullyQualifiedDomainName | ソース サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します | 糸 |
| sourceDbServerResourceId | ソース データベース サーバーの ResourceId | 糸 |
| startDataMigration | データ移行をすぐに開始するかどうかを示します | 'False' 'True' |
| targetDbServerFullyQualifiedDomainName | ターゲット サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します | 糸 |
| triggerCutover | 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
MigrationSecretParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| adminCredentials | ソース サーバーとターゲット サーバーの管理者資格情報 | AdminCredentials (必須) |
| sourceServerUsername | ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
| targetServerUsername | ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
AdminCredentials
| 名前 | 形容 | 価値 |
|---|---|---|
| sourceServerPassword | ソース サーバーのパスワード。 | string (必須) 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| targetServerPassword | ターゲット サーバーのパスワード。 | string (必須) 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
ARM テンプレート リソース定義
flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations",
"apiVersion": "2023-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"cancel": "string",
"dbsToCancelMigrationOn": [ "string" ],
"dbsToMigrate": [ "string" ],
"dbsToTriggerCutoverOn": [ "string" ],
"migrationMode": "string",
"migrationWindowEndTimeInUtc": "string",
"migrationWindowStartTimeInUtc": "string",
"overwriteDbsInTarget": "string",
"secretParameters": {
"adminCredentials": {
"sourceServerPassword": "string",
"targetServerPassword": "string"
},
"sourceServerUsername": "string",
"targetServerUsername": "string"
},
"setupLogicalReplicationOnSourceDbIfNeeded": "string",
"sourceDbServerFullyQualifiedDomainName": "string",
"sourceDbServerResourceId": "string",
"startDataMigration": "string",
"targetDbServerFullyQualifiedDomainName": "string",
"triggerCutover": "string"
}
}
プロパティ値
flexibleServers/migrations
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | 'Microsoft.DBforPostgreSQL/flexibleServers/migrations' |
| apiVersion | リソース API のバージョン | '2023-03-01-preview' |
| 名前 | リソース名 JSON ARM テンプレートで子リソースの名前と型 |
string (必須) |
| 場所 | リソースが存在する地理的な場所 | string (必須) |
| タグ | リソース タグ。 | タグ名と値のディクショナリ。 テンプレート の |
| プロパティ | 移行リソースのプロパティ。 | MigrationResourceProperties |
MigrationResourceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| キャンセル | 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
| dbsToCancelMigrationOn | 特定のデータベースの取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| dbsToMigrate | 移行するデータベースの数 | string[] 制約： 最大長 = 50 |
| dbsToTriggerCutoverOn | 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| migrationMode | オンラインとオフラインの 2 種類の移行モードがあります | 'オフライン' 'Online' |
| migrationWindowEndTimeInUtc | 移行期間の終了時刻 (UTC) | 糸 |
| migrationWindowStartTimeInUtc | 移行期間の UTC での開始時刻 | 糸 |
| overwriteDbsInTarget | ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 | 'False' 'True' |
| secretParameters | 移行シークレット パラメーター | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDbIfNeeded | 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します | 'False' 'True' |
| sourceDbServerFullyQualifiedDomainName | ソース サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します | 糸 |
| sourceDbServerResourceId | ソース データベース サーバーの ResourceId | 糸 |
| startDataMigration | データ移行をすぐに開始するかどうかを示します | 'False' 'True' |
| targetDbServerFullyQualifiedDomainName | ターゲット サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します | 糸 |
| triggerCutover | 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります | 'False' 'True' |
MigrationSecretParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| adminCredentials | ソース サーバーとターゲット サーバーの管理者資格情報 | AdminCredentials (必須) |
| sourceServerUsername | ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
| targetServerUsername | ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
AdminCredentials
| 名前 | 形容 | 価値 |
|---|---|---|
| sourceServerPassword | ソース サーバーのパスワード。 | string (必須) 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| targetServerPassword | ターゲット サーバーのパスワード。 | string (必須) 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
Terraform (AzAPI プロバイダー) リソース定義
flexibleServers/migrations リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DBforPostgreSQL/flexibleServers/migrations リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
cancel = "string"
dbsToCancelMigrationOn = [
"string"
]
dbsToMigrate = [
"string"
]
dbsToTriggerCutoverOn = [
"string"
]
migrationMode = "string"
migrationWindowEndTimeInUtc = "string"
migrationWindowStartTimeInUtc = "string"
overwriteDbsInTarget = "string"
secretParameters = {
adminCredentials = {
sourceServerPassword = "string"
targetServerPassword = "string"
}
sourceServerUsername = "string"
targetServerUsername = "string"
}
setupLogicalReplicationOnSourceDbIfNeeded = "string"
sourceDbServerFullyQualifiedDomainName = "string"
sourceDbServerResourceId = "string"
startDataMigration = "string"
targetDbServerFullyQualifiedDomainName = "string"
triggerCutover = "string"
}
})
}
プロパティ値
flexibleServers/migrations
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | "Microsoft.DBforPostgreSQL/flexibleServers/migrations@2023-03-01-preview" |
| 名前 | リソース名 | string (必須) |
| 場所 | リソースが存在する地理的な場所 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: flexibleServers |
| タグ | リソース タグ。 | タグ名と値のディクショナリ。 |
| プロパティ | 移行リソースのプロパティ。 | MigrationResourceProperties |
MigrationResourceProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| キャンセル | 移行全体のキャンセルをトリガーするには、このフラグを True として送信する必要があります | "False" "True" |
| dbsToCancelMigrationOn | 特定のデータベースの取り消しをトリガーする場合は、キャンセル フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| dbsToMigrate | 移行するデータベースの数 | string[] 制約： 最大長 = 50 |
| dbsToTriggerCutoverOn | 特定のデータベースのカットオーバーをトリガーする場合は、triggerCutover フラグを True として送信し、この配列内のデータベース名を送信します | string[] |
| migrationMode | オンラインとオフラインの 2 種類の移行モードがあります | "オフライン" "オンライン" |
| migrationWindowEndTimeInUtc | 移行期間の終了時刻 (UTC) | 糸 |
| migrationWindowStartTimeInUtc | 移行期間の UTC での開始時刻 | 糸 |
| overwriteDbsInTarget | ターゲット サーバー上のデータベースが既に存在する場合に上書きできるかどうかを示します。 False に設定すると、データベースが既に存在することが検出された場合、移行ワークフローは確認を待機します。 | "False" "True" |
| secretParameters | 移行シークレット パラメーター | MigrationSecretParameters |
| setupLogicalReplicationOnSourceDbIfNeeded | 必要に応じて LogicalReplicationOnSourceDb をセットアップするかどうかを示します | "False" "True" |
| sourceDbServerFullyQualifiedDomainName | ソース サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します | 糸 |
| sourceDbServerResourceId | ソース データベース サーバーの ResourceId | 糸 |
| startDataMigration | データ移行をすぐに開始するかどうかを示します | "False" "True" |
| targetDbServerFullyQualifiedDomainName | ターゲット サーバーの完全修飾ドメイン名または IP。 これは省略可能な値です。顧客が指定した場合、dms は常に接続に使用します | 糸 |
| triggerCutover | 移行全体のカットオーバーをトリガーするには、このフラグを True として送信する必要があります | "False" "True" |
MigrationSecretParameters
| 名前 | 形容 | 価値 |
|---|---|---|
| adminCredentials | ソース サーバーとターゲット サーバーの管理者資格情報 | AdminCredentials (必須) |
| sourceServerUsername | ソース サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
| targetServerUsername | ターゲット サーバーのユーザー名を取得または設定します。 このユーザーは管理者である必要はありません。 | 糸 |
AdminCredentials
| 名前 | 形容 | 価値 |
|---|---|---|
| sourceServerPassword | ソース サーバーのパスワード。 | string (必須) 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| targetServerPassword | ターゲット サーバーのパスワード。 | string (必須) 制約： 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |