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 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiId	path	True	string	API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 가 있습니다. rev=n은 접미사로, 여기서 n은 수정 번호입니다. regex 패턴: ^[^*#&+:<>?]+$
operationId	path	True	string	API 내의 작업 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
resourceGroupName	path	True	string	리소스 그룹의 이름.
serviceName	path	True	string	API Management 서비스의 이름입니다. regex 패턴: ^[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의 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match	True	string	엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.

요청 본문

Name	형식	Description
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}

응답

Name	형식	Description
200 OK	OperationContract	작업이 성공적으로 업데이트되었습니다. 헤더 ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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": []
      }
    ]
  }
}

정의

Name	Description
ErrorFieldContract	오류 필드 계약입니다.
ErrorResponse	오류 응답.
OperationContract	API 작업 세부 정보입니다.
OperationUpdateContract	API 작업 업데이트 계약 세부 정보입니다.
ParameterContract	작업 매개 변수 세부 정보입니다.
ParameterExampleContract	매개 변수 예제입니다.
RepresentationContract	작업 요청/응답 표현 세부 정보입니다.
RequestContract	작업 요청 세부 정보입니다.
ResponseContract	작업 응답 세부 정보입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

OperationContract

API 작업 세부 정보입니다.

Name	형식	Description
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 작업 업데이트 계약 세부 정보입니다.

Name	형식	Description
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

작업 매개 변수 세부 정보입니다.

Name	형식	Description
defaultValue	string	기본 매개 변수 값입니다.
description	string	매개 변수 설명입니다.
examples	<string,  ParameterExampleContract>	매개 변수에 대해 정의된 예제입니다.
name	string	매개 변수 이름입니다.
required	boolean	매개 변수가 필요한지 여부를 지정합니다.
schemaId	string	스키마 식별자입니다.
type	string	매개 변수 유형입니다.
typeName	string	스키마에서 정의한 형식 이름입니다.
values	string[]	매개 변수 값입니다.

ParameterExampleContract

매개 변수 예제입니다.

Name	형식	Description
description	string	예제에 대한 긴 설명
externalValue	string	리터럴 예제를 가리키는 URL
summary	string	예제에 대한 간단한 설명
value		예제 값입니다. 기본 값 또는 개체일 수 있습니다.

RepresentationContract

작업 요청/응답 표현 세부 정보입니다.

Name	형식	Description
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

작업 요청 세부 정보입니다.

Name	형식	Description
description	string	작업 요청 설명입니다.
headers	ParameterContract[]	작업 요청 헤더의 컬렉션입니다.
queryParameters	ParameterContract[]	작업 요청 쿼리 매개 변수의 컬렉션입니다.
representations	RepresentationContract[]	작업 요청 표현의 컬렉션입니다.

ResponseContract

작업 응답 세부 정보입니다.

Name	형식	Description
description	string	작업 응답 설명입니다.
headers	ParameterContract[]	작업 응답 헤더의 컬렉션입니다.
representations	RepresentationContract[]	작업 응답 표현의 컬렉션입니다.
statusCode	integer	작업 응답 HTTP 상태 코드입니다.