Content Type - List By Service

Service:

API Management

API Version:

2022-08-01

Geliştirici portalının içerik türlerini listeler. İçerik türleri içerik öğelerinin özelliklerini, doğrulama kurallarını ve kısıtlamalarını açıklar.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	ContentTypeCollection	İçerik Türü varlıklarından oluşan bir koleksiyon döndürür.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementListContentTypes

Sample Request

HTTP

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

Java

/** Samples for ContentType ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListContentTypes.json
     */
    /**
     * Sample code: ApiManagementListContentTypes.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListContentTypes(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.contentTypes().listByService("rg1", "apimService1", 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

Python

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_content_types.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.content_type.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListContentTypes.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

Go

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/ApiManagementListContentTypes.json
func ExampleContentTypeClient_NewListByServicePager() {
	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.NewContentTypeClient().NewListByServicePager("rg1", "apimService1", 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.ContentTypeCollection = armapimanagement.ContentTypeCollection{
		// 	Value: []*armapimanagement.ContentTypeContract{
		// 		{
		// 			Name: to.Ptr("page"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/contentTypes"),
		// 			ID: to.Ptr("/contentTypes/page"),
		// 			Properties: &armapimanagement.ContentTypeContractProperties{
		// 				Name: to.Ptr("Page"),
		// 				Schema: map[string]any{
		// 					"additionalProperties": false,
		// 					"properties":map[string]any{
		// 						"en_us":map[string]any{
		// 							"type": "object",
		// 							"additionalProperties": false,
		// 							"properties":map[string]any{
		// 								"description":map[string]any{
		// 									"type": "string",
		// 									"description": "Page description. This property gets included in SEO attributes.",
		// 									"indexed": true,
		// 									"title": "Description",
		// 								},
		// 								"documentId":map[string]any{
		// 									"type": "string",
		// 									"description": "Reference to page content document.",
		// 									"title": "Document ID",
		// 								},
		// 								"keywords":map[string]any{
		// 									"type": "string",
		// 									"description": "Page keywords. This property gets included in SEO attributes.",
		// 									"indexed": true,
		// 									"title": "Keywords",
		// 								},
		// 								"permalink":map[string]any{
		// 									"type": "string",
		// 									"description": "Page permalink, e.g. '/about'.",
		// 									"indexed": true,
		// 									"title": "Permalink",
		// 								},
		// 								"title":map[string]any{
		// 									"type": "string",
		// 									"description": "Page title. This property gets included in SEO attributes.",
		// 									"indexed": true,
		// 									"title": "Title",
		// 								},
		// 							},
		// 							"required":[]any{
		// 								"title",
		// 								"permalink",
		// 								"documentId",
		// 							},
		// 						},
		// 					},
		// 				},
		// 				Description: to.Ptr("A regular page"),
		// 				Version: to.Ptr("1.0.0"),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.
 *
 * @summary Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListContentTypes.json
 */
async function apiManagementListContentTypes() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.contentType.listByService(resourceGroupName, serviceName)) {
    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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/contentTypes/page",
      "type": "Microsoft.ApiManagement/service/contentTypes",
      "name": "page",
      "properties": {
        "name": "Page",
        "description": "A regular page",
        "schema": {
          "properties": {
            "en_us": {
              "type": "object",
              "properties": {
                "title": {
                  "title": "Title",
                  "description": "Page title. This property gets included in SEO attributes.",
                  "type": "string",
                  "indexed": true
                },
                "description": {
                  "title": "Description",
                  "description": "Page description. This property gets included in SEO attributes.",
                  "type": "string",
                  "indexed": true
                },
                "keywords": {
                  "title": "Keywords",
                  "description": "Page keywords. This property gets included in SEO attributes.",
                  "type": "string",
                  "indexed": true
                },
                "permalink": {
                  "title": "Permalink",
                  "description": "Page permalink, e.g. '/about'.",
                  "type": "string",
                  "indexed": true
                },
                "documentId": {
                  "title": "Document ID",
                  "description": "Reference to page content document.",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "title",
                "permalink",
                "documentId"
              ]
            }
          },
          "additionalProperties": false
        },
        "version": "1.0.0"
      }
    }
  ]
}

Tanımlar

Name	Description
ContentTypeCollection	İçerik türlerinin sayfalanmış listesi.
ContentTypeContract	İçerik türü sözleşme ayrıntıları.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.

ContentTypeCollection

İçerik türlerinin sayfalanmış listesi.

Name	Tür	Description
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	ContentTypeContract[]	İçerik türleri koleksiyonu.

ContentTypeContract

İçerik türü sözleşme ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.description	string	İçerik türü açıklaması.
properties.id	string	İçerik türü tanımlayıcısı
properties.name	string	İçerik türü adı. 1 ile 250 karakter uzunluğunda olmalıdır.
properties.schema	object	İçerik türü şeması.
properties.version	string	İçerik türü sürümü.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilir gösterimi.