az stream-analytics private-endpoint

參考

注意

此參考是 Azure CLI 串流分析延伸模組的一部分（2.15.0 版或更高版本）。擴充功能會在您第一次執行 az stream-analytics private-endpoint 命令時自動安裝。深入了解擴充功能。

使用串流分析管理私人端點。

命令

名稱	Description	類型	狀態
az stream-analytics private-endpoint create	建立串流分析私人端點，或取代現有的私人端點。	副檔名	GA
az stream-analytics private-endpoint delete	刪除指定的私人端點。	副檔名	GA
az stream-analytics private-endpoint list	列出叢集中的私人端點。	副檔名	GA
az stream-analytics private-endpoint show	取得指定私人端點的相關信息。	副檔名	GA
az stream-analytics private-endpoint wait	將 CLI 置於等候狀態，直到符合串流分析私人端點的條件為止。	副檔名	GA

az stream-analytics private-endpoint create

建立串流分析私人端點，或取代現有的私人端點。

az stream-analytics private-endpoint create --cluster-name
                                            --name
                                            --resource-group
                                            [--connections]
                                            [--if-match]
                                            [--if-none-match]

範例

建立私人端點

az stream-analytics private-endpoint create --cluster-name "testcluster" --connections "[{\"privateLinkServiceId\":\"/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls\",\"groupIds\":[\"groupIdFromResource\"]}]" --name "testpe" --resource-group "sjrg"

必要參數

--cluster-name

叢集的名稱。

--name --private-endpoint-name -n

私人端點的名稱。

--resource-group -g

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

選擇性參數

--connections

遠端資源的連線清單。設定之後不可變。預期值：json-string/json-file/@json-file。

--if-match

資源的 ETag。請省略此值，以一律覆寫目前的記錄集。指定最後看到的 ETag 值，以防止意外覆寫並行變更。

--if-none-match

設定為『*』以允許建立新的資源，但為了避免更新現有的記錄集。其他值會導致 412 前置條件失敗的回應。

全域參數

--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 stream-analytics private-endpoint delete

刪除指定的私人端點。

az stream-analytics private-endpoint delete [--cluster-name]
                                            [--ids]
                                            [--name]
                                            [--no-wait]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

範例

刪除私人端點

az stream-analytics private-endpoint delete --cluster-name "testcluster" --name "testpe" --resource-group "sjrg"

選擇性參數

--cluster-name

叢集的名稱。

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--name --private-endpoint-name -n

私人端點的名稱。

--no-wait

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

預設值: False

--resource-group -g

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

--subscription

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

--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 stream-analytics private-endpoint list

列出叢集中的私人端點。

az stream-analytics private-endpoint list --cluster-name
                                          --resource-group

範例

取得叢集中的私人端點

az stream-analytics private-endpoint list --cluster-name "testcluster" --resource-group "sjrg"

必要參數

--cluster-name

叢集的名稱。

--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 stream-analytics private-endpoint show

取得指定私人端點的相關信息。

az stream-analytics private-endpoint show [--cluster-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

範例

取得私人端點

az stream-analytics private-endpoint show --cluster-name "testcluster" --name "testpe" --resource-group "sjrg"

選擇性參數

--cluster-name

叢集的名稱。

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--name --private-endpoint-name -n

私人端點的名稱。

--resource-group -g

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

--subscription

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

全域參數

--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 stream-analytics private-endpoint wait

將 CLI 置於等候狀態，直到符合串流分析私人端點的條件為止。

az stream-analytics private-endpoint wait [--cluster-name]
                                          [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

範例

暫停執行下一行 CLI 腳本，直到成功刪除串流分析私人端點為止。

az stream-analytics private-endpoint wait --cluster-name "testcluster" --name "testpe" --resource-group "sjrg" --deleted

選擇性參數

--cluster-name

叢集的名稱。

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

一或多個資源識別碼 (以空格分隔)。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--interval

輪詢間隔以秒為單位。

預設值: 30

--name --private-endpoint-name -n

私人端點的名稱。

--resource-group -g

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

--subscription

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

--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 來取得完整偵錯記錄。

共用方式為

az stream-analytics private-endpoint

命令

az stream-analytics private-endpoint create

範例

必要參數

選擇性參數

az stream-analytics private-endpoint delete

範例

選擇性參數

az stream-analytics private-endpoint list

範例

必要參數

az stream-analytics private-endpoint show

範例

選擇性參數

az stream-analytics private-endpoint wait

範例

選擇性參數

其他資源