az functionapp connection

Note

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

管理 functionapp 連線的命令。

命令

名稱	Description	類型	狀態
az functionapp connection create	建立 functionapp 與目標資源之間的連線。	核心和擴充功能	GA
az functionapp connection create app-insights	建立與 app-insights 的 functionapp 連線。	Core	GA
az functionapp connection create appconfig	建立與 appconfig 的 functionapp 連線。	Core	GA
az functionapp connection create cognitiveservices	建立與 cognitiveservices 的 functionapp 連線。	Core	GA
az functionapp connection create confluent-cloud	建立 confluent-cloud 的 functionapp 連線。	Core	GA
az functionapp connection create cosmos-cassandra	建立 cosmos-cassandra 的 functionapp 連線。	Core	GA
az functionapp connection create cosmos-gremlin	建立 cosmos-gremlin 的 functionapp 連線。	Core	GA
az functionapp connection create cosmos-mongo	建立 cosmos-mongo 的 functionapp 連線。	Core	GA
az functionapp connection create cosmos-sql	建立 cosmos-sql 的 functionapp 連線。	Core	GA
az functionapp connection create cosmos-table	建立 cosmos-table 的 functionapp 連線。	Core	GA
az functionapp connection create eventhub	建立 eventhub 的 functionapp 連線。	Core	GA
az functionapp connection create fabric-sql	建立 fabric-sql 的 functionapp 連線。	Core	GA
az functionapp connection create fabric-sql (serviceconnector-passwordless 擴充功能)	建立 fabric-sql 的 functionapp 連線。	Extension	GA
az functionapp connection create keyvault	建立keyvault的 functionapp 連線。	Core	GA
az functionapp connection create mongodb-atlas	建立 mongodb-atlas 的 functionapp 連線。	Core	GA
az functionapp connection create mysql	建立 mysql 的 functionapp 連線。	Core	Deprecated
az functionapp connection create mysql-flexible	建立與 mysql 彈性的 functionapp 連線。	Core	GA
az functionapp connection create mysql-flexible (serviceconnector-passwordless 擴充功能)	建立與 mysql 彈性的 functionapp 連線。	Extension	GA
az functionapp connection create neon-postgres	建立與 neon-postgres 的 functionapp 連線。	Core	GA
az functionapp connection create postgres	建立 postgres 的 functionapp 連線。	Core	Deprecated
az functionapp connection create postgres-flexible	建立 postgres 彈性的 functionapp 連線。	Core	GA
az functionapp connection create postgres-flexible (serviceconnector-passwordless 擴充功能)	建立 postgres 彈性的 functionapp 連線。	Extension	GA
az functionapp connection create redis	建立 redis 的 functionapp 連線。	Core	GA
az functionapp connection create redis-enterprise	建立 redis-enterprise 的 functionapp 連線。	Core	GA
az functionapp connection create servicebus	建立 servicebus 的 functionapp 連線。	Core	GA
az functionapp connection create signalr	建立與 signalr 的 functionapp 連線。	Core	GA
az functionapp connection create sql	建立 sql 的 functionapp 連線。	Core	GA
az functionapp connection create sql (serviceconnector-passwordless 擴充功能)	建立 sql 的 functionapp 連線。	Extension	GA
az functionapp connection create storage-blob	建立與 storage-blob 的 functionapp 連線。	Core	GA
az functionapp connection create storage-file	建立與 storage-file 的 functionapp 連線。	Core	GA
az functionapp connection create storage-queue	建立記憶體佇列的 functionapp 連線。	Core	GA
az functionapp connection create storage-table	建立與 storage-table 的 functionapp 連線。	Core	GA
az functionapp connection create webpubsub	建立與 webpubsub 的 functionapp 連線。	Core	GA
az functionapp connection delete	刪除 functionapp 連線。	Core	GA
az functionapp connection list	列出 functionapp 的連線。	Core	GA
az functionapp connection list-configuration	列出 functionapp 連線的來源組態。	Core	GA
az functionapp connection list-support-types	列出 functionapp 連線支援的用戶端類型和驗證類型。	Core	GA
az functionapp connection show	取得 functionapp 連線的詳細數據。	Core	GA
az functionapp connection update	更新 functionapp 連線。	Core	GA
az functionapp connection update app-insights	將 functionapp 更新為 app-insights 連線。	Core	GA
az functionapp connection update appconfig	將 functionapp 更新為 appconfig 連線。	Core	GA
az functionapp connection update cognitiveservices	將 functionapp 更新為 cognitiveservices 連線。	Core	GA
az functionapp connection update confluent-cloud	將 functionapp 更新為 confluent-cloud 連線。	Core	GA
az functionapp connection update cosmos-cassandra	將 functionapp 更新為 cosmos-cassandra 連線。	Core	GA
az functionapp connection update cosmos-gremlin	將 functionapp 更新為 cosmos-gremlin 連線。	Core	GA
az functionapp connection update cosmos-mongo	將 functionapp 更新為 cosmos-mongo 連線。	Core	GA
az functionapp connection update cosmos-sql	將 functionapp 更新為 cosmos-sql 連線。	Core	GA
az functionapp connection update cosmos-table	將 functionapp 更新為 cosmos-table 連線。	Core	GA
az functionapp connection update eventhub	將 functionapp 更新為 eventhub 連線。	Core	GA
az functionapp connection update fabric-sql	將 functionapp 更新為 fabric-sql 連線。	Core	GA
az functionapp connection update keyvault	將 functionapp 更新為 keyvault 連線。	Core	GA
az functionapp connection update mongodb-atlas	將 functionapp 更新為 mongodb-atlas 連線。	Core	GA
az functionapp connection update mysql	將 functionapp 更新為 mysql 連線。	Core	Deprecated
az functionapp connection update mysql-flexible	將 functionapp 更新為 mysql 彈性連線。	Core	GA
az functionapp connection update neon-postgres	將 functionapp 更新為 neon-postgres 連線。	Core	GA
az functionapp connection update postgres	將 functionapp 更新為 postgres 連線。	Core	Deprecated
az functionapp connection update postgres-flexible	將 functionapp 更新為 postgres 彈性連線。	Core	GA
az functionapp connection update redis	將 functionapp 更新為 redis 連線。	Core	GA
az functionapp connection update redis-enterprise	將 functionapp 更新為 redis-enterprise 連線。	Core	GA
az functionapp connection update servicebus	將 functionapp 更新為 servicebus 連線。	Core	GA
az functionapp connection update signalr	將 functionapp 更新為 signalr 連線。	Core	GA
az functionapp connection update sql	將 functionapp 更新為 sql 連線。	Core	GA
az functionapp connection update storage-blob	將 functionapp 更新為 storage-blob 連線。	Core	GA
az functionapp connection update storage-file	將 functionapp 更新為記憶體檔案連線。	Core	GA
az functionapp connection update storage-queue	將 functionapp 更新為記憶體佇列連線。	Core	GA
az functionapp connection update storage-table	將 functionapp 更新為記憶體數據表連線。	Core	GA
az functionapp connection update webpubsub	將 functionapp 更新為 webpubsub 連線。	Core	GA
az functionapp connection validate	驗證 functionapp 連線。	Core	GA
az functionapp connection wait	將 CLI 置於等候狀態，直到符合連線的條件為止。	Core	GA

