Api Wikis - List

Referenz

Dienst:: API Management

API-Version:: 2022-08-01

Ruft die Wikis für eine API ab, die durch ihren Bezeichner angegeben wird.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis?api-version=2022-08-01

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiId	path	True	string	API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$filter	query		string	\| Feld \| Nutzung \| Unterstützte Operatoren \| Unterstützte Funktionen \| \|-------------\|-------------\|-------------\|-------------\| \| Name \| filtern \| eq \| enthält \|
$skip	query		integer int32	Die Anzahl der zu überspringenden Datensätze.
$top	query		integer int32	Die Anzahl der zurückzugebenden Datensätze.

Antworten

Name	Typ	Beschreibung
200 OK	WikiCollection	Der Antworttext enthält die angegebene Wiki-Entität.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementListApiWikis

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/wikis?api-version=2022-08-01

/** Samples for ApiWikisOperation List. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiWikis.json
     */
    /**
     * Sample code: ApiManagementListApiWikis.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListApiWikis(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiWikisOperations()
            .list(
                "rg1", "apimService1", "57d1f7558aa04f15146d9d8a", null, null, 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_list_api_wikis.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="subid",
    )

    response = client.api_wikis.list(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="57d1f7558aa04f15146d9d8a",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiWikis.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiWikis.json
func ExampleAPIWikisClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewAPIWikisClient().NewListPager("rg1", "apimService1", "57d1f7558aa04f15146d9d8a", &armapimanagement.APIWikisClientListOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WikiCollection = armapimanagement.WikiCollection{
		// 	Value: []*armapimanagement.WikiContract{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/apis/wikis"),
		// 			ID: to.Ptr("/subscriptions/subid/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");

/**
 * This sample demonstrates how to Gets the wikis for an API specified by its identifier.
 *
 * @summary Gets the wikis for an API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiWikis.json
 */
async function apiManagementListApiWikis() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "57d1f7558aa04f15146d9d8a";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiWikis.list(resourceGroupName, serviceName, apiId)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/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"
          }
        ]
      }
    }
  ],
  "nextLink": ""
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
WikiCollection	Ausgelagerte Wiki-Listendarstellung.
WikiContract	Wikieigenschaften
WikiDocumentationContract	Details zur Wiki-Dokumentation.

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

WikiCollection

Ausgelagerte Wiki-Listendarstellung.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite, falls vorhanden.
value	WikiContract[]	Seitenwerte.

WikiContract

Wikieigenschaften

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.documents	WikiDocumentationContract[]	Sammlungswiki-Dokumente, die in diesem Wiki enthalten sind.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WikiDocumentationContract

Details zur Wiki-Dokumentation.

Name	Typ	Beschreibung
documentationId	string	Dokumentationsbezeichner

Freigeben über

Api Wikis - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementListApiWikis

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorFieldContract

ErrorResponse

WikiCollection

WikiContract

WikiDocumentationContract

Zusätzliche Ressourcen