Microsoft.ApiManagement service/apis/schemas 2019-01-01

Template format

To create a Microsoft.ApiManagement/service/apis/schemas resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.ApiManagement/service/apis/schemas",
  "apiVersion": "2019-01-01",
  "properties": {
    "contentType": "string",
    "document": {
      "value": "string"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/apis/schemas object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Schema identifier within an API. Must be unique in the current API Management service instance.
type enum Yes For JSON -schemas

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2019-01-01
properties object Yes Properties of the Schema. - SchemaCreateOrUpdateProperties object

SchemaCreateOrUpdateProperties object

Name Type Required Value
contentType string Yes Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- Swagger Schema use application/
- WSDL Schema use application/
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/
document object No Create or update Properties of the Schema Document. - SchemaDocumentProperties object

SchemaDocumentProperties object

Name Type Required Value
value string No Json escaped string defining the document representing the Schema.