azdata bdc config

[アーティクル]
01/02/2025

適用対象: Azure Data CLI (azdata)

以下の記事では、azdata ツールの sql コマンドに関するリファレンスを提供します。他の azdata コマンドの詳細については、azdata リファレンスに関するページを参照してください。

コマンド

command	説明
azdata bdc config init	bdc 作成で使用できるビッグデータクラスター構成プロファイルを初期化します。
azdata bdc config list	使用可能な構成プロファイルの選択肢を一覧表示します。
azdata bdc config show	BDC の現在の構成、または指定したローカルファイル (custom/bdc.json など) の構成を表示します。
azdata bdc config add	構成ファイル内の json パスの値を追加します。
azdata bdc config remove	構成ファイル内の json パスの値を削除します。
azdata bdc config replace	構成ファイル内の json パスの値を置き換えます。
azdata bdc config patch	json 修正プログラムファイルに基づいて、構成ファイルに修正プログラムを適用します。

azdata bdc config init

bdc 作成で使用できるビッグデータクラスター構成プロファイルを初期化します。構成プロファイルの特定のソースを引数で指定できます。

azdata bdc config init [--path -p] 
                       [--source -s]  
                       
[--force -f]  
                       
[--accept-eula -a]

例

ガイド付きの BDC 構成の初期化エクスペリエンス - 必要な値の入力を求めるプロンプトが表示されます。

azdata bdc config init

引数を指定した BDC 構成の初期化では、./custom 内に aks-dev-test の構成プロファイルが作成されます。

azdata bdc config init --source aks-dev-test --target custom

省略可能なパラメーター

`--path -p`

構成プロファイルが配置される場所のファイルパス。既定値は <cwd>/custom です。

`--source -s`

構成プロファイルのソース: ['kubeadm-dev-test', 'kubeadm-prod', 'openshift-prod', 'aks-dev-test-ha', 'aks-dev-test', 'aro-dev-test', 'openshift-dev-test', 'aro-dev-test-ha']

`--force -f`

ターゲットファイルを強制的に上書きします。

`--accept-eula -a`

Do you accept the license terms? (ライセンス条項に同意しますか?) [yes/no]. ([はい/いいえ]。) この引数を使用しない場合は、環境変数 ACCEPT_EULA を 'yes' に設定できます。この製品のライセンス条項は https://aka.ms/eula-azdata-en で確認できます。

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

azdata bdc config list

bdc config init で使用可能な構成プロファイルの選択肢を一覧表示します。

azdata bdc config list [--config-profile -c] 
                       [--type -t]  
                       
[--accept-eula -a]

例

使用可能なすべての構成プロファイル名を表示します。

azdata bdc config list

特定の構成プロファイルの json を表示します。

azdata bdc config list --config-profile aks-dev-test

省略可能なパラメーター

`--config-profile -c`

既定の構成プロファイル: ['kubeadm-dev-test', 'kubeadm-prod', 'openshift-prod', 'aks-dev-test-ha', 'aks-dev-test', 'aro-dev-test', 'openshift-dev-test', 'aro-dev-test-ha']

`--type -t`

表示する構成の種類。

`--accept-eula -a`

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

azdata bdc config show

BDC の現在の構成、または指定したローカルファイル (custom/bdc.json など) の構成を表示します。このコマンドでは、セクションのみを取得したい場合、json パスを取得することもできます。また、出力先のターゲットファイルを指定することもできます。ターゲットファイルが指定されていない場合は、ターミナルにのみ出力されます。

azdata bdc config show [--config-file -c] 
                       [--target -t]  
                       
[--json-path -j]  
                       
[--force -f]

例

BDC 構成をコンソールに表示します

azdata bdc config show

ローカル構成ファイルで、単純な json キーパスの最後にある値を取得します。

azdata bdc config show --config-file custom-config/bdc.json --json-path "metadata.name" --target section.json

ローカル構成ファイルで、サービス内のリソースを取得します

azdata bdc config show --config-file custom-config/bdc.json --json-path "$.spec.services.sql.resources" --target section.json

省略可能なパラメーター

`--config-file -c`

現在サインインしているクラスターの構成が必要ない場合は、ビッグデータクラスター構成ファイルのパス (custom/bdc.json など)

`--target -t`

結果を格納する出力ファイル。既定値: stdout に転送されます。

`--json-path -j`

構成から取得したいセクションまたは値への json キーパス (key1.key2.key3 など)。 jsonpath クエリ言語 https://jsonpath.com/ (-j '$.spec.pools[?(@.spec.type == "Master")]..endpoints' など) を使用します。

`--force -f`

