az nginx deployment api-key

Note

此參考文獻是nginx擴充套件的一部分，適用於Azure CLI（版本2.75.0或更高版本）。 擴充功能會在您第一次執行 az nginx deployment api-key 命令時自動安裝。 深入了解擴充功能。

管理 Nginxaas 部署 API 金鑰。

命令

名稱 Description 類型 狀態
az nginx deployment api-key create

建立 Nginx 部署的 API 金鑰，以存取數據平面 API 端點。

 Extension GA
az nginx deployment api-key delete

刪除 Nginx 部署的 API 金鑰。

 Extension GA
az nginx deployment api-key list

列出指定 Nginx 部署的所有 API 金鑰。

 Extension GA
az nginx deployment api-key show

取得指定 Nginx 部署的指定 API 金鑰。

 Extension GA
az nginx deployment api-key update

更新 Nginx 部署的 API 金鑰，以存取資料平面 API 端點。

 Extension GA

az nginx deployment api-key create

建立 Nginx 部署的 API 金鑰，以存取數據平面 API 端點。

az nginx deployment api-key create --api-key-name --name
                                   --deployment-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--end-date-time]
                                   [--secret-text]

必要參數

--api-key-name --name -n

API 金鑰的資源名稱。

--deployment-name

目標 NGINX 部署的名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--end-date-time

此數據平面 API 金鑰不再有效的時間。

屬性 值
參數群組: Properties Arguments
--secret-text

要當做數據平面 API 金鑰使用的秘密文字。 這是永遠無法讀取的寫入屬性，但前三個字元會在 『hint』 屬性中傳回。 如果值為空白，則會從tty要求此值。

屬性 值
參數群組: Properties Arguments
全域參數
--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 nginx deployment api-key delete

刪除 Nginx 部署的 API 金鑰。

az nginx deployment api-key delete [--acquire-policy-token]
                                   [--api-key-name --name]
                                   [--change-reference]
                                   [--deployment-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--api-key-name --name -n

API 金鑰的資源名稱。

屬性 值
參數群組: Resource Id Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--deployment-name

目標 NGINX 部署的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

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

屬性 值
參數群組: Resource Id Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
--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/。

--verbose

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

屬性 值
預設值: False

az nginx deployment api-key list

列出指定 Nginx 部署的所有 API 金鑰。

az nginx deployment api-key list --deployment-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

必要參數

--deployment-name

目標 NGINX 部署的名稱。

--resource-group -g

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

選擇性參數

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

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。 若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

屬性 值
參數群組: Pagination Arguments
--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性 值
參數群組: Pagination Arguments
全域參數
--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 nginx deployment api-key show

取得指定 Nginx 部署的指定 API 金鑰。

az nginx deployment api-key show [--api-key-name --name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

選擇性參數

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

--api-key-name --name -n

API 金鑰的資源名稱。

屬性 值
參數群組: Resource Id Arguments
--deployment-name

目標 NGINX 部署的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

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

屬性 值
參數群組: Resource Id Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
全域參數
--debug

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

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az nginx deployment api-key update

更新 Nginx 部署的 API 金鑰，以存取資料平面 API 端點。

az nginx deployment api-key update [--acquire-policy-token]
                                   [--add]
                                   [--api-key-name --name]
                                   [--change-reference]
                                   [--deployment-name]
                                   [--end-date-time]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--remove]
                                   [--resource-group]
                                   [--secret-text]
                                   [--set]
                                   [--subscription]

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例： --add property.listProperty <key=value, string or JSON string>.

屬性 值
參數群組: Generic Update Arguments
--api-key-name --name -n

API 金鑰的資源名稱。

屬性 值
參數群組: Resource Id Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--deployment-name

目標 NGINX 部署的名稱。

屬性 值
參數群組: Resource Id Arguments
--end-date-time

此數據平面 API 金鑰不再有效的時間。

屬性 值
參數群組: Properties Arguments
--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性 值
參數群組: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

屬性 值
參數群組: Resource Id Arguments
--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性 值
參數群組: Generic Update Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--secret-text

要當做數據平面 API 金鑰使用的秘密文字。 這是永遠無法讀取的寫入屬性，但前三個字元會在 『hint』 屬性中傳回。 如果值為空白，則會從tty要求此值。

屬性 值
參數群組: Properties Arguments
--set

指定要設定的屬性路徑和值，以更新物件。 範例： --set property1.property2=<value>.

屬性 值
參數群組: Generic Update Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
全域參數
--debug

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

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False