你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Content Type - List By Service

Service:

API Management

API Version:

2022-08-01

列出开发人员门户的内容类型。 内容类型描述内容项的属性、验证规则和约束。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。 此名称不区分大小写。
serviceName	path	True	string	API 管理服务的名称。 Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	ContentTypeCollection	返回内容类型实体的集合。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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

定义

名称	说明
ContentTypeCollection	内容类型的分页列表。
ContentTypeContract	内容类型协定详细信息。
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。

ContentTypeCollection

内容类型的分页列表。

名称	类型	说明
nextLink	string	下一页链接（如果有）。
value	ContentTypeContract[]	内容类型的集合。

ContentTypeContract

内容类型协定详细信息。

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.description	string	内容类型说明。
properties.id	string	内容类型标识符
properties.name	string	内容类型名称。 长度必须为 1 到 250 个字符。
properties.schema	object	内容类型架构。
properties.version	string	内容类型版本。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ErrorFieldContract

错误字段协定。

名称	类型	说明
code	string	属性级错误代码。
message	string	属性级错误的可读表示形式。
target	string	属性名称。

ErrorResponse

错误响应。

名称	类型	说明
error.code	string	服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。
error.details	ErrorFieldContract[]	在发生验证错误时，请求中发送的无效字段列表。
error.message	string	错误的用户可读表示形式。