Share via

Microsoft.ApiManagement service/schemas 2023-09-01-preview

  • 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@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    document: any()
    schemaType: 'string'
    value: any()
  }
}

Property values

service/schemas

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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

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). For Bicep, you can use the any() function.
schemaType Schema Type. Immutable. 'json'
'xml' (required)
value Json-encoded string for non json-based schema. For Bicep, you can use the any() function.

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": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "document": {},
    "schemaType": "string",
    "value": {}
  }
}

Property values

service/schemas

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/schemas'
apiVersion The resource api version '2023-09-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties of the Global Schema. GlobalSchemaContractProperties

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).
schemaType Schema Type. Immutable. 'json'
'xml' (required)
value Json-encoded string for non json-based schema.

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@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      schemaType = "string"
    }
  })
}

Property values

service/schemas

Name Description Value
type The resource type "Microsoft.ApiManagement/service/schemas@2023-09-01-preview"
name The resource name string (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

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).
schemaType Schema Type. Immutable. "json"
"xml" (required)
value Json-encoded string for non json-based schema.