Share via

Api Operation - Create Or Update

  • Riferimento
Service:
API Management
API Version:
2022-08-01

Crea una nuova operazione nell'API o aggiorna una esistente.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
apiId
 path True

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso in cui n è il numero di revisione.

Regex pattern: ^[^*#&+:<>?]+$
operationId
 path True

string

Identificatore di operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName
 path True

string

Nome del servizio Gestione API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
If-Match

string

ETag dell'entità. Non richiesto durante la creazione di un'entità, ma necessario quando si aggiorna un'entità.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.displayName True

string

Nome operazione.
properties.method True

string

Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi.
properties.urlTemplate True

string

Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: /customers/{cid}/orders/{oid}/?date={date}
properties.description

string

Descrizione dell'operazione. Può includere tag di formattazione HTML.
properties.policies

string

Criteri di operazione
properties.request

RequestContract

Entità contenente i dettagli della richiesta.
properties.responses

ResponseContract[]

Matrice di risposte all'operazione.
properties.templateParameters

ParameterContract[]

Raccolta di parametri del modello URL.

Risposte

Nome Tipo Descrizione
200 OK

OperationContract

Operazione aggiornata correttamente.

Headers

ETag: string
201 Created

OperationContract

Operazione creata correttamente.

Headers

ETag: string
Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementCreateApiOperation

Sample Request

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

Sample Response

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

Definizioni

Nome Descrizione
ErrorFieldContract

Contratto campo errore.
ErrorResponse

Risposta errore.
OperationContract

Dettagli dell'operazione API.
ParameterContract

Dettagli dei parametri dell'operazione.
ParameterExampleContract

Esempio di parametro.
RepresentationContract

Dettagli sulla rappresentazione della richiesta/risposta dell'operazione.
RequestContract

Dettagli della richiesta di operazione.
ResponseContract

Dettagli sulla risposta dell'operazione.

ErrorFieldContract

Contratto campo errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.
message

string

Rappresentazione leggibile dell'errore a livello di proprietà.
target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message

string

Rappresentazione leggibile dell'errore.

OperationContract

Dettagli dell'operazione API.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

nome della risorsa.
properties.description

string

Descrizione dell'operazione. Può includere tag di formattazione HTML.
properties.displayName

string

Nome operazione.
properties.method

string

Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi.
properties.policies

string

Criteri di operazione
properties.request

RequestContract

Entità contenente i dettagli della richiesta.
properties.responses

ResponseContract[]

Matrice di risposte all'operazione.
properties.templateParameters

ParameterContract[]

Raccolta di parametri del modello URL.
properties.urlTemplate

string

Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: /customers/{cid}/orders/{oid}/?date={date}
type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ParameterContract

Dettagli dei parametri dell'operazione.

Nome Tipo Descrizione
defaultValue

string

Valore predefinito del parametro.
description

string

Descrizione del parametro.
examples

<string,  ParameterExampleContract>

Esempio definito per il parametro.
name

string

Nome del parametro.
required

boolean

Indica se il parametro è obbligatorio o no.
schemaId

string

Identificatore dello schema.
type

string

Tipo di parametro.
typeName

string

Nome del tipo definito dallo schema.
values

string[]

Valori del parametro.

ParameterExampleContract

Esempio di parametro.

Nome Tipo Descrizione
description

string

Descrizione prolungata per l'esempio
externalValue

string

URL che punta all'esempio letterale
summary

string

Breve descrizione per l'esempio
value

Valore di esempio. Può essere un valore primitivo o un oggetto.

RepresentationContract

Dettagli sulla rappresentazione della richiesta/risposta dell'operazione.

Nome Tipo Descrizione
contentType

string

Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio applicazione/xml.
examples

<string,  ParameterExampleContract>

Esempio definito per la rappresentazione.
formParameters

ParameterContract[]

Raccolta di parametri di modulo. Obbligatorio se il valore 'contentType' è 'application/x-www-form-urlencoded' o 'multipart/form-data'.
schemaId

string

Identificatore dello schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' o 'multipart/form-data'.
typeName

string

Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' o 'multipart/form-data'.

RequestContract

Dettagli della richiesta di operazione.

Nome Tipo Descrizione
description

string

Descrizione della richiesta dell'operazione.
headers

ParameterContract[]

Raccolta di intestazioni per la richiesta di operazione.
queryParameters

ParameterContract[]

Raccolta di parametri di query per la richiesta di operazione.
representations

RepresentationContract[]

Raccolta di rappresentazioni della richiesta dell'operazione.

ResponseContract

Dettagli sulla risposta dell'operazione.

Nome Tipo Descrizione
description

string

Descrizione della risposta dell'operazione.
headers

ParameterContract[]

Raccolta di intestazioni di risposta dell'operazione.
representations

RepresentationContract[]

Raccolta di rappresentazioni della risposta dell'operazione.
statusCode

integer

Codice di stato HTTP della risposta all'operazione.