az apim product

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

コマンド

名前	説明	型	状態
az apim product api	Azure API Management 製品の API を管理します。	コア	GA
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 create	製品を作成します。	コア	GA
az apim product delete	製品を削除します。	コア	GA
az apim product list	指定されたサービス インスタンスにおける製品のコレクションを一覧表示します。	コア	GA
az apim product show	識別子で指定された製品の詳細を取得します。	コア	GA
az apim product update	既存の製品の詳細を更新します。	コア	GA
az apim product wait	apim 製品の条件が満たされるまで、CLI を待機状態にします。	コア	GA

az apim product create

製品を作成します。

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

例

製品を作成します。

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

必須のパラメーター

--product-name

製品名。

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--approval-required

サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブした直後に開発者が製品の API を呼び出すようになります。 true の場合、管理者は、開発者が製品の API のいずれかを使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。

指定可能な値: false, true

--description

製品の説明。 HTML 書式設定タグを含めることができます。

--legal-terms

製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--product-id

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

--state

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。 指定できる値は、'notPublished'、'published' です。

指定可能な値: notPublished, published

--subscription-required -s

この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。

指定可能な値: false, true

--subscriptions-limit

ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザー サブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が 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 product delete

製品を削除します。

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

例

この製品のすべてのサブスクリプションを含む製品を削除します。

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

必須のパラメーター

--product-id

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

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--delete-subscriptions

製品に関連付けられている既存のサブスクリプションを削除するかどうか。

--if-match

エンティティの ETag。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

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

指定されたサービス インスタンスにおける製品のコレクションを一覧表示します。

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

例

この APIM インスタンスのすべての製品を一覧表示します。

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

必須のパラメーター

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

識別子で指定された製品の詳細を取得します。

az apim product show --product-id
                     --resource-group
                     --service-name

例

識別子で指定された製品の詳細を取得します。

az apim product show --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 を使います。

az apim product update

既存の製品の詳細を更新します。

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

例

既存の製品の詳細を更新します。

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

必須のパラメーター

--product-id

製品識別子。 現在の 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>。

規定値: []

--approval-required

サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブした直後に開発者が製品の API を呼び出すようになります。 true の場合、管理者は、開発者が製品の API のいずれかを使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。

指定可能な値: false, true

--description

製品の説明。 HTML 書式設定タグを含めることができます。

--force-string

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

規定値: False

--if-match

エンティティの ETag。

--legal-terms

製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--product-name

製品名。

--remove

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

規定値: []

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

規定値: []

--state

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。 指定できる値は、'notPublished'、'published' です。

指定可能な値: notPublished, published

--subscription-required -s

この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。

指定可能な値: false, true

--subscriptions-limit

ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザー サブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が 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 product wait

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

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

例

apim の条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az apim product wait --created --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 サービス インスタンスの名前。

省略可能のパラメーター

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