Workspace Api Operation - Create Or Update

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

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

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
operationId	path	True	string minLength: 1 maxLength: 80	Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.displayName	True	string minLength: 1 maxLength: 300	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 minLength: 1 maxLength: 1000	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 maxLength: 1000	Descrizione dell'operazione. Può includere tag di formattazione HTML.
properties.policies		string	Criteri operativi
properties.request		RequestContract	Entità contenente i dettagli della richiesta.
properties.responses		ResponseContract[]	Matrice di risposte dell'operazione.
properties.templateParameters		ParameterContract[]	Raccolta di parametri del modello url.

Risposte

Nome	Tipo	Descrizione
200 OK	OperationContract	L'operazione è stata aggiornata correttamente. Intestazioni ETag: string
201 Created	OperationContract	L'operazione è stata creata correttamente. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

OperationContract

L'operazione è stata aggiornata correttamente.

Intestazioni

ETag: string

201 Created

OperationContract

L'operazione è stata creata correttamente.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateWorkspaceApiOperation

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations?api-version=2024-05-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": []
      }
    ]
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations",
  "type": "Microsoft.ApiManagement/service/workspaces/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": []
      }
    ]
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations",
  "type": "Microsoft.ApiManagement/service/workspaces/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
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
OperationContract	Dettagli dell'operazione API.
ParameterContract	Dettagli dei parametri dell'operazione.
ParameterExampleContract	Esempio di parametro.
RepresentationContract	Dettagli della rappresentazione della richiesta/risposta dell'operazione.
RequestContract	Dettagli della richiesta dell'operazione.
ResponseContract	Dettagli della risposta dell'operazione.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

OperationContract

Object

Dettagli dell'operazione API.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.description	string maxLength: 1000	Descrizione dell'operazione. Può includere tag di formattazione HTML.
properties.displayName	string minLength: 1 maxLength: 300	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 operativi
properties.request	RequestContract	Entità contenente i dettagli della richiesta.
properties.responses	ResponseContract[]	Matrice di risposte dell'operazione.
properties.templateParameters	ParameterContract[]	Raccolta di parametri del modello url.
properties.urlTemplate	string minLength: 1 maxLength: 1000	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 della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ParameterContract

Object

Dettagli dei parametri dell'operazione.

Nome	Tipo	Descrizione
defaultValue	string	Valore del parametro predefinito.
description	string	Descrizione del parametro.
examples	<string, ParameterExampleContract>	Esempio definito per il parametro .
name	string	Nome parametro.
required	boolean	Specifica se il parametro è obbligatorio o meno.
schemaId	string	Identificatore dello schema.
type	string	Tipo di parametro.
typeName	string	Nome del tipo definito dallo schema.
values	string[]	Valori dei parametri.

ParameterExampleContract

Object

Esempio di parametro.

Nome	Tipo	Descrizione
description	string	Descrizione lunga 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

Object

Dettagli della rappresentazione della richiesta/risposta dell'operazione.

Nome	Tipo	Descrizione
contentType	string	Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio application/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' né 'multipart/form-data'.
typeName	string	Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'.

RequestContract

Object

Dettagli della richiesta dell'operazione.

Nome	Tipo	Descrizione
description	string	Descrizione della richiesta di operazione.
headers	ParameterContract[]	Raccolta di intestazioni della richiesta di operazione.
queryParameters	ParameterContract[]	Raccolta di parametri di query della richiesta di operazione.
representations	RepresentationContract[]	Raccolta di rappresentazioni delle richieste di operazione.

ResponseContract

Object

Dettagli della 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 di risposta dell'operazione.
statusCode	integer (int32)	Codice di stato HTTP della risposta all'operazione.

Condividi tramite

Workspace Api Operation - Create Or Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreateWorkspaceApiOperation

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OperationContract

ParameterContract

ParameterExampleContract

RepresentationContract

RequestContract

ResponseContract

Risorse aggiuntive