Freigeben über


Api Operation - Update

Updates die Details des Vorgangs in der API, die durch den Bezeichner angegeben wird.

PATCH 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 True

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

Anforderungstext

Name Typ Beschreibung
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}

Antworten

Name Typ Beschreibung
200 OK

OperationContract

Der Vorgang wurde erfolgreich aktualisiert.

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

ApiManagementUpdateApiOperation

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/operationId?api-version=2022-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": []
      }
    ]
  }
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorFieldContract

Fehler Feldvertrag.

ErrorResponse

Fehlerantwort.

OperationContract

API-Vorgangsdetails.

OperationUpdateContract

Details zum Api-Vorgangsaktualisierungsvertrag.

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"

OperationUpdateContract

Details zum Api-Vorgangsaktualisierungsvertrag.

Name Typ Beschreibung
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}

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.