次の方法で共有

az apim product api

  • リファレンス

Azure API Management 製品の API を管理します。

コマンド

名前 説明 型 状態
az apim product api add

指定した製品に API を追加します。

 コア GA
az apim product api check

識別子で指定された API エンティティが Product エンティティに関連付けられていることを確認します。

 コア GA
az apim product api delete

指定した製品から指定した API を削除します。

 コア GA
az apim product api list

製品に関連付けられている API のコレクションを一覧表示します。

 コア GA

az apim product api add

編集

指定した製品に API を追加します。

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

例

指定した製品に API を追加します。

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必須のパラメーター

--api-id

API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。

--product-id

製品識別子。 現在の API Management サービス インスタンスで一意である必要があります。

--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 product api check

編集

識別子で指定された API エンティティが Product エンティティに関連付けられていることを確認します。

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

例

API が製品に関連付けられているかどうかを確認します。

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必須のパラメーター

--api-id

API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。

--product-id

製品識別子。 現在の API Management サービス インスタンスで一意である必要があります。

--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 product api delete

編集

指定した製品から指定した API を削除します。

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

例

指定した製品から指定した API を削除します。

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必須のパラメーター

--api-id

API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。

--product-id

製品識別子。 現在の API Management サービス インスタンスで一意である必要があります。

--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 product api list

編集

製品に関連付けられている API のコレクションを一覧表示します。

az apim product api list --product-id
                         --resource-group
                         --service-name

例

製品に関連付けられているすべての API を一覧表示します。

az apim product api list --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID

必須のパラメーター

--product-id

製品識別子。 現在の API Management サービス インスタンスで一意である必要があります。

--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 を使用します。