az connection

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。 安裝每個擴充功能以受益於其擴充功能。 深入了解擴充功能。

管理服務 連線 或本機連線的命令，可讓本機環境連線 Azure 資源。 如果您想要管理計算服務的連線，請執行 'az webapp/containerapp/spring connection'。

命令

名稱	Description	類型	狀態
az connection create	建立從本機到目標資源的連線。	核心和擴充功能	GA
az connection create app-insights	建立服務 連線 或應用程式深入解析的本機連線。	核心	GA
az connection create appconfig	建立 Service 連線 or 本機連線至 appconfig。	核心	GA
az connection create confluent-cloud	建立 confluent-cloud 的本機連線。	核心	GA
az connection create cosmos-cassandra	建立服務 連線 或cosmos-cassandra的本機連線。	核心	GA
az connection create cosmos-gremlin	建立服務 連線 或 cosmos-gremlin 的本機連線。	核心	GA
az connection create cosmos-mongo	建立服務 連線 或cosmos-mongo的本機連線。	核心	GA
az connection create cosmos-sql	建立服務 連線 或cosmos-sql的本機連線。	核心	GA
az connection create cosmos-table	建立服務 連線 或cosmos-table 的本機連線。	核心	GA
az connection create eventhub	建立 Service 連線 or eventhub 的本機連線。	核心	GA
az connection create keyvault	建立服務 連線 或keyvault的本機連線。	核心	GA
az connection create mysql	建立服務 連線 或 mysql 的本機連線。	核心	GA
az connection create mysql-flexible	建立服務 連線 或 mysql 彈性的本機連線。	核心	GA
az connection create mysql-flexible (serviceconnector-passwordless 擴充功能)	建立服務 連線 或 mysql 彈性的本機連線。	副檔名	GA
az connection create postgres	建立服務 連線 或postgres的本機連線。	核心	GA
az connection create postgres (serviceconnector-passwordless 擴充功能)	建立服務 連線 或postgres的本機連線。	副檔名	已淘汰
az connection create postgres-flexible	建立服務 連線 或postgres彈性的本機連線。	核心	GA
az connection create postgres-flexible (serviceconnector-passwordless 擴充功能)	建立服務 連線 或postgres彈性的本機連線。	副檔名	GA
az connection create redis	建立服務 連線 或 redis 的本機連線。	核心	GA
az connection create redis-enterprise	建立服務 連線 或 redis-enterprise 的本機連線。	核心	GA
az connection create servicebus	建立服務 連線 或 servicebus 的本機連線。	核心	GA
az connection create signalr	建立服務 連線 或信號器的本機連線。	核心	GA
az connection create sql	建立服務 連線 或 sql 的本機連線。	核心	GA
az connection create sql (serviceconnector-passwordless 擴充功能)	建立服務 連線 或 sql 的本機連線。	副檔名	GA
az connection create storage-blob	建立服務 連線 或記憶體 Blob 的本機連線。	核心	GA
az connection create storage-file	建立服務 連線 或記憶體檔案的本機連線。	核心	GA
az connection create storage-queue	建立服務 連線 或記憶體佇列的本機連線。	核心	GA
az connection create storage-table	建立服務 連線 或記憶體數據表的本機連線。	核心	GA
az connection create webpubsub	建立服務 連線 或 Webpubsub 的本機連線。	核心	GA
az connection delete	刪除服務 連線 或本機連線。	核心	GA
az connection generate-configuration	產生服務 連線 或本機連線的組態。 結果應該放在應用程式組態檔中，或設定為環境變數。	核心	GA
az connection list	列出服務 連線 or 的本機連線。	核心	GA
az connection list-support-types	列出本機連線支援的用戶端類型和驗證類型。	核心	GA
az connection preview-configuration	預覽本機連線的預期組態。	核心	GA
az connection preview-configuration app-insights	預覽與 app-insights 之本機連線的預期組態。	核心	GA
az connection preview-configuration appconfig	預覽與 appconfig 之本機連線的預期組態。	核心	GA
az connection preview-configuration confluent-cloud	預覽與 confluent-cloud 之本機連線的預期組態。	核心	GA
az connection preview-configuration cosmos-cassandra	預覽 cosmos-cassandra 之本機連線的預期組態。	核心	GA
az connection preview-configuration cosmos-gremlin	預覽對 cosmos-gremlin 之本機連線的預期組態。	核心	GA
az connection preview-configuration cosmos-mongo	預覽 cosmos-mongo 之本機連線的預期組態。	核心	GA
az connection preview-configuration cosmos-sql	預覽 cosmos-sql 本機連線的預期組態。	核心	GA
az connection preview-configuration cosmos-table	預覽 cosmos-table 之本機連線的預期組態。	核心	GA
az connection preview-configuration eventhub	預覽與 eventhub 之本機連線的預期組態。	核心	GA
az connection preview-configuration keyvault	預覽與keyvault之本機聯機的預期組態。	核心	GA
az connection preview-configuration mysql	預覽 mysql 本機連線的預期組態。	核心	GA
az connection preview-configuration mysql-flexible	預覽 mysql 彈性本機連線的預期組態。	核心	GA
az connection preview-configuration postgres	預覽與 postgres 之本機連線的預期組態。	核心	GA
az connection preview-configuration postgres-flexible	預覽與 postgres 彈性本機連線的預期組態。	核心	GA
az connection preview-configuration redis	預覽與 redis 之本機連線的預期組態。	核心	GA
az connection preview-configuration redis-enterprise	預覽與 redis-enterprise 之本機連線的預期組態。	核心	GA
az connection preview-configuration servicebus	預覽與 servicebus 之本機連線的預期組態。	核心	GA
az connection preview-configuration signalr	預覽與 signalr 之本機連線的預期組態。	核心	GA
az connection preview-configuration sql	預覽與 sql 之本機連線的預期組態。	核心	GA
az connection preview-configuration storage-blob	預覽與 storage-blob 之本機連線的預期組態。	核心	GA
az connection preview-configuration storage-file	預覽與記憶體檔案之本機連線的預期組態。	核心	GA
az connection preview-configuration storage-queue	預覽與記憶體佇列之本機連線的預期組態。	核心	GA
az connection preview-configuration storage-table	預覽與 storage-table 之本機連線的預期組態。	核心	GA
az connection preview-configuration webpubsub	預覽與 webpubsub 之本機連線的預期組態。	核心	GA
az connection show	取得服務 連線 或本機連線的詳細數據。	核心	GA
az connection update	更新服務 連線 或本機連線。	核心	GA
az connection update app-insights	將本機更新為 app-insights 連線。	核心	GA
az connection update appconfig	更新本機至 appconfig 連線。	核心	GA
az connection update confluent-cloud	更新 confluent-cloud 的本機連線。	核心	GA
az connection update cosmos-cassandra	將本機更新為 cosmos-cassandra 連線。	核心	GA
az connection update cosmos-gremlin	將本機更新為 cosmos-gremlin 連線。	核心	GA
az connection update cosmos-mongo	將本機更新為cosmos-mongo 連線。	核心	GA
az connection update cosmos-sql	將本機更新為 cosmos-sql 連線。	核心	GA
az connection update cosmos-table	將本機更新為 cosmos-table 連線。	核心	GA
az connection update eventhub	將本機更新為 eventhub 連線。	核心	GA
az connection update keyvault	將本機更新為keyvault連線。	核心	GA
az connection update mysql	更新 mysql 連線的本機。	核心	GA
az connection update mysql-flexible	將本機更新為 mysql 彈性連線。	核心	GA
az connection update postgres	將本機更新為 postgres 連線。	核心	GA
az connection update postgres-flexible	將本機更新為 postgres 彈性連線。	核心	GA
az connection update redis	將本機更新為 redis 連線。	核心	GA
az connection update redis-enterprise	將本機更新為 redis-enterprise 連線。	核心	GA
az connection update servicebus	將本機更新為 servicebus 連線。	核心	GA
az connection update signalr	將本機更新為信號器連線。	核心	GA
az connection update sql	將本機更新為 sql 連線。	核心	GA
az connection update storage-blob	更新記憶體 Blob 連線的本機。	核心	GA
az connection update storage-file	更新本機至記憶體檔案連線。	核心	GA
az connection update storage-queue	更新本機至記憶體佇列連線。	核心	GA
az connection update storage-table	將本機更新為記憶體數據表連線。	核心	GA
az connection update webpubsub	更新本機至 webpubsub 連線。	核心	GA
az connection validate	驗證服務 連線 或本機連線。	核心	GA
az connection wait	將 CLI 置於等候狀態，直到符合連線的條件為止。	核心	GA