ターゲットファイルを強制的に上書きします。

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

azdata bdc config add

構成ファイル内の json パスの値を追加します。以下の例はすべて Bash で指定されています。別のコマンドラインを使用している場合は、引用符の適切なエスケープが必要になる場合があることに注意してください。あるいは、修正プログラムファイルの機能を使用することもできます。

azdata bdc config add --path -p 
                      --json-values -j

例

例 1 - コントロールプレーンストレージを追加します。

azdata bdc config add --path custom/control.json --json-values "spec.storage={"accessMode":"ReadWriteOnce","className":"managed-premium","size":"10Gi"}"

必須のパラメーター

`--path -p`

設定する構成のビッグデータクラスター構成ファイルのパス (custom/bdc.json など)

`--json-values -j`

値への json パスのキー値ペアリスト: key1.subkey1=value1,key2.subkey2=value2。次のようなインライン json 値を指定できます。key='{"kind":"cluster","name":"test-cluster"}' or provide a file path, such as key=./values.json。追加では条件文はサポートされません。指定するインライン値が、"=" および "," を使用するキーと値のペア自体である場合は、それらの文字をエスケープしてください。たとえば、key1="key2=val2,key3=val3" のようになります。パスの例については、 http://jsonpatch.com/ を参照してください。配列にアクセスする場合は、インデックス (key.0=value など) を指定する必要があります。

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

azdata bdc config remove

構成ファイル内の json パスの値を削除します。以下の例はすべて Bash で指定されています。別のコマンドラインを使用している場合は、引用符の適切なエスケープが必要になる場合があることに注意してください。あるいは、修正プログラムファイルの機能を使用することもできます。

azdata bdc config remove --path -p 
                         --json-path -j

例

例 1 - コントロールプレーンストレージを削除します。

azdata bdc config remove --path custom/control.json --json-path ".spec.storage"

必須のパラメーター

`--path -p`

設定する構成のビッグデータクラスター構成ファイルのパス (custom/bdc.json など)

`--json-path -j`

どの値を削除するかを示す jsonpatch ライブラリに基づいた json パスのリスト (key1.subkey1,key2.subkey2 など)。削除では条件文はサポートされません。パスの例については、 http://jsonpatch.com/ を参照してください。配列にアクセスする場合は、インデックス (key.0=value など) を指定する必要があります。

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

azdata bdc config replace

構成ファイル内の json パスの値を置き換えます。以下の例はすべて Bash で指定されています。別のコマンドラインを使用している場合は、引用符の適切なエスケープが必要になる場合があることに注意してください。あるいは、修正プログラムファイルの機能を使用することもできます。

azdata bdc config replace --path -p 
                          --json-values -j

例

例 1 - 1 つのエンドポイント (コントローラーエンドポイント) のポートを置き換えます。

azdata bdc config replace --path custom/control.json --json-values "$.spec.endpoints[?(@.name=="Controller")].port=30080"

例 2 - コントロールプレーンストレージを置き換えます。

azdata bdc config replace --path custom/control.json --json-values "spec.storage={"accessMode":"ReadWriteOnce","className":"managed-premium","size":"10Gi"}"

例 3 - storage-0 リソース仕様を置き換えます (レプリカを含む)。

azdata bdc config replace --path custom/bdc.json --json-values "$.spec.resources.storage-0.spec={"replicas": 2,"storage": {"className": "managed-premium","size": "10Gi","accessMode": "ReadWriteOnce"},"type": "Storage"}"

必須のパラメーター

`--path -p`

設定する構成のビッグデータクラスター構成ファイルのパス (custom/bdc.json など)

`--json-values -j`

