Documentation - Create Or Update

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Tworzy nową dokumentację lub aktualizuje istniejącą.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}?api-version=2024-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
documentationId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identyfikator dokumentacji. 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.
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	Typ	Opis
properties.content	string	Zawartość dokumentacji języka Markdown.
properties.title	string	tytuł dokumentacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DocumentationContract	Dokumentacja została pomyślnie zaktualizowana. Nagłówki ETag: string
201 Created	DocumentationContract	Dokumentacja 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

ApiManagementCreateDocumentation

Przykładowe żądanie

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a?api-version=2024-05-01

{
  "properties": {
    "title": "Title",
    "content": "content"
  }
}

Przykładowa odpowiedź

Kod stanu:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/documentations",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "title": "Title",
    "content": "content"
  }
}

Kod stanu:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/documentations",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "title": "Title",
    "content": "content"
  }
}

Definicje

Nazwa	Opis
DocumentationContract	Szczegóły dokumentacji języka Markdown.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

DocumentationContract

Objekt

Szczegóły dokumentacji języka Markdown.

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.content	string	Zawartość dokumentacji języka Markdown.
properties.title	string	tytuł dokumentacji.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

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.