Microsoft.ApiCenter services/metadataSchemas

ARM template resource definition

The services/metadataSchemas resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiCenter/services/metadataSchemas resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiCenter/services/metadataSchemas",
  "apiVersion": "2024-03-01",
  "name": "string",
  "properties": {
    "assignedTo": [
      {
        "deprecated": "bool",
        "entity": "string",
        "required": "bool"
      }
    ],
    "schema": "string"
  }
}

Property values

services/metadataSchemas

Name Description Value
type The resource type 'Microsoft.ApiCenter/services/metadataSchemas'
apiVersion The resource api version '2024-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Metadata schema properties. MetadataSchemaProperties

MetadataSchemaProperties

Name Description Value
assignedTo MetadataAssignment[]
schema The schema defining the type. string (required)

MetadataAssignment

Name Description Value
deprecated bool
entity The entities this metadata schema component gets applied to. 'api'
'deployment'
'environment'

required bool