Share via

Microsoft.ApiManagement service/schemas 2024-05-01

  • Article

Bicep resource definition

The service/schemas 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.ApiManagement/service/schemas resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/schemas@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    document: any(Azure.Bicep.Types.Concrete.AnyType)
    schemaType: 'string'
    value: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

Property values

GlobalSchemaContractProperties

Name Description Value
description Free-form schema entity description. string
document Global Schema document object for json-based schema formats(e.g. json schema). any
schemaType Schema Type. Immutable. 'json'
'xml' (required)
value Json-encoded string for non json-based schema. any

Microsoft.ApiManagement/service/schemas

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: service
properties Properties of the Global Schema. GlobalSchemaContractProperties

ARM template resource definition

The service/schemas 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.ApiManagement/service/schemas resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/schemas",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "description": "string",
    "document": {},
    "schemaType": "string",
    "value": {}
  }
}

Property values

GlobalSchemaContractProperties

Name Description Value
description Free-form schema entity description. string
document Global Schema document object for json-based schema formats(e.g. json schema). any
schemaType Schema Type. Immutable. 'json'
'xml' (required)
value Json-encoded string for non json-based schema. any

Microsoft.ApiManagement/service/schemas

Name Description Value
apiVersion The api version '2024-05-01'
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
properties Properties of the Global Schema. GlobalSchemaContractProperties
type The resource type 'Microsoft.ApiManagement/service/schemas'

Terraform (AzAPI provider) resource definition

The service/schemas resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

To create a Microsoft.ApiManagement/service/schemas resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/schemas@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      document = ?
      schemaType = "string"
      value = ?
    }
  })
}

Property values

GlobalSchemaContractProperties

Name Description Value
description Free-form schema entity description. string
document Global Schema document object for json-based schema formats(e.g. json schema). any
schemaType Schema Type. Immutable. 'json'
'xml' (required)
value Json-encoded string for non json-based schema. any

Microsoft.ApiManagement/service/schemas

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Properties of the Global Schema. GlobalSchemaContractProperties
type The resource type "Microsoft.ApiManagement/service/schemas@2024-05-01"