az apim api

リファレンス

Azure API Management API を管理します。

コマンド

名前	説明	型	Status
az apim api create	API Management API を作成します。	コア	GA
az apim api delete	API Management API を削除します。	コア	GA
az apim api export	API Management API をエクスポートします。	コア	GA
az apim api import	API Management API をインポートします。	コア	GA
az apim api list	API Management API を一覧表示します。	コア	GA
az apim api operation	Azure API Management API 操作を管理します。	コア	GA
az apim api operation create	API で新しい操作を作成します。	コア	GA
az apim api operation delete	API の指定された操作を削除します。	コア	GA
az apim api operation list	指定した API の操作のコレクションを一覧表示します。	コア	GA
az apim api operation show	識別子で指定された API 操作の詳細を取得します。	コア	GA
az apim api operation update	識別子で指定された API の操作の詳細を更新します。	コア	GA
az apim api release	Azure API Management API リリースを管理します。	コア	GA
az apim api release create	API の新しいリリースを作成します。	コア	GA
az apim api release delete	API で指定したリリースを削除します。	コア	GA
az apim api release list	API のすべてのリリースを一覧表示します。	コア	GA
az apim api release show	API リリースの詳細を返します。	コア	GA
az apim api release update	識別子で指定された API のリリースの詳細を更新します。	コア	GA
az apim api revision	Azure API Management API リビジョンを管理します。	コア	GA
az apim api revision create	API リビジョンを作成します。	コア	GA
az apim api revision list	API のすべてのリビジョンを一覧表示します。	コア	GA
az apim api schema	Azure API Management API スキーマを管理します。	コア	GA
az apim api schema create	API Management API スキーマを作成します。	コア	GA
az apim api schema delete	API Management API スキーマを削除します。	コア	GA
az apim api schema get-etag	API Management API スキーマの etag を取得します。	コア	GA
az apim api schema list	API Management API スキーマを一覧表示します。	コア	GA
az apim api schema show	API Management API スキーマの詳細を表示します。	コア	GA
az apim api schema wait	apim api スキーマの条件が満たされるまで、CLI を待機状態にします。	コア	GA
az apim api show	API Management API の詳細を表示します。	コア	GA
az apim api update	API Management API を更新します。	コア	GA
az apim api versionset	Azure API Management API バージョンセットを管理します。	コア	GA
az apim api versionset create	API バージョンセットを作成します。	コア	GA
az apim api versionset delete	特定の API バージョンセットを削除します。	コア	GA
az apim api versionset list	指定されたサービスインスタンスにおける API バージョンセットのコレクションを一覧表示します。	コア	GA
az apim api versionset show	識別子で指定された API バージョンセットの詳細を取得します。	コア	GA
az apim api versionset update	識別子で指定された Api VersionSet の詳細を更新します。	コア	GA
az apim api wait	apim API の条件が満たされるまで、CLI を待機状態にします。	コア	GA

az apim api create

編集

API Management API を作成します。

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

例

基本的な API を作成します。

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

必須のパラメーター

--api-id

作成する API の一意の名前。

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

--display-name

作成する API の表示名。

--path

API へのパス。

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--api-type

API の型。

承認された値: graphql, http, soap, websocket

--authorization-scope

OAuth 操作スコープを指定します。

--authorization-server-id

OAuth 承認サーバー ID を指定します。

--bearer-token-sending-methods

ベアラートークンの送信メソッドを指定します。

--description

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

--no-wait

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

既定値: False

--open-id-provider-id

認証設定の openid を指定します。

--protocols

この API の操作を呼び出すことができるプロトコルを記述します。

承認された値: http, https, ws, wss

--service-url

この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。

--subscription-key-header-name

サブスクリプションキーのヘッダー名を指定します。

--subscription-key-query-param-name

サブスクリプションキークエリ文字列パラメーター名を指定します。

--subscription-key-required

この API の呼び出し中にサブスクリプションキーが必要かどうかを指定します。true - API は閉じた製品にのみ含まれます。false - API はオープン製品のみに含まれます。null - 製品が混在しています。

--subscription-required

true の場合、API には要求時にサブスクリプションキーが必要です。

承認された値: false, true

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

編集

API Management API を削除します。

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

必須のパラメーター

--api-id

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

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--delete-revisions

API のすべてのリビジョンを削除します。

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

編集

API Management API をエクスポートします。

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

例

API Management API をファイルにエクスポートするか、エクスポートのリンクを含む応答を返します。

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