az connection delete

刪除服務 連線 或本機連線。

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

範例

以互動方式刪除本機連線

az connection delete

依連線名稱刪除本機連線

az connection delete -g resourceGroup --connection MyConnection

依線上標識碼刪除本機連線

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

選擇性參數

--connection

連接的名稱。

--id

連接的識別碼。

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az connection generate-configuration

產生服務 連線 或本機連線的組態。 結果應該放在應用程式組態檔中，或設定為環境變數。

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

範例

依連線名稱產生連線的本機組態

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

依線上標識碼產生連線的本機組態

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

選擇性參數

--connection

連接的名稱。

--id

連接的識別碼。

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az connection list

列出服務 連線 or 的本機連線。

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> 來設定預設群組。

選擇性參數

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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, keyvault, mysql, mysql-flexible, 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

選擇性參數

--target-type -t

目標資源類型。

接受的值: app-insights, appconfig, cognitiveservices, confluent-cloud, containerapp, cosmos-cassandra, cosmos-gremlin, cosmos-mongo, cosmos-sql, cosmos-table, eventhub, keyvault, mysql, mysql-flexible, postgres, postgres-flexible, redis, redis-enterprise, servicebus, signalr, sql, storage-blob, storage-file, storage-queue, storage-table, webpubsub

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az connection show

取得服務 連線 或本機連線的詳細數據。

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

範例

以互動方式取得連線

az connection show

依線上名稱取得連線

az connection show -g resourceGroup --connection MyConnection

依線上標識碼取得連線

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

選擇性參數

--connection

連接的名稱。

--id

連接的識別碼。

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az connection validate

驗證服務 連線 或本機連線。

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

範例

以互動方式驗證連線

az connection validate

依線上名稱驗證連線

az connection validate -g resourceGroup --connection MyConnection

依線上標識碼驗證連線

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

選擇性參數

--connection

連接的名稱。

--id

連接的識別碼。

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

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

選擇性參數

--connection

連接的名稱。

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--id

連接的識別碼。

--interval

輪詢間隔以秒為單位。

預設值: 30

--location -l

位置。​​ 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。