Api Wiki - Create Or Update

Referencia

Szolgáltatás:: API Management

API-verzió:: 2024-05-01

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
apiId	path	True	string minLength: 1 maxLength: 80	API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	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	WikiDocumentationContract[]	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"
      }
    ]
  }
}


import com.azure.resourcemanager.apimanagement.fluent.models.WikiContractInner;
import com.azure.resourcemanager.apimanagement.models.WikiDocumentationContract;
import java.util.Arrays;

/**
 * Samples for ApiWiki CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementCreateApiWiki.json
     */
    /**
     * Sample code: ApiManagementCreateApiWiki.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementCreateApiWiki(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiWikis().createOrUpdateWithResponse("rg1", "apimService1", "57d1f7558aa04f15146d9d8a",
            new WikiContractInner()
                .withDocuments(Arrays.asList(new WikiDocumentationContract().withDocumentationId("docId1"),
                    new WikiDocumentationContract().withDocumentationId("docId2"))),
            null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_api_wiki.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_wiki.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="57d1f7558aa04f15146d9d8a",
        parameters={"properties": {"documents": [{"documentationId": "docId1"}, {"documentationId": "docId2"}]}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiWiki.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiWiki.json
func ExampleAPIWikiClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPIWikiClient().CreateOrUpdate(ctx, "rg1", "apimService1", "57d1f7558aa04f15146d9d8a", armapimanagement.WikiContract{
		Properties: &armapimanagement.WikiContractProperties{
			Documents: []*armapimanagement.WikiDocumentationContract{
				{
					DocumentationID: to.Ptr("docId1"),
				},
				{
					DocumentationID: to.Ptr("docId2"),
				}},
		},
	}, &armapimanagement.APIWikiClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WikiContract = armapimanagement.WikiContract{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis/wikis"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis/default"),
	// 	Properties: &armapimanagement.WikiContractProperties{
	// 		Documents: []*armapimanagement.WikiDocumentationContract{
	// 			{
	// 				DocumentationID: to.Ptr("docId1"),
	// 			},
	// 			{
	// 				DocumentationID: to.Ptr("docId2"),
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates a new Wiki for an API or updates an existing one.
 *
 * @summary Creates a new Wiki for an API or updates an existing one.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiWiki.json
 */
async function apiManagementCreateApiWiki() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "57d1f7558aa04f15146d9d8a";
  const parameters = {
    documents: [{ documentationId: "docId1" }, { documentationId: "docId2" }],
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiWiki.createOrUpdate(
    resourceGroupName,
    serviceName,
    apiId,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiWiki.json
// this example is just showing the usage of "ApiWiki_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceApiWikiResource created on azure
// for more information of creating ServiceApiWikiResource, please refer to the document of ServiceApiWikiResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "57d1f7558aa04f15146d9d8a";
ResourceIdentifier serviceApiWikiResourceId = ServiceApiWikiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
ServiceApiWikiResource serviceApiWiki = client.GetServiceApiWikiResource(serviceApiWikiResourceId);

// invoke the operation
WikiContractData data = new WikiContractData
{
    Documents = {new WikiDocumentationContract
    {
    DocumentationId = "docId1",
    }, new WikiDocumentationContract
    {
    DocumentationId = "docId2",
    }},
};
ArmOperation<ServiceApiWikiResource> lro = await serviceApiWiki.CreateOrUpdateAsync(WaitUntil.Completed, data);
ServiceApiWikiResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WikiContractData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 201

{
  "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"
      }
    ]
  }
}

Állapotkód:: 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"
      },
      {
        "documentationId": "docId2"
      }
    ]
  }
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
WikiContract	Wikitulajdonságok
WikiDocumentationContract	Wikidokumentáció részletei.

ErrorAdditionalInfo

Objektum

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

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

WikiContract

Objektum

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	WikiDocumentationContract[]	A wikibe foglalt wikidokumentumok gyűjteménye.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

WikiDocumentationContract

Objektum

Wikidokumentáció részletei.

Name	Típus	Description
documentationId	string	Dokumentáció azonosítója