Workspace Api Operation - Create Or Update

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Tworzy nową operację w interfejsie API lub aktualizuje istniejącą operację.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
operationId	path	True	string minLength: 1 maxLength: 80	Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match		string	Element ETag jednostki. Nie jest to wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.displayName	True	string minLength: 1 maxLength: 300	Nazwa operacji.
properties.method	True	string	Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie.
properties.urlTemplate	True	string minLength: 1 maxLength: 1000	Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date}
properties.description		string maxLength: 1000	Opis operacji. Może zawierać tagi formatowania HTML.
properties.policies		string	Zasady operacji
properties.request		RequestContract	Jednostka zawierająca szczegóły żądania.
properties.responses		ResponseContract[]	Tablica odpowiedzi operacji.
properties.templateParameters		ParameterContract[]	Kolekcja parametrów szablonu adresu URL.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OperationContract	Operacja została pomyślnie zaktualizowana. Nagłówki ETag: string
201 Created	OperationContract	Operacja została pomyślnie utworzona. Nagłówki ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

OperationContract

Operacja została pomyślnie zaktualizowana.

Nagłówki

ETag: string

201 Created

OperationContract

Operacja została pomyślnie utworzona.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementCreateWorkspaceApiOperation

Przykładowe żądanie

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

Przykładowa odpowiedź

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

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
OperationContract	Szczegóły operacji interfejsu API.
ParameterContract	Szczegóły parametrów operacji.
ParameterExampleContract	Przykład parametru.
RepresentationContract	Szczegóły reprezentacji żądania/odpowiedzi operacji.
RequestContract	Szczegóły żądania operacji.
ResponseContract	Szczegóły odpowiedzi operacji.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

OperationContract

Objekt

Szczegóły operacji interfejsu API.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.description	string maxLength: 1000	Opis operacji. Może zawierać tagi formatowania HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nazwa operacji.
properties.method	string	Prawidłowa metoda operacji HTTP. Typowe metody HTTP, takie jak GET, PUT, POST, ale nie tylko przez nie.
properties.policies	string	Zasady operacji
properties.request	RequestContract	Jednostka zawierająca szczegóły żądania.
properties.responses	ResponseContract[]	Tablica odpowiedzi operacji.
properties.templateParameters	ParameterContract[]	Kolekcja parametrów szablonu adresu URL.
properties.urlTemplate	string minLength: 1 maxLength: 1000	Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: /customers/{cid}/orders/{oid}/?date={date}
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ParameterContract

Objekt

Szczegóły parametrów operacji.

Nazwa	Typ	Opis
defaultValue	string	Wartość parametru domyślnego.
description	string	Opis parametru.
examples	<string, ParameterExampleContract>	Na przykład zdefiniowany dla parametru .
name	string	Nazwa parametru.
required	boolean	Określa, czy parametr jest wymagany, czy nie.
schemaId	string	Identyfikator schematu.
type	string	Typ parametru.
typeName	string	Nazwa typu zdefiniowana przez schemat.
values	string[]	Wartości parametrów.

ParameterExampleContract

Objekt

Przykład parametru.

Nazwa	Typ	Opis
description	string	Długi opis przykładu
externalValue	string	Adres URL wskazujący przykład literału
summary	string	Krótki opis przykładu
value		Przykładowa wartość. Może być wartością pierwotną lub obiektem.

RepresentationContract

Objekt

Szczegóły reprezentacji żądania/odpowiedzi operacji.

Nazwa	Typ	Opis
contentType	string	Określa zarejestrowany lub niestandardowy typ zawartości dla tej reprezentacji, np. application/xml.
examples	<string, ParameterExampleContract>	Na przykład zdefiniowano dla reprezentacji.
formParameters	ParameterContract[]	Kolekcja parametrów formularza. Wymagane, jeśli wartość "contentType" to "application/x-www-form-urlencoded" lub "multipart/form-data".
schemaId	string	Identyfikator schematu. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data".
typeName	string	Nazwa typu zdefiniowana przez schemat. Dotyczy tylko wtedy, gdy wartość "contentType" nie jest ani "application/x-www-form-urlencoded" ani "multipart/form-data".

RequestContract

Objekt

Szczegóły żądania operacji.

Nazwa	Typ	Opis
description	string	Opis żądania operacji.
headers	ParameterContract[]	Kolekcja nagłówków żądań operacji.
queryParameters	ParameterContract[]	Kolekcja parametrów zapytania żądania operacji.
representations	RepresentationContract[]	Kolekcja reprezentacji żądań operacji.

ResponseContract

Objekt

Szczegóły odpowiedzi operacji.

Nazwa	Typ	Opis
description	string	Opis odpowiedzi operacji.
headers	ParameterContract[]	Kolekcja nagłówków odpowiedzi operacji.
representations	RepresentationContract[]	Kolekcja reprezentacji odpowiedzi operacji.
statusCode	integer (int32)	Kod stanu HTTP odpowiedzi operacji.

Udostępnij za pośrednictwem

Workspace Api Operation - Create Or Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementCreateWorkspaceApiOperation

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OperationContract

ParameterContract

ParameterExampleContract

RepresentationContract

RequestContract

ResponseContract

Dodatkowe zasoby