az synapse link-connection

Synapse のリンク接続を管理します。

コマンド

名前	説明	型	状態
az synapse link-connection create	リンク接続を作成します。	コア	GA
az synapse link-connection delete	リンク接続を削除します。	コア	GA
az synapse link-connection edit-link-tables	リンク接続のテーブルを編集します。	コア	GA
az synapse link-connection get-link-tables-status	リンク接続のリンク テーブルの状態を照会します。	コア	GA
az synapse link-connection get-status	リンク接続の開始/停止後に、リンク接続の状態を確認します。	コア	GA
az synapse link-connection list	synapse ワークスペース内のリンク接続を一覧表示します。	コア	GA
az synapse link-connection list-link-tables	リンク接続のリンク テーブルを一覧表示します。	コア	GA
az synapse link-connection show	リンク接続を取得します。	コア	GA
az synapse link-connection start	リンク接続を開始します。	コア	GA
az synapse link-connection stop	リンク接続を停止します。	コア	GA
az synapse link-connection update	リンク接続を更新します。	コア	GA
az synapse link-connection update-landing-zone-credential	リンク接続のランディング ゾーンの信頼性を更新します。	コア	GA

az synapse link-connection create

リンク接続を作成します。

az synapse link-connection create --file
                                  --name
                                  --workspace-name

例

リンク接続を作成します。 Definition.json sample is { "name":"sampleLinkConnection", // please change to your link connection name "properties":{ "sourceDatabase":{ "typeProperties":{ // please change to your source database resourceId and principalId "resourceId":"/subscriptions/sampleSubscriptionId/resourceGroups/sampleResourceGroup/providers/Microsoft.Sql/servers/sampleServer", "principalId":"xxxxxxxxxx" }, "linkedService":{ "referenceName":"sampleLinkServiceReference", // ソースに変更してくださいデータベース リンク サービス名 "type":"LinkedServiceReference" } }, "targetDatabase":{ "linkedService":{ "referenceName":"sampleLinkServiceReference", // ターゲット データベース リンク サービス名 "type":"LinkedServiceReference", "parameters":{ "DBName":"v2" } } }, "compute":{ "coreCount":16, "computeType":"General" } } } }

az synapse link-connection create --workspace-name testsynapseworkspace \
  --name testlinkconnectionname \
  --file @"path/definition.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection delete

リンク接続を削除します。

az synapse link-connection delete --name
                                  --workspace-name

例

リンク接続を削除します。

az synapse link-connection delete --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection edit-link-tables

リンク接続のテーブルを編集します。

az synapse link-connection edit-link-tables --file
                                            --name
                                            --workspace-name

例

リンク接続のテーブルを編集します。 ファイル パターンは { "linkTables":[ { "id":"000000000000000000000000000000000000000000000000000"、 // リンク テーブル ID に uuid "source":{ "tableName":"sampleSourceTable"、 // ソース テーブル名 "schemaName":"sampleSourceSchema" に変更してください// ソース データベース スキーマ名 }、"target":{ "tableName":"sampleTargetTable"、// ターゲット テーブル名 "schemaName":"sampleTargetSchema"、// をターゲット データベース スキーマ名に変更してください"distributionOptions":{ "type":"Round_RoBin", // Hash, Round_RoBin, Replicate "distributionColumn":"sampleColumn" // please change to the column name } }, "operationType":"add" // please choose a value from add, update, remove } ] } }

az synapse link-connection edit-link-tables --workspace-name testsynapseworkspace \
  --name linkconnectionname \
  --file @path/edittablerequestfile.json

必須のパラメーター

--file -f

リンク テーブルのファイル パスを編集します。ファイル形式は --help を使用して表示できます。

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection get-link-tables-status

リンク接続のリンク テーブルの状態を照会します。

az synapse link-connection get-link-tables-status --name
                                                  --workspace-name
                                                  [--continuation-token]
                                                  [--max-segment-count]

例

リンク接続のリンク テーブルの状態を照会します。

az synapse link-connection get-link-tables-status --workspace-name testsynapseworkspace \
  --name linkconnectionname \
  --max-segment-count 50 \
  --continuation-token token

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

省略可能のパラメーター

--continuation-token

テーブルの状態を照会する継続トークン。

--max-segment-count

クエリ テーブルの状態に対する最大セグメント数。

規定値: 50

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection get-status

リンク接続の開始/停止後に、リンク接続の状態を確認します。

az synapse link-connection get-status --name
                                      --workspace-name

例

リンク接続を停止します。

az synapse link-connection get-status --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection list

synapse ワークスペース内のリンク接続を一覧表示します。

az synapse link-connection list --workspace-name

例

リンク接続を一覧表示します。

az synapse link-connection list --workspace-name testsynapseworkspace

必須のパラメーター

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection list-link-tables

リンク接続のリンク テーブルを一覧表示します。

az synapse link-connection list-link-tables --name
                                            --workspace-name

例

リンク接続のリンク テーブルを一覧表示します。

az synapse link-connection list-link-tables --workspace-name testsynapseworkspace \
  --name linkconnectionname \

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection show

リンク接続を取得します。

az synapse link-connection show --name
                                --workspace-name

例

リンク接続を取得します。

az synapse link-connection show --workspace-name testsynapseworkspace \
  --name testlinkconectionname

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection start

リンク接続を開始します。

az synapse link-connection start --name
                                 --workspace-name

例

リンク接続を開始します。

az synapse link-connection start --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection stop

リンク接続を停止します。

az synapse link-connection stop --name
                                --workspace-name

例

リンク接続を停止します。

az synapse link-connection stop --workspace-name testsynapseworkspace \
  --name testlinkconnectionname

必須のパラメーター

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection update

リンク接続を更新します。

az synapse link-connection update --file
                                  --name
                                  --workspace-name

例

リンク接続を更新します。 Definition.json sample is { "name":"sampleLinkConnection", // please change to your link connection name "properties":{ "sourceDatabase":{ "typeProperties":{ // please change to your source database resourceId and principalId "resourceId":"/subscriptions/sampleSubscriptionId/resourceGroups/sampleResourceGroup/providers/Microsoft.Sql/servers/sampleServer", "principalId":"xxxxxxxxxx" }, "linkedService":{ "referenceName":"sampleLinkServiceReference", // ソースに変更してくださいデータベース リンク サービス名 "type":"LinkedServiceReference" } }, "targetDatabase":{ "linkedService":{ "referenceName":"sampleLinkServiceReference", // ターゲット データベース リンク サービス名 "type":"LinkedServiceReference", "parameters":{ "DBName":"v2" } } }, "compute":{ "coreCount":16, "computeType":"General" } } } }

az synapse link-connection update --workspace-name testsynapseworkspace \
  --name testlinkconnectionname \
  --file @"path/definition.json"

必須のパラメーター

--file

プロパティは、構文または JSON 文字列を使用して @{path} JSON ファイルから指定できます。

--name -n

リンク接続名。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az synapse link-connection update-landing-zone-credential

リンク接続のランディング ゾーンの信頼性を更新します。

az synapse link-connection update-landing-zone-credential --name
                                                          --sas-token
                                                          --workspace-name

例

リンク接続のランディング ゾーンの信頼性を更新します。

az synapse link-connection update-landing-zone-credential --workspace-name testsynapseworkspace \
  --name linkconnectionname \
  --sas-token sastoken

必須のパラメーター

--name -n

リンク接続名。

--sas-token

セキュリティで保護された文字列の値。

--workspace-name

ワークスペース名。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。