Api Operation - Update

Service:

API Management

Version d'API:

2021-08-01

Mises à jour les détails de l’opération dans l’API spécifiée par son identificateur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
apiId	path	True	string	Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ; rev=n comme suffixe où n est le numéro de révision. Modèle d’expression régulière: ^[^*#&+:<>?]+$
operationId	path	True	string	Identificateur d’opération dans une API. Doit être unique dans le instance de service Gestion des API actuel.
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string	Nom du service Gestion des API. Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match	True	string	ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

Corps de la demande

Nom	Type	Description
properties.description	string	Description de l’opération. Peut comporter des balises de mise en forme.
properties.displayName	string	Nom de l’opération.
properties.method	string	Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement.
properties.policies	string	Stratégies d’opération
properties.request	RequestContract	Entité qui contient les détails de la demande.
properties.responses	ResponseContract[]	Tableau de réponses d’opération.
properties.templateParameters	ParameterContract[]	Collection de paramètres de modèle d’URL.
properties.urlTemplate	string	Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date}

Réponses

Nom	Type	Description
200 OK	OperationContract	L’opération a été correctement mise à jour. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementUpdateApiOperation

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur.
OperationContract	Détails de l’opération d’API.
OperationUpdateContract	Détails du contrat de mise à jour de l’opération d’API.
ParameterContract	Détails des paramètres d’opération.
ParameterExampleContract	Exemple de paramètre.
RepresentationContract	Détails de la représentation de la demande/réponse de l’opération.
RequestContract	Détails de la demande d’opération.
ResponseContract	Détails de la réponse de l’opération.

ErrorFieldContract

Contrat de champ d’erreur.

Nom	Type	Description
code	string	Code d'erreur de niveau propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau des propriétés.
target	string	Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error.code	string	Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
error.details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message	string	Représentation contrôlable de visu de l’erreur.

OperationContract

Détails de l’opération d’API.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.description	string	Description de l’opération. Peut comporter des balises de mise en forme.
properties.displayName	string	Nom de l’opération.
properties.method	string	Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement.
properties.policies	string	Stratégies d’opération
properties.request	RequestContract	Entité qui contient les détails de la demande.
properties.responses	ResponseContract[]	Tableau de réponses d’opération.
properties.templateParameters	ParameterContract[]	Collection de paramètres de modèle d’URL.
properties.urlTemplate	string	Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date}
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

OperationUpdateContract

Détails du contrat de mise à jour de l’opération d’API.

Nom	Type	Description
properties.description	string	Description de l’opération. Peut comporter des balises de mise en forme.
properties.displayName	string	Nom de l’opération.
properties.method	string	Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement.
properties.policies	string	Stratégies d’opération
properties.request	RequestContract	Entité qui contient les détails de la demande.
properties.responses	ResponseContract[]	Tableau de réponses d’opération.
properties.templateParameters	ParameterContract[]	Collection de paramètres de modèle d’URL.
properties.urlTemplate	string	Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date}

ParameterContract

Détails des paramètres d’opération.

Nom	Type	Description
defaultValue	string	Valeur par défaut du paramètre.
description	string	Description du paramètre.
examples	<string,  ParameterExampleContract>	Exemple défini pour le paramètre .
name	string	Nom du paramètre.
required	boolean	Indique si le paramètre est obligatoire ou non.
schemaId	string	Identificateur de schéma.
type	string	Type de paramètre.
typeName	string	Nom de type défini par le schéma.
values	string[]	Valeurs du paramètre.

ParameterExampleContract

Exemple de paramètre.

Nom	Type	Description
description	string	Description longue de l’exemple
externalValue	string	URL qui pointe vers l’exemple littéral
summary	string	Brève description de l’exemple
value		Exemple de valeur. Il peut s’agir d’une valeur primitive ou d’un objet .

RepresentationContract

Détails de la représentation de la demande/réponse de l’opération.

Nom	Type	Description
contentType	string	Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml.
examples	<string,  ParameterExampleContract>	Exemple défini pour la représentation.
formParameters	ParameterContract[]	Collection de paramètres de formulaire. Obligatoire si la valeur « contentType » est « application/x-www-form-urlencoded » ou « multipart/form-data ».
schemaId	string	Identificateur de schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ».
typeName	string	Nom de type défini par le schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ».

RequestContract

Détails de la demande d’opération.

Nom	Type	Description
description	string	Description de la demande d’opération.
headers	ParameterContract[]	Collection d'en-têtes de la demande d'opération.
queryParameters	ParameterContract[]	Collection de paramètres de requête de la demande d'opération
representations	RepresentationContract[]	Collection de représentations de demande d’opération.

ResponseContract

Détails de la réponse de l’opération.

Nom	Type	Description
description	string	Description de la réponse de l’opération.
headers	ParameterContract[]	Collection d’en-têtes de réponse d’opération.
representations	RepresentationContract[]	Collection de représentations de la réponse de l’opération.
statusCode	integer	Code http status de réponse de l’opération.