Api Operation - Create Or Update

Dienst:

API Management

API-Version:

2022-08-01

Erstellt einen neuen Vorgang in der API oder aktualisiert einen bereits vorhandenen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiId	path	True	string	API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Die nicht aktuelle Revision hat ; rev=n als Suffix, wobei n die Revisionsnummer ist. RegEx-Muster: ^[^*#&+:<>?]+$
operationId	path	True	string	Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management-Dienst instance eindeutig sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Entität. Nicht erforderlich beim Erstellen einer Entität, aber erforderlich beim Aktualisieren einer Entität.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.displayName	True	string	Vorgangsname.
properties.method	True	string	Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.
properties.urlTemplate	True	string	Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date}
properties.description		string	Beschreibung des Vorgangs. Kann HTML-Formatierungstags umfassen.
properties.policies		string	Vorgangsrichtlinien
properties.request		RequestContract	Eine Entität, die Anforderungsdetails enthält.
properties.responses		ResponseContract[]	Array von Vorgangsantworten.
properties.templateParameters		ParameterContract[]	Sammlung von URL-Vorlagenparametern.

Antworten

Name	Typ	Beschreibung
200 OK	OperationContract	Der Vorgang wurde erfolgreich aktualisiert. Header ETag: string
201 Created	OperationContract	Vorgang wurde erfolgreich erstellt. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementCreateApiOperation

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations?api-version=2022-08-01