値への json パスのキー値ペアリスト: key1.subkey1=value1,key2.subkey2=value2。次のようなインライン json 値を指定できます。key='{"kind":"cluster","name":"test-cluster"}' or provide a file path, such as key=./values.json。置き換えでは jsonpath ライブラリによる条件文がサポートされます。これを使用するには、パスを $ で始めます。これにより、条件文 (-j $.key1.key2[?(@.key3=='someValue'].key4=value など) を実行できます。指定するインライン値が、"=" および "," を使用するキーと値のペア自体である場合は、それらの文字をエスケープしてください。たとえば、key1="key2=val2,key3=val3" のようになります。以下の例を参照できます。追加のヘルプについては、 https://jsonpath.com/ を参照してください。

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

azdata bdc config patch

指定された修正プログラムファイルに従って、構成ファイルに修正プログラムを適用します。パスを構成する方法の詳細については、 http://jsonpatch.com/ を参照してください。置き換え操作では、jsonpath ライブラリ https://jsonpath.com/ に従って、そのパス内で条件文を使用できます。すべての修正プログラム json ファイルは、対応する操作 (add、replace、remove)、パス、および値で構成される修正プログラムの配列を含む "patch" のキーで始まる必要があります。 "remove" 操作には値は必要なく、パスだけが必要です。以下の例を参照してください。

azdata bdc config patch --path 
                        --patch-file -p

例

例 1 - 修正プログラムファイルを使用して、1 つのエンドポイント (コントローラーエンドポイント) を置き換えます。

azdata bdc config patch --path custom/control.json --patch ./patch.json

    Patch File Example (patch.json):
        {"patch":[{"op":"replace","path":"$.spec.endpoints[?(@.name=="Controller")].port","value":30080}]}

例 2 - 修正プログラムファイルを使用して、コントロールプレーンストレージを置き換えます。

azdata bdc config patch --path custom/control.json --patch ./patch.json

    Patch File Example (patch.json):
        {"patch":[{"op":"replace","path":".spec.storage","value":{"accessMode":"ReadWriteMany","className":"managed-premium","size":"10Gi"}}]}

例 3 - 修正プログラムファイルを使用して、レプリカ (記憶域プール) を含むプールストレージを置き換えます。

azdata bdc config patch --path custom/bdc.json --patch ./patch.json

    Patch File Example (patch.json):
        {"patch":[{"op":"replace","path":"$.spec.resources.storage-0.spec","value":{"replicas": 2,"storage": {"className": "managed-premium","size": "10Gi","accessMode": "ReadWriteOnce"},"type": "Storage"}}]}

必須のパラメーター

`--path`

設定する構成のビッグデータクラスター構成ファイルのパス (custom/bdc.json など)

`--patch-file -p`

jsonpatch ライブラリに基づいた修正プログラム json ファイルへのパス (http://jsonpatch.com/ )。修正プログラム json ファイルは、実行する修正プログラム適用操作の配列である値を持つ "patch" という名前のキーで始める必要があります。修正プログラム適用操作のパスの場合は、ドット表記 (ほとんどの操作での key1.key2 など) を使用できます。置き換え操作を実行するときに、条件文を必要とする配列内の値を置き換えている場合は、パスを $ で始めて jsonpath 表記を使用してください。これにより、条件文 ($.key1.key2[?(@.key3=='someValue'].key4 など) を実行できます。以下の例を参照してください。条件文に関する追加のヘルプについては、 https://jsonpath.com/ を参照してください。

グローバル引数

`--debug`

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

`--help -h`

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

`--output -o`

出力形式。使用できる値: json、jsonc、table、tsv。既定値: json。

`--query -q`

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

`--verbose`

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

次のステップ

他の azdata コマンドの詳細については、azdata リファレンスに関するページを参照してください。

azdata ツールをインストールする方法の詳細については、「azdata のインストール」を参照してください。

次の方法で共有

azdata bdc config

コマンド

azdata bdc config init

例

省略可能なパラメーター

--path -p

--source -s

--force -f

--accept-eula -a

グローバル引数

--debug

--help -h

--output -o

--query -q

--verbose

azdata bdc config list

例

省略可能なパラメーター

--config-profile -c

--type -t

--accept-eula -a

グローバル引数

--debug

--help -h

--output -o

--query -q

--verbose

azdata bdc config show

例

省略可能なパラメーター

--config-file -c

--target -t

--json-path -j

--force -f

グローバル引数

--debug

--help -h

--output -o

--query -q

--verbose

azdata bdc config add

例

必須のパラメーター

--path -p

--json-values -j

グローバル引数

--debug

--help -h

--output -o

--query -q

--verbose

azdata bdc config remove

例

必須のパラメーター

--path -p

--json-path -j

グローバル引数

--debug

--help -h

--output -o

--query -q

--verbose

azdata bdc config replace

例

必須のパラメーター

--path -p

--json-values -j

グローバル引数

--debug

--help -h

--output -o

--query -q

--verbose

azdata bdc config patch

例

必須のパラメーター

--path

--patch-file -p

グローバル引数

`--path -p`

`--source -s`

`--force -f`

`--accept-eula -a`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`

`--config-profile -c`

`--type -t`

`--accept-eula -a`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`

`--config-file -c`

`--target -t`

`--json-path -j`

`--force -f`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`

`--path -p`

`--json-values -j`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`

`--path -p`

`--json-path -j`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`

`--path -p`

`--json-values -j`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`

`--path`

`--patch-file -p`

`--debug`

`--help -h`

`--output -o`

`--query -q`

`--verbose`