Content Type - Create Or Update

Servicio:

API Management

Versión de la API:

2024-05-01

Crea o actualiza el tipo de contenido del portal para desarrolladores. Los tipos de contenido describen las propiedades, las reglas de validación y las restricciones de los elementos de contenido. Los identificadores de los tipos de contenido personalizados deben comenzar con el prefijo c-. Los tipos de contenido integrados no se pueden modificar.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
contentTypeId	path	True	string minLength: 1 maxLength: 80	Identificador de tipo de contenido.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match		string	ETag de la entidad. No es necesario al crear una entidad, pero es necesaria al actualizar una entidad.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.description	string	Descripción del tipo de contenido.
properties.id	string	Identificador de tipo de contenido
properties.name	string	Nombre del tipo de contenido. Debe tener entre 1 y 250 caracteres.
properties.schema	object	Esquema de tipo de contenido.
properties.version	string	Versión del tipo de contenido.

Respuestas

Nombre	Tipo	Description
200 OK	ContentTypeContract	El tipo de contenido existente se actualizó correctamente. Encabezados ETag: string
201 Created	ContentTypeContract	El tipo de contenido se creó correctamente. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementCreateContentType

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page?api-version=2024-05-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"
  }
}

Java

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/2024-05-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

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_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="00000000-0000-0000-0000-000000000000",
    )

    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/2024-05-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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-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

JavaScript

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

/**
 * 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/2024-05-01/examples/ApiManagementCreateContentType.json
 */
async function apiManagementCreateContentType() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateContentType.json
// this example is just showing the usage of "ContentType_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
string contentTypeId = "page";
ApiManagementContentType result = await apiManagementService.CreateOrUpdateContentTypeAsync(contentTypeId);

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ContentTypeContract	Detalles del contrato de tipo de contenido.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

ContentTypeContract

Object

Detalles del contrato de tipo de contenido.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.description	string	Descripción del tipo de contenido.
properties.id	string	Identificador de tipo de contenido
properties.name	string	Nombre del tipo de contenido. Debe tener entre 1 y 250 caracteres.
properties.schema	object	Esquema de tipo de contenido.
properties.version	string	Versión del tipo de contenido.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.