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

Content Type - Get

获取开发人员门户的内容类型的详细信息。 内容类型描述内容项的属性、验证规则和约束。

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

URI 参数

名称 必需 类型 说明
contentTypeId
path True

string

内容类型标识符。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

ContentTypeContract

返回指定内容类型的详细信息。

标头

ETag: string

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementGetContentType

示例请求

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

示例响应

{
  "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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"
  }
}

定义

名称 说明
ContentTypeContract

内容类型协定详细信息。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

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

错误的用户可读表示形式。