Api Operation - Update

サービス:

API Management

API バージョン:

2021-08-01

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

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}?api-version=2021-08-01

URI パラメーター

名前	/	必須	型	説明
apiId	path	True	string	API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在以外のリビジョンには があります。rev=n はサフィックスで、n はリビジョン番号です。 正規表現パターン: ^[^*#&+:<>?]+$
operationId	path	True	string	API 内の操作識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
resourceGroupName	path	True	string	リソース グループの名前。
serviceName	path	True	string	API Management サービスの名前。 正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
properties.description	string	操作の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	操作名。
properties.method	string	有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、それらに限定されません。
properties.policies	string	操作ポリシー
properties.request	RequestContract	要求の詳細を含むエンティティ。
properties.responses	ResponseContract[]	操作応答の配列。
properties.templateParameters	ParameterContract[]	URL テンプレート パラメーターのコレクション。
properties.urlTemplate	string	この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date}

応答

名前	型	説明
200 OK	OperationContract	操作が正常に更新されました。 ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ApiManagementUpdateApiOperation

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/operationId?api-version=2021-08-01


{
  "properties": {
    "displayName": "Retrieve resource",
    "method": "GET",
    "urlTemplate": "/resource",
    "templateParameters": [],
    "request": {
      "queryParameters": [
        {
          "name": "param1",
          "description": "A sample parameter that is required and has a default value of \"sample\".",
          "type": "string",
          "defaultValue": "sample",
          "required": true,
          "values": [
            "sample"
          ]
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "Returned in all cases.",
        "representations": [],
        "headers": []
      },
      {
        "statusCode": 500,
        "description": "Server Error.",
        "representations": [],
        "headers": []
      }
    ]
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.OperationContract;
import com.azure.resourcemanager.apimanagement.models.ParameterContract;
import com.azure.resourcemanager.apimanagement.models.RequestContract;
import com.azure.resourcemanager.apimanagement.models.ResponseContract;
import java.util.Arrays;

/** Samples for ApiOperation Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiOperation.json
     */
    /**
     * Sample code: ApiManagementUpdateApiOperation.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateApiOperation(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        OperationContract resource =
            manager
                .apiOperations()
                .getWithResponse("rg1", "apimService1", "echo-api", "operationId", Context.NONE)
                .getValue();
        resource
            .update()
            .withDisplayName("Retrieve resource")
            .withMethod("GET")
            .withUrlTemplate("/resource")
            .withTemplateParameters(Arrays.asList())
            .withRequest(
                new RequestContract()
                    .withQueryParameters(
                        Arrays
                            .asList(
                                new ParameterContract()
                                    .withName("param1")
                                    .withDescription(
                                        "A sample parameter that is required and has a default value of \"sample\".")
                                    .withType("string")
                                    .withDefaultValue("sample")
                                    .withRequired(true)
                                    .withValues(Arrays.asList("sample")))))
            .withResponses(
                Arrays
                    .asList(
                        new ResponseContract()
                            .withStatusCode(200)
                            .withDescription("Returned in all cases.")
                            .withRepresentations(Arrays.asList())
                            .withHeaders(Arrays.asList()),
                        new ResponseContract()
                            .withStatusCode(500)
                            .withDescription("Server Error.")
                            .withRepresentations(Arrays.asList())
                            .withHeaders(Arrays.asList())))
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_api_operation.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_operation.update(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="echo-api",
        operation_id="operationId",
        if_match="*",
        parameters={
            "properties": {
                "displayName": "Retrieve resource",
                "method": "GET",
                "request": {
                    "queryParameters": [
                        {
                            "defaultValue": "sample",
                            "description": 'A sample parameter that is required and has a default value of "sample".',
                            "name": "param1",
                            "required": True,
                            "type": "string",
                            "values": ["sample"],
                        }
                    ]
                },
                "responses": [
                    {"description": "Returned in all cases.", "headers": [], "representations": [], "statusCode": 200},
                    {"description": "Server Error.", "headers": [], "representations": [], "statusCode": 500},
                ],
                "templateParameters": [],
                "urlTemplate": "/resource",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiOperation.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiOperation.json
func ExampleAPIOperationClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPIOperationClient().Update(ctx, "rg1", "apimService1", "echo-api", "operationId", "*", armapimanagement.OperationUpdateContract{
		Properties: &armapimanagement.OperationUpdateContractProperties{
			TemplateParameters: []*armapimanagement.ParameterContract{},
			Request: &armapimanagement.RequestContract{
				QueryParameters: []*armapimanagement.ParameterContract{
					{
						Name:         to.Ptr("param1"),
						Type:         to.Ptr("string"),
						Description:  to.Ptr("A sample parameter that is required and has a default value of \"sample\"."),
						DefaultValue: to.Ptr("sample"),
						Required:     to.Ptr(true),
						Values: []*string{
							to.Ptr("sample")},
					}},
			},
			Responses: []*armapimanagement.ResponseContract{
				{
					Description:     to.Ptr("Returned in all cases."),
					Headers:         []*armapimanagement.ParameterContract{},
					Representations: []*armapimanagement.RepresentationContract{},
					StatusCode:      to.Ptr[int32](200),
				},
				{
					Description:     to.Ptr("Server Error."),
					Headers:         []*armapimanagement.ParameterContract{},
					Representations: []*armapimanagement.RepresentationContract{},
					StatusCode:      to.Ptr[int32](500),
				}},
			Method:      to.Ptr("GET"),
			DisplayName: to.Ptr("Retrieve resource"),
			URLTemplate: to.Ptr("/resource"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationContract = armapimanagement.OperationContract{
	// 	Name: to.Ptr("57d2ef278aa04f0ad01d6cdc"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis/operations"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc"),
	// 	Properties: &armapimanagement.OperationContractProperties{
	// 		TemplateParameters: []*armapimanagement.ParameterContract{
	// 		},
	// 		Request: &armapimanagement.RequestContract{
	// 			Description: to.Ptr("IFazioService_CancelOrder_InputMessage"),
	// 			Headers: []*armapimanagement.ParameterContract{
	// 			},
	// 			QueryParameters: []*armapimanagement.ParameterContract{
	// 			},
	// 			Representations: []*armapimanagement.RepresentationContract{
	// 				{
	// 					ContentType: to.Ptr("text/xml"),
	// 					SchemaID: to.Ptr("6980a395-f08b-4a59-8295-1440cbd909b8"),
	// 					TypeName: to.Ptr("CancelOrder"),
	// 			}},
	// 		},
	// 		Responses: []*armapimanagement.ResponseContract{
	// 			{
	// 				Description: to.Ptr("IFazioService_CancelOrder_OutputMessage"),
	// 				Headers: []*armapimanagement.ParameterContract{
	// 				},
	// 				Representations: []*armapimanagement.RepresentationContract{
	// 					{
	// 						ContentType: to.Ptr("text/xml"),
	// 						SchemaID: to.Ptr("6980a395-f08b-4a59-8295-1440cbd909b8"),
	// 						TypeName: to.Ptr("CancelOrderResponse"),
	// 				}},
	// 				StatusCode: to.Ptr[int32](200),
	// 		}},
	// 		Method: to.Ptr("POST"),
	// 		DisplayName: to.Ptr("CancelOrder"),
	// 		URLTemplate: to.Ptr("/?soapAction=http://tempuri.org/IFazioService/CancelOrder"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the details of the operation in the API specified by its identifier.
 *
 * @summary Updates the details of the operation in the API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiOperation.json
 */
async function apiManagementUpdateApiOperation() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api";
  const operationId = "operationId";
  const ifMatch = "*";
  const parameters = {
    method: "GET",
    displayName: "Retrieve resource",
    templateParameters: [],
    urlTemplate: "/resource",
    request: {
      queryParameters: [
        {
          name: "param1",
          type: "string",
          description: 'A sample parameter that is required and has a default value of "sample".',
          defaultValue: "sample",
          required: true,
          values: ["sample"],
        },
      ],
    },
    responses: [
      {
        description: "Returned in all cases.",
        headers: [],
        representations: [],
        statusCode: 200,
      },
      {
        description: "Server Error.",
        headers: [],
        representations: [],
        statusCode: 500,
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiOperation.update(
    resourceGroupName,
    serviceName,
    apiId,
    operationId,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiOperation.json
// this example is just showing the usage of "ApiOperation_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiOperationResource created on azure
// for more information of creating ApiOperationResource, please refer to the document of ApiOperationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "echo-api";
string operationId = "operationId";
ResourceIdentifier apiOperationResourceId = ApiOperationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId, operationId);
ApiOperationResource apiOperation = client.GetApiOperationResource(apiOperationResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiOperationPatch patch = new ApiOperationPatch()
{
    TemplateParameters =
    {
    },
    Request = new RequestContract()
    {
        QueryParameters =
        {
        new ParameterContract("param1","string")
        {
        Description = "A sample parameter that is required and has a default value of \"sample\".",
        DefaultValue = "sample",
        IsRequired = true,
        Values =
        {
        "sample"
        },
        }
        },
    },
    Responses =
    {
    new ResponseContract(200)
    {
    Description = "Returned in all cases.",
    Representations =
    {
    },
    Headers =
    {
    },
    },new ResponseContract(500)
    {
    Description = "Server Error.",
    Representations =
    {
    },
    Headers =
    {
    },
    }
    },
    DisplayName = "Retrieve resource",
    Method = "GET",
    UriTemplate = "/resource",
};
ApiOperationResource result = await apiOperation.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiOperationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "name": "57d2ef278aa04f0ad01d6cdc",
  "properties": {
    "displayName": "CancelOrder",
    "method": "POST",
    "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder",
    "templateParameters": [],
    "request": {
      "description": "IFazioService_CancelOrder_InputMessage",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "text/xml",
          "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8",
          "typeName": "CancelOrder"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "IFazioService_CancelOrder_OutputMessage",
        "representations": [
          {
            "contentType": "text/xml",
            "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8",
            "typeName": "CancelOrderResponse"
          }
        ],
        "headers": []
      }
    ]
  }
}

定義

名前	説明
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
OperationContract	API 操作の詳細。
OperationUpdateContract	API 操作の更新コントラクトの詳細。
ParameterContract	操作パラメーターの詳細。
ParameterExampleContract	パラメーターの例。
RepresentationContract	操作の要求/応答表現の詳細。
RequestContract	操作要求の詳細。
ResponseContract	操作応答の詳細。

ErrorFieldContract

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

OperationContract

API 操作の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.description	string	操作の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	操作名。
properties.method	string	有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、それらに限定されません。
properties.policies	string	操作ポリシー
properties.request	RequestContract	要求の詳細を含むエンティティ。
properties.responses	ResponseContract[]	操作応答の配列。
properties.templateParameters	ParameterContract[]	URL テンプレート パラメーターのコレクション。
properties.urlTemplate	string	この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date}
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

OperationUpdateContract

API 操作の更新コントラクトの詳細。

名前	型	説明
properties.description	string	操作の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	操作名。
properties.method	string	有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、それらに限定されません。
properties.policies	string	操作ポリシー
properties.request	RequestContract	要求の詳細を含むエンティティ。
properties.responses	ResponseContract[]	操作応答の配列。
properties.templateParameters	ParameterContract[]	URL テンプレート パラメーターのコレクション。
properties.urlTemplate	string	この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date}

ParameterContract

操作パラメーターの詳細。

名前	型	説明
defaultValue	string	パラメーターの既定値。
description	string	パラメーターの説明。
examples	<string,  ParameterExampleContract>	パラメーターに対して定義された例。
name	string	パラメーター名です。
required	boolean	パラメーターが必要かどうかを指定します。
schemaId	string	スキーマ識別子。
type	string	パラメーターの型。
typeName	string	スキーマで定義された型名。
values	string[]	パラメーター値。

ParameterExampleContract

パラメーターの例。

名前	型	説明
description	string	例の長い説明
externalValue	string	リテラルの例を指す URL
summary	string	例の簡単な説明
value		値の例。 プリミティブ値またはオブジェクトを指定できます。

RepresentationContract

操作の要求/応答表現の詳細。

名前	型	説明
contentType	string	この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。
examples	<string,  ParameterExampleContract>	表現に対して定義された例。
formParameters	ParameterContract[]	フォーム パラメーターのコレクション。 'contentType' 値が 'application/x-www-form-urlencoded' または 'multipart/form-data' の場合は必須です。
schemaId	string	スキーマ識別子。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。
typeName	string	スキーマで定義された型名。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。

RequestContract

操作要求の詳細。

名前	型	説明
description	string	操作要求の説明。
headers	ParameterContract[]	操作要求のヘッダーのコレクション。
queryParameters	ParameterContract[]	操作要求クエリ パラメーターのコレクション。
representations	RepresentationContract[]	操作要求表現のコレクション。

ResponseContract

操作応答の詳細。

名前	型	説明
description	string	操作応答の説明。
headers	ParameterContract[]	操作応答ヘッダーのコレクション。
representations	RepresentationContract[]	操作応答表現のコレクション。
statusCode	integer	操作応答 HTTP 状態コード。