Api Wiki - Update

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Aktualizuje szczegóły witryny typu wiki dla interfejsu API określonego przez jego identyfikator.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default?api-version=2024-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiId	path	True	string minLength: 1 maxLength: 80	Identyfikator interfejsu 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.
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	True	string	Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

Treść żądania

Nazwa	Typ	Opis
properties.documents	WikiDocumentationContract[]	Zbieranie dokumentów typu wiki zawartych w tej witrynie typu wiki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WikiContract	Witryna typu wiki została pomyślnie zaktualizowana. 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

ApiManagementUpdateApiWiki

Przykładowe żądanie

HTTP

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


{
  "properties": {
    "documents": [
      {
        "documentationId": "docId1"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default",
  "type": "Microsoft.ApiManagement/service/apis/wikis",
  "name": "default",
  "properties": {
    "documents": [
      {
        "documentationId": "docId1"
      }
    ]
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
WikiContract	Właściwości witryny typu wiki
WikiDocumentationContract	Szczegóły dokumentacji witryny typu wiki.
WikiUpdateContract	Szczegóły kontraktu aktualizacji witryny typu wiki.

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.

WikiContract

Objekt

Właściwości witryny typu wiki

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.documents	WikiDocumentationContract[]	Zbieranie dokumentów typu wiki zawartych w tej witrynie typu wiki.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

WikiDocumentationContract

Objekt

Szczegóły dokumentacji witryny typu wiki.

Nazwa	Typ	Opis
documentationId	string	Identyfikator dokumentacji

WikiUpdateContract

Objekt

Szczegóły kontraktu aktualizacji witryny typu wiki.

Nazwa	Typ	Opis
properties.documents	WikiDocumentationContract[]	Zbieranie dokumentów typu wiki zawartych w tej witrynie typu wiki.