次の方法で共有


az connection

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細については、 を参照してください。

ローカル環境で Azure リソースを接続できるようにする Service Connector ローカル接続を管理するコマンド。 コンピューティング サービスの接続を管理する場合は、'az webapp/containerapp/spring connection' を実行してください。

コマンド

名前 説明 状態
az connection create

ローカルからターゲット リソースへの接続を作成します。

コアと拡張機能 GA
az connection create app-insights

app-insights への Service Connector ローカル接続を作成します。

Core GA
az connection create appconfig

appconfig への Service Connector ローカル接続を作成します。

Core GA
az connection create confluent-cloud

confluent-cloud へのローカル接続を作成します。

Core GA
az connection create cosmos-cassandra

cosmos-cassandra への Service Connector ローカル接続を作成します。

Core GA
az connection create cosmos-gremlin

cosmos-gremlin への Service Connector ローカル接続を作成します。

Core GA
az connection create cosmos-mongo

cosmos-mongo への Service Connector ローカル接続を作成します。

Core GA
az connection create cosmos-sql

Cosmos-sql への Service Connector ローカル接続を作成します。

Core GA
az connection create cosmos-table

Cosmos テーブルへの Service Connector ローカル接続を作成します。

Core GA
az connection create eventhub

Eventhub への Service Connector ローカル接続を作成します。

Core GA
az connection create keyvault

keyvault への Service Connector ローカル接続を作成します。

Core GA
az connection create mysql

mysql への Service Connector ローカル接続を作成します。

Core GA
az connection create mysql-flexible

mysql-flexible への Service Connector ローカル接続を作成します。

Core GA
az connection create mysql-flexible (serviceconnector-passwordless 拡張機能)

mysql-flexible への Service Connector ローカル接続を作成します。

Extension GA
az connection create postgres

Postgres への Service Connector ローカル接続を作成します。

Core GA
az connection create postgres-flexible

postgres フレキシブルへの Service Connector ローカル接続を作成します。

Core GA
az connection create postgres-flexible (serviceconnector-passwordless 拡張機能)

postgres フレキシブルへの Service Connector ローカル接続を作成します。

Extension GA
az connection create redis

Redis への Service Connector ローカル接続を作成します。

Core GA
az connection create redis-enterprise

Redis-enterprise への Service Connector ローカル接続を作成します。

Core GA
az connection create servicebus

servicebus への Service Connector ローカル接続を作成します。

Core GA
az connection create signalr

Signalr への Service Connector ローカル接続を作成します。

Core GA
az connection create sql

sql への Service Connector ローカル接続を作成します。

Core GA
az connection create sql (serviceconnector-passwordless 拡張機能)

sql への Service Connector ローカル接続を作成します。

Extension GA
az connection create storage-blob

Storage-BLOB への Service Connector ローカル接続を作成します。

Core GA
az connection create storage-file

ストレージ ファイルへの Service Connector ローカル接続を作成します。

Core GA
az connection create storage-queue

ストレージ キューへの Service Connector ローカル接続を作成します。

Core GA
az connection create storage-table

storage-table への Service Connector ローカル接続を作成します。

Core GA
az connection create webpubsub

Webpubsub への Service Connector ローカル接続を作成します。

Core GA
az connection delete

Service Connector のローカル接続を削除します。

Core GA
az connection generate-configuration

Service Connector ローカル接続の構成を生成します。 結果は、アプリケーション構成ファイルに配置するか、環境変数として設定する必要があります。

Core GA
az connection list

Service Connector のローカル接続を一覧表示します。

Core GA
az connection list-support-types

ローカル接続でサポートされているクライアントの種類と認証の種類を一覧表示します。

Core GA
az connection preview-configuration

ローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration app-insights

app-insights へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration appconfig

appconfig へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration confluent-cloud

confluent-cloud へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration cosmos-cassandra

cosmos-cassandra へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration cosmos-gremlin

cosmos-gremlin へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration cosmos-mongo

cosmos-mongo へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration cosmos-sql

cosmos-sql へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration cosmos-table

cosmos-table へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration eventhub

eventhub へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration keyvault

keyvault へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration mysql

mysql へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration mysql-flexible

mysql-flexible へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration postgres

postgres へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration postgres-flexible

postgres フレキシブルへのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration redis

Redis へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration redis-enterprise

redis-enterprise へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration servicebus

servicebus へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration signalr

Signalr へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration sql

sql へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration storage-blob

ストレージ BLOB へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration storage-file

storage-file へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration storage-queue

storage-queue へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration storage-table

storage-table へのローカル接続の予想される構成をプレビューします。

Core GA
az connection preview-configuration webpubsub

Webpubsub へのローカル接続の予想される構成をプレビューします。

Core GA
az connection show

Service Connector ローカル接続の詳細を取得します。

Core GA
az connection update

Service Connector のローカル接続を更新します。

Core GA
az connection update app-insights

app-insights へのローカル接続を更新します。

Core GA
az connection update appconfig

ローカルから appconfig への接続を更新します。

Core GA
az connection update confluent-cloud

confluent-cloud へのローカル接続を更新します。

Core GA
az connection update cosmos-cassandra

ローカルから cosmos-cassandra への接続を更新します。

Core GA
az connection update cosmos-gremlin

ローカルから cosmos-gremlin への接続を更新します。

Core GA
az connection update cosmos-mongo

ローカルから cosmos-mongo への接続を更新します。

