Api Wiki - Create Or Update
Létrehoz egy új wikit egy API-hoz, vagy frissít egy meglévőt.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default?api-version=2024-05-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
api
|
path | True |
string minLength: 1maxLength: 80 |
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Az API Management szolgáltatás neve. |
subscription
|
path | True |
string (uuid) |
A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie. |
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
If-Match |
string |
Az entitás ETagje. Entitás létrehozásakor nem kötelező, de egy entitás frissítésekor kötelező. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
properties.documents |
A wikibe foglalt wikidokumentumok gyűjteménye. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A Wiki frissítése sikeresen megtörtént. Fejlécek ETag: string |
|
201 Created |
A wiki létrehozása sikeresen megtörtént. Fejlécek ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy miért nem sikerült a művelet. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
ApiManagementCreateApiWiki
Mintakérelem
PUT 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"
},
{
"documentationId": "docId2"
}
]
}
}
Mintaválasz
{
"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"
},
{
"documentationId": "docId2"
}
]
}
}
{
"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"
},
{
"documentationId": "docId2"
}
]
}
}
Definíciók
Name | Description |
---|---|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Wiki |
Wikitulajdonságok |
Wiki |
Wikidokumentáció részletei. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
WikiContract
Wikitulajdonságok
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.documents |
A wikibe foglalt wikidokumentumok gyűjteménye. |
|
type |
string |
Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
WikiDocumentationContract
Wikidokumentáció részletei.
Name | Típus | Description |
---|---|---|
documentationId |
string |
Dokumentáció azonosítója |