Content Type - Create Or Update

リファレンス

Service:: API Management

API Version:: 2022-08-01

開発者ポータルのコンテンツタイプを作成または更新します。コンテンツタイプは、コンテンツアイテムのプロパティ、検証ルール、制約を記述します。カスタムコンテンツタイプの識別子はプレフィックスで c- 始まる必要があります。組み込みのコンテンツタイプは変更できません。

PUT 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 Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	エンティティの ETag。エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

名前	型	説明
properties.description	string	コンテンツタイプの説明。
properties.id	string	コンテンツタイプ識別子
properties.name	string	コンテンツタイプ名。長さは 1 ~ 250 文字にする必要があります。
properties.schema	object	コンテンツタイプスキーマ。
properties.version	string	コンテンツタイプのバージョン。

応答

名前	型	説明
200 OK	ContentTypeContract	既存のコンテンツタイプが正常に更新されました。 Headers ETag: string
201 Created	ContentTypeContract	コンテンツタイプが正常に作成されました。 Headers ETag: string
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ContentTypeContract

既存のコンテンツタイプが正常に更新されました。

Headers

ETag: string

201 Created

ContentTypeContract

コンテンツタイプが正常に作成されました。

Headers

ETag: string

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	ユーザーアカウントの借用

例

ApiManagementCreateContentType

Sample Request

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

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

import com.azure.core.management.serializer.SerializerFactory;
import com.azure.core.util.serializer.SerializerEncoding;
import java.io.IOException;

/** Samples for ContentType CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateContentType.json
     */
    /**
     * Sample code: ApiManagementCreateContentType.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateContentType(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) throws IOException {
        manager
            .contentTypes()
            .define("page")
            .withExistingService("rg1", "apimService1")
            .withNamePropertiesName("Page")
            .withDescription("A regular page")
            .withSchema(
                SerializerFactory
                    .createDefaultManagementSerializerAdapter()
                    .deserialize(
                        "{\"additionalProperties\":false,\"properties\":{\"en_us\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Page"
                            + " description. This property gets included in SEO"
                            + " attributes.\",\"indexed\":true,\"title\":\"Description\"},\"documentId\":{\"type\":\"string\",\"description\":\"Reference"
                            + " to page content document.\",\"title\":\"Document"
                            + " ID\"},\"keywords\":{\"type\":\"string\",\"description\":\"Page keywords. This property"
                            + " gets included in SEO"
                            + " attributes.\",\"indexed\":true,\"title\":\"Keywords\"},\"permalink\":{\"type\":\"string\",\"description\":\"Page"
                            + " permalink, e.g."
                            + " '/about'.\",\"indexed\":true,\"title\":\"Permalink\"},\"title\":{\"type\":\"string\",\"description\":\"Page"
                            + " title. This property gets included in SEO"
                            + " attributes.\",\"indexed\":true,\"title\":\"Title\"}},\"required\":[\"title\",\"permalink\",\"documentId\"]}}}",
                        Object.class,
                        SerializerEncoding.JSON))
            .withVersion("1.0.0")
            .create();
    }
}

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

from typing import Any, IO, Union

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_content_type.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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        content_type_id="page",
        parameters={
            "properties": {
                "description": "A regular page",
                "name": "Page",
                "schema": {
                    "additionalProperties": False,
                    "properties": {
                        "en_us": {
                            "additionalProperties": False,
                            "properties": {
                                "description": {
                                    "description": "Page description. This property gets included in SEO attributes.",
                                    "indexed": True,
                                    "title": "Description",
                                    "type": "string",
                                },
                                "documentId": {
                                    "description": "Reference to page content document.",
                                    "title": "Document ID",
                                    "type": "string",
                                },
                                "keywords": {
                                    "description": "Page keywords. This property gets included in SEO attributes.",
                                    "indexed": True,
                                    "title": "Keywords",
                                    "type": "string",
                                },
                                "permalink": {
                                    "description": "Page permalink, e.g. '/about'.",
                                    "indexed": True,
                                    "title": "Permalink",
                                    "type": "string",
                                },
                                "title": {
                                    "description": "Page title. This property gets included in SEO attributes.",
                                    "indexed": True,
                                    "title": "Title",
                                    "type": "string",
                                },
                            },
                            "required": ["title", "permalink", "documentId"],
                            "type": "object",
                        }
                    },
                },
                "version": "1.0.0",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateContentType.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/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/ApiManagementCreateContentType.json
func ExampleContentTypeClient_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.NewContentTypeClient().CreateOrUpdate(ctx, "rg1", "apimService1", "page", armapimanagement.ContentTypeContract{
		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"),
		},
	}, &armapimanagement.ContentTypeClientCreateOrUpdateOptions{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.ContentTypeContract = 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

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

/**
 * This sample demonstrates how to Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.
 *
 * @summary Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateContentType.json
 */
async function apiManagementCreateContentType() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const contentTypeId = "page";
  const parameters = {
    namePropertiesName: "Page",
    schema: {
      additionalProperties: false,
      properties: {
        en_us: {
          type: "object",
          additionalProperties: false,
          properties: {
            description: {
              type: "string",
              description: "Page description. This property gets included in SEO attributes.",
              indexed: true,
              title: "Description",
            },
            documentId: {
              type: "string",
              description: "Reference to page content document.",
              title: "Document ID",
            },
            keywords: {
              type: "string",
              description: "Page keywords. This property gets included in SEO attributes.",
              indexed: true,
              title: "Keywords",
            },
            permalink: {
              type: "string",
              description: "Page permalink, e.g. '/about'.",
              indexed: true,
              title: "Permalink",
            },
            title: {
              type: "string",
              description: "Page title. This property gets included in SEO attributes.",
              indexed: true,
              title: "Title",
            },
          },
          required: ["title", "permalink", "documentId"],
        },
      },
    },
    description: "A regular page",
    version: "1.0.0",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.contentType.createOrUpdate(
    resourceGroupName,
    serviceName,
    contentTypeId,
    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

Sample Response

Status code:: 200

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

Status code:: 201

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

定義

名前	説明
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	人が判読できるエラーの表現。

Share via

Content Type - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

Scopes

例

ApiManagementCreateContentType

Sample Request

Sample Response

定義

ContentTypeContract

ErrorFieldContract

ErrorResponse

その他のリソース