az apim api operation

リファレンス

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

コマンド

名前	説明	型	状態
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 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]

例

複数のパラメーターを使用して 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 はリビジョン番号です。

--display-name

必須。操作名。

--method

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

--resource-group -g

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

--service-name -n

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

--url-template

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

省略可能のパラメーター

--description

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

--if-match

エンティティの ETag。

--operation-id

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

--params --template-parameters -p

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

グローバルパラメーター

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

編集

API の指定された操作を削除します。

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

例

API の指定された操作を削除します。

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

必須のパラメーター

--api-id

--operation-id

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

--resource-group -g

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

--service-name -n

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

省略可能のパラメーター

--if-match

エンティティの ETag。

グローバルパラメーター

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

編集

指定した API の操作のコレクションを一覧表示します。

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

例

指定した API の操作のコレクションを一覧表示します。

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

必須のパラメーター

--api-id

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

編集

識別子で指定された API 操作の詳細を取得します。

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

例

識別子で指定された API 操作の詳細を取得します。

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

必須のパラメーター

--api-id

--operation-id

API 内の操作識別子。現在の 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 api operation update

編集

識別子で指定された API の操作の詳細を更新します。

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

例

更新メソッド、displayname、識別子で指定された API の操作の説明。

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

必須のパラメーター

--api-id

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

規定値: []

--description

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

--display-name

必須。操作名。

--force-string

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

規定値: False

--if-match

エンティティの ETag。

--method

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

--remove

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

規定値: []

--set

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

規定値: []

--url-template

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

グローバルパラメーター

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

コマンド

az apim api operation create

例

必須のパラメーター

省略可能のパラメーター

az apim api operation delete

例

必須のパラメーター

省略可能のパラメーター

az apim api operation list

例

必須のパラメーター

az apim api operation show

例

必須のパラメーター

az apim api operation update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース