az apim nv

  • リファレンス

Azure API Management の名前付き値を管理します。

コマンド

名前 説明 型 Status
az apim nv create

API Management の名前付き値を作成します。

 コア GA
az apim nv delete

API Management の名前付き値を削除します。

 コア GA
az apim nv list

API Management の名前付き値を一覧表示します。

 コア GA
az apim nv show

API Management の名前付き値の詳細を表示します。

 コア GA
az apim nv show-secret

API Management の名前付き値のシークレットを取得します。

 コア GA
az apim nv update

API Management の名前付き値を更新します。

 コア GA
az apim nv wait

apim の名前付き値の条件が満たされるまで、CLI を待機状態にします。

 コア GA

az apim nv create

編集

API Management の名前付き値を作成します。

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 Management サービス インスタンスで一意である必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-name -n

API Management サービス インスタンスの名前。

省略可能のパラメーター

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az apim nv delete

編集

API Management の名前付き値を削除します。

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 Management サービス インスタンスの名前。

省略可能のパラメーター

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az apim nv list

編集

API Management の名前付き値を一覧表示します。

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

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-name -n

API Management サービス インスタンスの名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az apim nv show

編集

API Management の名前付き値の詳細を表示します。

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 Management サービス インスタンスの名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az apim nv show-secret

編集

API Management の名前付き値のシークレットを取得します。

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 Management サービス インスタンスの名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az apim nv update

編集

API Management の名前付き値を更新します。

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 Management サービス インスタンスで一意である必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service-name -n

API Management サービス インスタンスの名前。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

既定値: []
--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

既定値: False
--if-match

エンティティの ETag。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az apim nv wait

編集

apim の名前付き値の条件が満たされるまで、CLI を待機状態にします。

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

例

apim API の条件が満たされるまで、CLI を待機状態にします。

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 Management サービス インスタンスの名前。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。