az apim nv

  • 參考

管理 Azure API 管理 具名值。

命令

名稱 Description 類型 狀態
az apim nv create

建立 API 管理 具名值。

 核心 GA
az apim nv delete

刪除 API 管理 具名值。

 核心 GA
az apim nv list

列出 API 管理 具名值。

 核心 GA
az apim nv show

顯示 API 管理 具名值的詳細數據。

 核心 GA
az apim nv show-secret

取得 API 管理 具名值的秘密。

 核心 GA
az apim nv update

更新 API 管理 具名值。

 核心 GA
az apim nv wait

將 CLI 置於等候狀態，直到符合名為 value 的 apim 條件為止。

 核心 GA

az apim nv create

編輯

建立 API 管理 具名值。

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

範例

建立具名值。

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

必要參數

--display-name

具名值的顯示名稱。

--named-value-id

要建立之具名值的唯一名稱。

目前 API 管理 服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

選擇性參數

--if-match

實體的 ETag。

--no-wait

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

預設值: False
--secret

判斷值是否為秘密，且是否應加密。 預設值為 False。

接受的值: false, true
預設值: False
--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--value

具名值的值。

全域參數
--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 apim nv delete

編輯

刪除 API 管理 具名值。

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

必要參數

--named-value-id

NamedValue 的標識碼。

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

選擇性參數

--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 apim nv list

編輯

列出 API 管理 具名值。

az apim nv list --resource-group
                --service-name

必要參數

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

全域參數
--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 apim nv show

編輯

顯示 API 管理 具名值的詳細數據。

az apim nv show --named-value-id
                --resource-group
                --service-name

必要參數

--named-value-id

NamedValue 的標識碼。

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

全域參數
--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 apim nv show-secret

編輯

取得 API 管理 具名值的秘密。

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

必要參數

--named-value-id

NamedValue 的標識碼。

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

全域參數
--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 apim nv update

編輯

更新 API 管理 具名值。

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

範例

建立基本 API。

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

必要參數

--named-value-id

要建立之 API 的唯一名稱。

在目前 API 管理 服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

選擇性參數

--add

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

預設值: []
--force-string

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

預設值: False
--if-match

實體的 ETag。

--remove

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

預設值: []
--secret

判斷值是否為秘密，且是否應加密。 預設值為 False。

接受的值: false, true
--set

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

預設值: []
--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--value

具名值的值。

全域參數
--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 apim nv wait

編輯

將 CLI 置於等候狀態，直到符合名為 value 的 apim 條件為止。

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

範例

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

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

必要參數

--named-value-id

NamedValue 的標識碼。

--resource-group -g

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

--service-name -n

API 管理 服務實例的名稱。

選擇性參數

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--interval

輪詢間隔以秒為單位。

預設值: 30
--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 來取得完整偵錯記錄。