Content Type - Create Or Update

Referenz

Dienst:: API Management

API-Version:: 2022-08-01

Erstellt oder aktualisiert den Inhaltstyp des Entwicklerportals. Inhaltstypen beschreiben die Eigenschaften, Validierungsregeln und Einschränkungen von Inhaltselementen. Bezeichner benutzerdefinierter Inhaltstypen müssen mit dem c- Präfix beginnen. Integrierte Inhaltstypen können nicht geändert werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
contentTypeId	path	True	string	Inhaltstypbezeichner.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name	Typ	Beschreibung
properties.description	string	Inhaltstypbeschreibung.
properties.id	string	Inhaltstypbezeichner
properties.name	string	Name des Inhaltstyps. Muss 1 bis 250 Zeichen lang sein.
properties.schema	object	Inhaltstypschema.
properties.version	string	Inhaltstypversion.

Antworten

Name	Typ	Beschreibung
200 OK	ContentTypeContract	Der vorhandene Inhaltstyp wurde erfolgreich aktualisiert. Header ETag: string
201 Created	ContentTypeContract	Der Inhaltstyp wurde erfolgreich erstellt. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Name

Typ

Beschreibung

200 OK

ContentTypeContract

Der vorhandene Inhaltstyp wurde erfolgreich aktualisiert.

Header

ETag: string

201 Created

ContentTypeContract

Der Inhaltstyp wurde erfolgreich erstellt.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementCreateContentType

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
ContentTypeContract	Inhaltstypvertragsdetails.
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.

ContentTypeContract

Inhaltstypvertragsdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.description	string	Inhaltstypbeschreibung.
properties.id	string	Inhaltstypbezeichner
properties.name	string	Name des Inhaltstyps. Muss 1 bis 250 Zeichen lang sein.
properties.schema	object	Inhaltstypschema.
properties.version	string	Inhaltstypversion.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

Freigeben über

Content Type - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementCreateContentType

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ContentTypeContract

ErrorFieldContract

ErrorResponse

Zusätzliche Ressourcen