{
  "properties": {
    "displayName": "createUser2",
    "method": "POST",
    "urlTemplate": "/user1",
    "templateParameters": [],
    "description": "This can only be done by the logged in user.",
    "request": {
      "description": "Created user object",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "application/json",
          "schemaId": "592f6c1d0af5840ca8897f0c",
          "typeName": "User"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.RepresentationContract;
import com.azure.resourcemanager.apimanagement.models.RequestContract;
import com.azure.resourcemanager.apimanagement.models.ResponseContract;
import java.util.Arrays;

/** Samples for ApiOperation CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiOperation.json
     */
    /**
     * Sample code: ApiManagementCreateApiOperation.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateApiOperation(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiOperations()
            .define("newoperations")
            .withExistingApi("rg1", "apimService1", "PetStoreTemplate2")
            .withDisplayName("createUser2")
            .withMethod("POST")
            .withUrlTemplate("/user1")
            .withTemplateParameters(Arrays.asList())
            .withDescription("This can only be done by the logged in user.")
            .withRequest(
                new RequestContract()
                    .withDescription("Created user object")
                    .withQueryParameters(Arrays.asList())
                    .withHeaders(Arrays.asList())
                    .withRepresentations(
                        Arrays
                            .asList(
                                new RepresentationContract()
                                    .withContentType("application/json")
                                    .withSchemaId("592f6c1d0af5840ca8897f0c")
                                    .withTypeName("User"))))
            .withResponses(
                Arrays
                    .asList(
                        new ResponseContract()
                            .withStatusCode(200)
                            .withDescription("successful operation")
                            .withRepresentations(
                                Arrays
                                    .asList(
                                        new RepresentationContract().withContentType("application/xml"),
                                        new RepresentationContract().withContentType("application/json")))
                            .withHeaders(Arrays.asList())))
            .create();
    }
}

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 typing import Any, IO, Union

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_create_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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="PetStoreTemplate2",
        operation_id="newoperations",
        parameters={
            "properties": {
                "description": "This can only be done by the logged in user.",
                "displayName": "createUser2",
                "method": "POST",
                "request": {
                    "description": "Created user object",
                    "headers": [],
                    "queryParameters": [],
                    "representations": [
                        {"contentType": "application/json", "schemaId": "592f6c1d0af5840ca8897f0c", "typeName": "User"}
                    ],
                },
                "responses": [
                    {
                        "description": "successful operation",
                        "headers": [],
                        "representations": [{"contentType": "application/xml"}, {"contentType": "application/json"}],
                        "statusCode": 200,
                    }
                ],
                "templateParameters": [],
                "urlTemplate": "/user1",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiOperation.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiOperation.json
func ExampleAPIOperationClient_CreateOrUpdate() {
	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().CreateOrUpdate(ctx, "rg1", "apimService1", "PetStoreTemplate2", "newoperations", armapimanagement.OperationContract{
		Properties: &armapimanagement.OperationContractProperties{
			Description:        to.Ptr("This can only be done by the logged in user."),
			TemplateParameters: []*armapimanagement.ParameterContract{},
			Request: &armapimanagement.RequestContract{
				Description:     to.Ptr("Created user object"),
				Headers:         []*armapimanagement.ParameterContract{},
				QueryParameters: []*armapimanagement.ParameterContract{},
				Representations: []*armapimanagement.RepresentationContract{
					{
						ContentType: to.Ptr("application/json"),
						SchemaID:    to.Ptr("592f6c1d0af5840ca8897f0c"),
						TypeName:    to.Ptr("User"),
					}},
			},
			Responses: []*armapimanagement.ResponseContract{
				{
					Description: to.Ptr("successful operation"),
					Headers:     []*armapimanagement.ParameterContract{},
					Representations: []*armapimanagement.RepresentationContract{
						{
							ContentType: to.Ptr("application/xml"),
						},
						{
							ContentType: to.Ptr("application/json"),
						}},
					StatusCode: to.Ptr[int32](200),
				}},
			Method:      to.Ptr("POST"),
			DisplayName: to.Ptr("createUser2"),
			URLTemplate: to.Ptr("/user1"),
		},
	}, &armapimanagement.APIOperationClientCreateOrUpdateOptions{IfMatch: 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("newoperations"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis/operations"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations"),
	// 	Properties: &armapimanagement.OperationContractProperties{
	// 		Description: to.Ptr("This can only be done by the logged in user."),
	// 		TemplateParameters: []*armapimanagement.ParameterContract{
	// 		},
	// 		Request: &armapimanagement.RequestContract{
	// 			Description: to.Ptr("Created user object"),
	// 			Headers: []*armapimanagement.ParameterContract{
	// 			},
	// 			QueryParameters: []*armapimanagement.ParameterContract{
	// 			},
	// 			Representations: []*armapimanagement.RepresentationContract{
	// 				{
	// 					ContentType: to.Ptr("application/json"),
	// 					SchemaID: to.Ptr("592f6c1d0af5840ca8897f0c"),
	// 					TypeName: to.Ptr("User"),
	// 			}},
	// 		},
	// 		Responses: []*armapimanagement.ResponseContract{
	// 			{
	// 				Description: to.Ptr("successful operation"),
	// 				Headers: []*armapimanagement.ParameterContract{
	// 				},
	// 				Representations: []*armapimanagement.RepresentationContract{
	// 					{
	// 						ContentType: to.Ptr("application/xml"),
	// 					},
	// 					{
	// 						ContentType: to.Ptr("application/json"),
	// 				}},
	// 				StatusCode: to.Ptr[int32](200),
	// 		}},
	// 		Method: to.Ptr("POST"),
	// 		DisplayName: to.Ptr("createUser2"),
	// 		URLTemplate: to.Ptr("/user1"),
	// 	},
	// }
}

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 Creates a new operation in the API or updates an existing one.
 *
 * @summary Creates a new operation in the API or updates an existing one.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiOperation.json
 */
async function apiManagementCreateApiOperation() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "PetStoreTemplate2";
  const operationId = "newoperations";
  const parameters = {
    method: "POST",
    description: "This can only be done by the logged in user.",
    displayName: "createUser2",
    templateParameters: [],
    urlTemplate: "/user1",
    request: {
      description: "Created user object",
      headers: [],
      queryParameters: [],
      representations: [
        {
          contentType: "application/json",
          schemaId: "592f6c1d0af5840ca8897f0c",
          typeName: "User",
        },
      ],
    },
    responses: [
      {
        description: "successful operation",
        headers: [],
        representations: [{ contentType: "application/xml" }, { contentType: "application/json" }],
        statusCode: 200,
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiOperation.createOrUpdate(
    resourceGroupName,
    serviceName,
    apiId,
    operationId,
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiOperation.json
// this example is just showing the usage of "ApiOperation_CreateOrUpdate" 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 ApiResource created on azure
// for more information of creating ApiResource, please refer to the document of ApiResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "PetStoreTemplate2";
ResourceIdentifier apiResourceId = ApiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
ApiResource api = client.GetApiResource(apiResourceId);

// get the collection of this ApiOperationResource
ApiOperationCollection collection = api.GetApiOperations();

// invoke the operation
string operationId = "newoperations";
ApiOperationData data = new ApiOperationData()
{
    TemplateParameters =
    {
    },
    Description = "This can only be done by the logged in user.",
    Request = new RequestContract()
    {
        Description = "Created user object",
        QueryParameters =
        {
        },
        Headers =
        {
        },
        Representations =
        {
        new RepresentationContract("application/json")
        {
        SchemaId = "592f6c1d0af5840ca8897f0c",
        TypeName = "User",
        }
        },
    },
    Responses =
    {
    new ResponseContract(200)
    {
    Description = "successful operation",
    Representations =
    {
    new RepresentationContract("application/xml"),new RepresentationContract("application/json")
    },
    Headers =
    {
    },
    }
    },
    DisplayName = "createUser2",
    Method = "POST",
    UriTemplate = "/user1",
};
ArmOperation<ApiOperationResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, operationId, data);
ApiOperationResource result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations",
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "name": "newoperations",
  "properties": {
    "displayName": "createUser2",
    "method": "POST",
    "urlTemplate": "/user1",
    "templateParameters": [],
    "description": "This can only be done by the logged in user.",
    "request": {
      "description": "Created user object",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "application/json",
          "schemaId": "592f6c1d0af5840ca8897f0c",
          "typeName": "User"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations",
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "name": "newoperations",
  "properties": {
    "displayName": "createUser2",
    "method": "POST",
    "urlTemplate": "/user1",
    "templateParameters": [],
    "description": "This can only be done by the logged in user.",
    "request": {
      "description": "Created user object",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "application/json",
          "schemaId": "592f6c1d0af5840ca8897f0c",
          "typeName": "User"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
OperationContract	API-Vorgangsdetails.
ParameterContract	Details zu Vorgangsparametern.
ParameterExampleContract	Parameterbeispiel.
RepresentationContract	Details zur Vorgangsanforderungs-/Antwortdarstellung.
RequestContract	Details zur Vorgangsanforderung.
ResponseContract	Details zur Vorgangsantwort.

ErrorFieldContract

Fehler Feldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

OperationContract

API-Vorgangsdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.description	string	Beschreibung des Vorgangs. Kann HTML-Formatierungstags umfassen.
properties.displayName	string	Vorgangsname.
properties.method	string	Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.
properties.policies	string	Vorgangsrichtlinien
properties.request	RequestContract	Eine Entität, die Anforderungsdetails enthält.
properties.responses	ResponseContract[]	Array von Vorgangsantworten.
properties.templateParameters	ParameterContract[]	Sammlung von URL-Vorlagenparametern.
properties.urlTemplate	string	Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date}
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ParameterContract

Details zu Vorgangsparametern.

Name	Typ	Beschreibung
defaultValue	string	Standardparameterwert.
description	string	Beschreibung des Parameters.
examples	<string,  ParameterExampleContract>	Beispiel, das für den -Parameter definiert ist.
name	string	Parametername.
required	boolean	Gibt an, ob der Parameter erforderlich ist oder nicht.
schemaId	string	Schemabezeichner.
type	string	Der Parametertyp.
typeName	string	Geben Sie den vom Schema definierten Namen ein.
values	string[]	Parameterwerte.

ParameterExampleContract

Parameterbeispiel.

Name	Typ	Beschreibung
description	string	Lange Beschreibung für das Beispiel
externalValue	string	Eine URL, die auf das Literalbeispiel verweist
summary	string	Kurzbeschreibung für das Beispiel
value		Beispielwert. Kann ein primitiver Wert oder ein Objekt sein.

RepresentationContract

Details zur Vorgangsanforderungs-/Antwortdarstellung.

Name	Typ	Beschreibung
contentType	string	Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml.
examples	<string,  ParameterExampleContract>	Beispiel, das für die Darstellung definiert ist.
formParameters	ParameterContract[]	Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist.
schemaId	string	Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist.
typeName	string	Geben Sie den vom Schema definierten Namen ein. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist.

RequestContract

Details zur Vorgangsanforderung.

Name	Typ	Beschreibung
description	string	Vorgangsanforderungsbeschreibung.
headers	ParameterContract[]	Auflistung der Vorgangsanforderungsheader.
queryParameters	ParameterContract[]	Auflistung der Vorgangsanforderungs-Abfrageparameter.
representations	RepresentationContract[]	Die Sammlung von Vorgangsanforderungsdarstellungen.

ResponseContract

Details zur Vorgangsantwort.

Name	Typ	Beschreibung
description	string	Vorgangsantwortbeschreibung.
headers	ParameterContract[]	Sammlung von Vorgangsantwortheadern.
representations	RepresentationContract[]	Die Sammlung von Vorgangsantwortdarstellungen.
statusCode	integer	Vorgangsantwort HTTP-status Code.