az functionapp connection delete

刪除 functionapp 連線。

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

範例

以互動方式刪除 functionapp 連線

az functionapp connection delete

依連線名稱刪除 functionapp 連線

az functionapp connection delete -g FuncAppRG -n MyFunctionApp --connection MyConnection

依線上標識碼刪除 functionapp 連線

az functionapp connection delete --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--connection

functionapp 連線的名稱。

--id

連接的資源識別碼。 如果未指定 '--id' ，則需要 [''--resource-group'、'--name'、'--connection']。

--name -n

函式應用程式的名稱。 如果未指定 『--id』 ，則為必要項。沒有。

--no-wait

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

屬性	值
預設值:	False

--resource-group -g

包含函式應用程式的資源群組。 如果未指定 『--id』 ，則為必要項。沒有。

--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

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az functionapp connection list

列出 functionapp 的連線。

az functionapp connection list [--name]
                               [--resource-group]
                               [--source-id]

範例

以互動方式列出 functionapp 連線

az functionapp connection list

依來源資源名稱列出 functionapp 連線

az functionapp connection list -g FuncAppRG -n MyFunctionApp

依來源資源標識碼列出 functionapp 連線

az functionapp connection list --source-id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--name -n

函式應用程式的名稱。 如果未指定 『--source-id』，則為必要專案。沒有。

--resource-group -g

包含函式應用程式的資源群組。 如果未指定 『--source-id』，則為必要專案。沒有。

--source-id

functionapp 的資源標識符。 如果未指定 ['--resource-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

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az functionapp connection list-configuration

列出 functionapp 連線的來源組態。

az functionapp connection list-configuration [--connection]
                                             [--id]
                                             [--name]
                                             [--resource-group]

範例

以互動方式列出連線的來源組態

az functionapp connection list-configuration

依連線名稱列出連線的來源組態

az functionapp connection list-configuration -g FuncAppRG -n MyFunctionApp --connection MyConnection

依線上標識碼列出連線的來源組態

az functionapp connection list-configuration --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--connection

functionapp 連線的名稱。

--id

連接的資源識別碼。 如果未指定 '--id' ，則需要 [''--resource-group'、'--name'、'--connection']。

--name -n

函式應用程式的名稱。 如果未指定 『--id』 ，則為必要項。沒有。

--resource-group -g

包含函式應用程式的資源群組。 如果未指定 『--id』 ，則為必要項。沒有。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az functionapp connection list-support-types

列出 functionapp 連線支援的用戶端類型和驗證類型。

az functionapp connection list-support-types [--target-type {app-insights, appconfig, cognitiveservices, confluent-cloud, 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}]

範例

列出所有 functionapp 支援的目標資源類型和驗證類型

az functionapp connection list-support-types -o table

列出特定目標資源類型支援的 functionapp 驗證類型

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--target-type -t

目標資源類型。

屬性	值
接受的值:	app-insights, appconfig, cognitiveservices, confluent-cloud, 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

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az functionapp connection show

取得 functionapp 連線的詳細數據。

az functionapp connection show [--connection]
                               [--id]
                               [--name]
                               [--resource-group]

範例

以互動方式取得連線

az functionapp connection show

依線上名稱取得連線

az functionapp connection show -g FuncAppRG -n MyFunctionApp --connection MyConnection

依線上標識碼取得連線

az functionapp connection show --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--connection

functionapp 連線的名稱。

--id

連接的資源識別碼。 如果未指定 '--id' ，則需要 [''--resource-group'、'--name'、'--connection']。

--name -n

函式應用程式的名稱。 如果未指定 『--id』 ，則為必要項。沒有。

--resource-group -g

包含函式應用程式的資源群組。 如果未指定 『--id』 ，則為必要項。沒有。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az functionapp connection validate

驗證 functionapp 連線。

az functionapp connection validate [--connection]
                                   [--id]
                                   [--name]
                                   [--resource-group]

範例

以互動方式驗證連線

az functionapp connection validate

依線上名稱驗證連線

az functionapp connection validate -g FuncAppRG -n MyFunctionApp --connection MyConnection

依線上標識碼驗證連線

az functionapp connection validate --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker}

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--connection

functionapp 連線的名稱。

--id

連接的資源識別碼。 如果未指定 '--id' ，則需要 [''--resource-group'、'--name'、'--connection']。

--name -n

函式應用程式的名稱。 如果未指定 『--id』 ，則為必要項。沒有。

--resource-group -g

包含函式應用程式的資源群組。 如果未指定 『--id』 ，則為必要項。沒有。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az functionapp connection wait

將 CLI 置於等候狀態，直到符合連線的條件為止。

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

範例

等到連線成功建立為止。

az functionapp connection wait --id /subscriptions/{subscription}/resourceGroups/{source_resource_group}/providers/Microsoft.Web/sites/{site}/providers/Microsoft.ServiceLinker/linkers/{linker} --created

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--connection

functionapp 連線的名稱。

--created

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

屬性	值
參數群組:	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' ，則需要 [''--resource-group'、'--name'、'--connection']。

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--name -n

函式應用程式的名稱。 如果未指定 『--id』 ，則為必要項。沒有。

--resource-group -g

包含函式應用程式的資源群組。 如果未指定 『--id』 ，則為必要項。沒有。

--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

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False