az apim api operation

Azure API Management API 操作を管理します。

コマンド

名前	説明	型	状態
az apim api operation create	API で新しい操作を作成します。	Core	GA
az apim api operation delete	API で指定された操作を削除します。	Core	GA
az apim api operation list	指定した API の操作のコレクションを一覧表示します。	Core	GA
az apim api operation show	識別子で指定された API 操作の詳細を取得します。	Core	GA
az apim api operation update	識別子で指定された API の操作の詳細を更新します。	Core	GA

az apim api operation create

編集

API で新しい操作を作成します。

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params --template-parameters]

例

複数のパラメーターを使用して API に新しい操作を作成します

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

必須のパラメーター

--api-id

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

プロパティ	値
Parameter group:	API Arguments

--display-name

Required. 操作名。

--method

Required. 有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。

--resource-group -g

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

--service-name -n

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

--url-template

この操作のターゲットリソースを識別する相対 URL テンプレート。パラメーターを含めることができます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

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

--if-match

エンティティの ETag。

--operation-id

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

--params --template-parameters -p

URL テンプレートパラメーターのコレクション。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False