Core GA
az connection update cosmos-sql

ローカルから cosmos-sql への接続を更新します。

Core GA
az connection update cosmos-table

ローカルから Cosmos テーブルへの接続を更新します。

Core GA
az connection update eventhub

ローカルから eventhub への接続を更新します。

Core GA
az connection update keyvault

ローカルから keyvault への接続を更新します。

Core GA
az connection update mysql

mysql 接続へのローカル接続を更新します。

Core GA
az connection update mysql-flexible

mysql フレキシブル接続へのローカル接続を更新します。

Core GA
az connection update postgres

ローカルから postgres への接続を更新します。

Core GA
az connection update postgres-flexible

ローカルから postgres への柔軟な接続を更新します。

Core GA
az connection update redis

ローカルから Redis への接続を更新します。

Core GA
az connection update redis-enterprise

ローカルから redis-enterprise への接続を更新します。

Core GA
az connection update servicebus

ローカルから servicebus への接続を更新します。

Core GA
az connection update signalr

ローカルからシグナルへの接続を更新します。

Core GA
az connection update sql

ローカルから SQL への接続を更新します。

Core GA
az connection update storage-blob

ローカルからストレージ BLOB への接続を更新します。

Core GA
az connection update storage-file

ローカルからストレージ ファイルへの接続を更新します。

Core GA
az connection update storage-queue

ローカルからストレージ キューへの接続を更新します。

Core GA
az connection update storage-table

ローカルからストレージ テーブルへの接続を更新します。

Core GA
az connection update webpubsub

ローカルから webpubsub への接続を更新します。

Core GA
az connection validate

Service Connector のローカル接続を検証します。

Core GA
az connection wait

接続の条件が満たされるまで、CLI を待機状態にします。

Core GA

az connection delete

Service Connector のローカル接続を削除します。

az connection delete [--connection]
                     [--id]
                     [--location]
                     [--no-wait]
                     [--resource-group]
                     [--yes]

ローカル接続を対話形式で削除する

az connection delete

接続名でローカル接続を削除する

az connection delete -g resourceGroup --connection MyConnection

接続 ID でローカル接続を削除する

az connection delete --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--connection

接続の名前。

--id

接続の ID。

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--yes -y

確認を求めないでください。

プロパティ
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az connection generate-configuration

Service Connector ローカル接続の構成を生成します。 結果は、アプリケーション構成ファイルに配置するか、環境変数として設定する必要があります。

az connection generate-configuration [--connection]
                                     [--id]
                                     [--location]
                                     [--resource-group]

接続名を使用して接続のローカル構成を生成する

az connection generate-configuration -g resource_group --connection MyConnection

接続 ID を使用して接続のローカル構成を生成する

az connection generate-configuration --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--connection

接続の名前。

--id

接続の ID。

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az connection list

Service Connector のローカル接続を一覧表示します。

az connection list --resource-group
                   [--location]

リソース グループ別に接続を一覧表示する

az connection list -g resource_group

ソース リソース グループと場所別に接続を一覧表示する

az connection list -g resource_group --location eastus

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az connection list-support-types

ローカル接続でサポートされているクライアントの種類と認証の種類を一覧表示します。

az connection list-support-types [--target-type {app-insights, appconfig, cognitiveservices, confluent-cloud, containerapp, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, fabric-sql, keyvault, mongodb-atlas, mysql, mysql-flexible, neon-postgres, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub}]

サポートされているすべてのターゲット リソースの種類と認証の種類を一覧表示する

az connection list-support-types -o table

特定のターゲット リソースの種類でサポートされている認証の種類を一覧表示する

az connection list-support-types --target-type storage-blob -o table

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--target-type -t

ターゲット リソースの種類。

プロパティ
指定可能な値: app-insights, appconfig, cognitiveservices, confluent-cloud, containerapp, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, fabric-sql, keyvault, mongodb-atlas, mysql, mysql-flexible, neon-postgres, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az connection show

Service Connector ローカル接続の詳細を取得します。

az connection show [--connection]
                   [--id]
                   [--location]
                   [--resource-group]

対話形式で接続を取得する

az connection show

接続名で接続を取得する

az connection show -g resourceGroup --connection MyConnection

接続 ID で接続を取得する

az connection show --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--connection

接続の名前。

--id

接続の ID。

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az connection validate

Service Connector のローカル接続を検証します。

az connection validate [--connection]
                       [--id]
                       [--location]
                       [--resource-group]

対話形式で接続を検証する

az connection validate

接続名で接続を検証する

az connection validate -g resourceGroup --connection MyConnection

接続 ID で接続を検証する

az connection validate --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--connection

接続の名前。

--id

接続の ID。

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az connection wait

接続の条件が満たされるまで、CLI を待機状態にします。

az connection wait [--connection]
                   [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--id]
                   [--interval]
                   [--location]
                   [--resource-group]
                   [--timeout]
                   [--updated]

接続が正常に作成されるまで待ちます。

az connection wait --id /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName} --created

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--connection

接続の名前。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ
パラメーター グループ: Wait Condition Arguments
--deleted

削除されるまで待ちます。

プロパティ
パラメーター グループ: Wait Condition Arguments
規定値: False
--exists

リソースが存在するまで待ちます。

プロパティ
パラメーター グループ: Wait Condition Arguments
規定値: False
--id

接続の ID。

--interval

ポーリング間隔 (秒単位)。

プロパティ
パラメーター グループ: Wait Condition Arguments
規定値: 30
--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--timeout

最大待機時間 (秒単位)。

プロパティ
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False