必須のパラメーター

--api-id

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。正規表現パターン: ^[^*#>:<>?]+$.

--ef --export-format

エクスポート API の形式を指定します。

承認された値: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

リソースグループの名前。名前の大文字と小文字は区別されます。

--service-name -n

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

省略可能のパラメーター

--file-path -f

API をエクスポートするために指定されたファイルパス。

グローバルパラメーター

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

編集

API Management API をインポートします。

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

例

ファイルまたは URL から API Management API をインポートする

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

必須のパラメーター

--path

必須。 API Management サービスインスタンス内のこの API とそのすべてのリソースパスを一意に識別する相対 URL。

--resource-group -g

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

--service-name -n

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

--specification-format

インポートした API の形式を指定します。

承認された値: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

省略可能のパラメーター

--api-id

--api-revision

API のリビジョンについて説明します。値が指定されていない場合は、既定のリビジョン 1 が作成されます。

--api-type

API の型。

承認された値: graphql, http, soap, websocket

--api-version

API のバージョンについて説明します。バージョン管理されていない API にバージョンを追加すると、元のバージョンが自動的に作成され、既定の URL に応答します。

--api-version-set-id

API で使用するバージョンセットについて説明します。

--description

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

--display-name

この API の表示名。

--no-wait

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

既定値: False

--protocols

この API の操作を呼び出すことができるプロトコル (1 つ以上) について説明します。

承認された値: http, https, ws, wss

--service-url

この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。

--soap-api-type

ファイル形式が WSDL の場合の API の種類。

--specification-path

API をインポートするために指定されたファイルパス。

--specification-url

API をインポートするために指定された URL。

--subscription-key-header-name

サブスクリプションキーのヘッダー名を指定します。

--subscription-key-query-param-name

サブスクリプションキークエリ文字列パラメーター名を指定します。

--subscription-required

true の場合、API には要求時にサブスクリプションキーが必要です。

承認された値: false, true

--wsdl-endpoint-name

インポートする WSDL エンドポイント (ポート) のローカル名。

--wsdl-service-name

インポートする WSDL サービスのローカル名。

グローバルパラメーター

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

編集

API Management API を一覧表示します。

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

必須のパラメーター

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--filter-display-name

displayName による API のフィルター処理。

--skip

スキップするレコードの数。

--top

返されるレコードの数。

グローバルパラメーター

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

編集

API Management API の詳細を表示します。

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

必須のパラメーター

--api-id

--resource-group -g

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

--service-name

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

編集

API Management API を更新します。

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

例

基本的な API を作成します。

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

必須のパラメーター

--api-id

作成する API の一意の名前。

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--add

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

既定値: []

--api-type

API の型。

承認された値: graphql, http, soap, websocket

--description

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

--display-name

API 名。長さは 1 ~ 300 文字にする必要があります。

--force-string

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

既定値: False

--if-match

エンティティの ETag。エンティティを作成する場合は必要ありませんが、エンティティを更新する場合は必須です。既定値は None です。

--no-wait

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

既定値: False

--path

必須。 API Management サービスインスタンス内のこの API とそのすべてのリソースパスを一意に識別する相対 URL。

--protocols

この API の操作を呼び出すことができるプロトコルを記述します。

承認された値: http, https, ws, wss

--remove

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

既定値: []

--service-url

この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。

--set

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

既定値: []

--subscription-key-header-name

サブスクリプションキーのヘッダー名を指定します。

--subscription-key-query-param-name

サブスクリプションキークエリ文字列パラメーター名を指定します。

--subscription-required

true の場合、API には要求時にサブスクリプションキーが必要です。

承認された値: false, true

--tags

スペース区切りのタグ: key[=value] [key[=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 api wait

編集

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

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

例

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

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

必須のパラメーター

--api-id

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

--name -n

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

--resource-group -g

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

省略可能のパラメーター

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

次の方法で共有

az apim api

コマンド

az apim api create

例

必須のパラメーター

省略可能のパラメーター

az apim api delete

必須のパラメーター

省略可能のパラメーター

az apim api export

例

必須のパラメーター

省略可能のパラメーター

az apim api import

例

必須のパラメーター

省略可能のパラメーター

az apim api list

必須のパラメーター

省略可能のパラメーター

az apim api show

必須のパラメーター

az apim api update

例

必須のパラメーター

省略可能のパラメーター

az apim api wait

例

必須のパラメーター

省略可能のパラメーター

その他のリソース