Api Operation - Update

Reference

Service:: API Management

API Version:: 2021-08-01

Updates the details of the operation in the API specified by its identifier.

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

URI Parameters

Name	In	Required	Type	Description
apiId	path	True	string	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. Regex pattern: `^[^*#&+:<>?]+$`
operationId	path	True	string	Operation identifier within an API. Must be unique in the current API Management service instance.
resourceGroupName	path	True	string	The name of the resource group.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name	Type	Description
properties.description	string	Description of the operation. May include HTML formatting tags.
properties.displayName	string	Operation Name.
properties.method	string	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
properties.policies	string	Operation Policies
properties.request	RequestContract	An entity containing request details.
properties.responses	ResponseContract[]	Array of Operation responses.
properties.templateParameters	ParameterContract[]	Collection of URL template parameters.
properties.urlTemplate	string	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

Responses

Name

Type

Description

200 OK

OperationContract

Operation was successfully updated.

Headers

ETag: string

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementUpdateApiOperation

Sample request

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

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

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

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

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

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

Sample response

Status code:: 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": []
      }
    ]
  }
}

Definitions

Name	Description
ErrorFieldContract	Error Field contract.
ErrorResponse	Error Response.
OperationContract	API Operation details.
OperationUpdateContract	API Operation Update Contract details.
ParameterContract	Operation parameters details.
ParameterExampleContract	Parameter example.
RepresentationContract	Operation request/response representation details.
RequestContract	Operation request details.
ResponseContract	Operation response details.

ErrorFieldContract

Error Field contract.

Name	Type	Description
code	string	Property level error code.
message	string	Human-readable representation of property-level error.
target	string	Property name.

ErrorResponse

Error Response.

Name	Type	Description
error.code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
error.details	ErrorFieldContract[]	The list of invalid fields send in request, in case of validation error.
error.message	string	Human-readable representation of the error.

OperationContract

API Operation details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.description	string	Description of the operation. May include HTML formatting tags.
properties.displayName	string	Operation Name.
properties.method	string	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
properties.policies	string	Operation Policies
properties.request	RequestContract	An entity containing request details.
properties.responses	ResponseContract[]	Array of Operation responses.
properties.templateParameters	ParameterContract[]	Collection of URL template parameters.
properties.urlTemplate	string	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

OperationUpdateContract

API Operation Update Contract details.

Name	Type	Description
properties.description	string	Description of the operation. May include HTML formatting tags.
properties.displayName	string	Operation Name.
properties.method	string	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
properties.policies	string	Operation Policies
properties.request	RequestContract	An entity containing request details.
properties.responses	ResponseContract[]	Array of Operation responses.
properties.templateParameters	ParameterContract[]	Collection of URL template parameters.
properties.urlTemplate	string	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

ParameterContract

Operation parameters details.

Name	Type	Description
defaultValue	string	Default parameter value.
description	string	Parameter description.
examples	<string, ParameterExampleContract>	Exampled defined for the parameter.
name	string	Parameter name.
required	boolean	Specifies whether parameter is required or not.
schemaId	string	Schema identifier.
type	string	Parameter type.
typeName	string	Type name defined by the schema.
values	string[]	Parameter values.

ParameterExampleContract

Parameter example.

Name	Type	Description
description	string	Long description for the example
externalValue	string	A URL that points to the literal example
summary	string	Short description for the example
value		Example value. May be a primitive value, or an object.

RepresentationContract

Operation request/response representation details.

Name	Type	Description
contentType	string	Specifies a registered or custom content type for this representation, e.g. application/xml.
examples	<string, ParameterExampleContract>	Exampled defined for the representation.
formParameters	ParameterContract[]	Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
schemaId	string	Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
typeName	string	Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

RequestContract

Operation request details.

Name	Type	Description
description	string	Operation request description.
headers	ParameterContract[]	Collection of operation request headers.
queryParameters	ParameterContract[]	Collection of operation request query parameters.
representations	RepresentationContract[]	Collection of operation request representations.

ResponseContract

Operation response details.

Name	Type	Description
description	string	Operation response description.
headers	ParameterContract[]	Collection of operation response headers.
representations	RepresentationContract[]	Collection of operation response representations.
statusCode	integer	Operation response HTTP status code.