Share via

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

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2019-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    contentType: 'string'
    document: {
      value: 'string'
    }
  }
}

Property Values

Microsoft.ApiManagement/service/apis/schemas

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (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/apis
properties Properties of the Schema. SchemaCreateOrUpdatePropertiesOrSchemaContractProperties

SchemaCreateOrUpdatePropertiesOrSchemaContractProperties

Name Description Value
contentType 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/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (required)
document Create or update Properties of the Schema Document. SchemaDocumentPropertiesOrAnyObject

SchemaDocumentPropertiesOrAnyObject

Name Description Value
value Json escaped string defining the document representing the Schema. string

Usage Examples

Bicep Samples

A basic example of deploying API Schema within an API Management Service.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
  sku: {
    capacity: 0
    name: 'Consumption'
  }
}

resource api 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
  parent: service
  name: '${resourceName};rev=1'
  properties: {
    apiRevisionDescription: ''
    apiType: 'http'
    apiVersion: ''
    apiVersionDescription: ''
    authenticationSettings: {}
    description: ''
    displayName: 'api1'
    path: 'api1'
    protocols: [
      'https'
    ]
    serviceUrl: ''
    subscriptionRequired: true
    type: 'http'
  }
}

resource schema 'Microsoft.ApiManagement/service/apis/schemas@2021-08-01' = {
  parent: api
  name: resourceName
  properties: {
    contentType: 'application/vnd.ms-azure-apim.xsd+xml'
    document: {
      value: '''<!--
 Copyright (c) HashiCorp, Inc.
 SPDX-License-Identifier: MPL-2.0
-->

<s:schema elementFormDefault="qualified" targetNamespace="http://ws.cdyne.com/WeatherWS/" xmlns:tns="http://ws.cdyne.com/WeatherWS/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:apim-wsdltns="http://ws.cdyne.com/WeatherWS/"> <s:element name="GetWeatherInformation"> <s:complexType /> </s:element> <s:element name="GetWeatherInformationResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="GetWeatherInformationResult" type="tns:ArrayOfWeatherDescription" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="ArrayOfWeatherDescription"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="WeatherDescription" type="tns:WeatherDescription" /> </s:sequence> </s:complexType> <s:complexType name="WeatherDescription"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="WeatherID" type="s:short" /> <s:element minOccurs="0" maxOccurs="1" name="Description" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="PictureURL" type="s:string" /> </s:sequence> </s:complexType> <s:element name="GetCityForecastByZIP"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="ZIP" type="s:string" /> </s:sequence> </s:complexType> </s:element> <s:element name="GetCityForecastByZIPResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="GetCityForecastByZIPResult" type="tns:ForecastReturn" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="ForecastReturn"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="Success" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="ResponseText" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="State" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="WeatherStationCity" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="ForecastResult" type="tns:ArrayOfForecast" /> </s:sequence> </s:complexType> <s:complexType name="ArrayOfForecast"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="Forecast" nillable="true" type="tns:Forecast" /> </s:sequence> </s:complexType> <s:complexType name="Forecast"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="Date" type="s:dateTime" /> <s:element minOccurs="1" maxOccurs="1" name="WeatherID" type="s:short" /> <s:element minOccurs="0" maxOccurs="1" name="Desciption" type="s:string" /> <s:element minOccurs="1" maxOccurs="1" name="Temperatures" type="tns:temp" /> <s:element minOccurs="1" maxOccurs="1" name="ProbabilityOfPrecipiation" type="tns:POP" /> </s:sequence> </s:complexType> <s:complexType name="temp"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="MorningLow" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="DaytimeHigh" type="s:string" /> </s:sequence> </s:complexType> <s:complexType name="POP"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="Nighttime" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Daytime" type="s:string" /> </s:sequence> </s:complexType> <s:element name="GetCityWeatherByZIP"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="ZIP" type="s:string" /> </s:sequence> </s:complexType> </s:element> <s:element name="GetCityWeatherByZIPResponse"> <s:complexType> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="GetCityWeatherByZIPResult" type="tns:WeatherReturn" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="WeatherReturn"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="Success" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="ResponseText" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="State" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="WeatherStationCity" type="s:string" /> <s:element minOccurs="1" maxOccurs="1" name="WeatherID" type="s:short" /> <s:element minOccurs="0" maxOccurs="1" name="Description" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Temperature" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="RelativeHumidity" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Wind" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Pressure" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Visibility" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="WindChill" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Remarks" type="s:string" /> </s:sequence> </s:complexType> <s:element name="ArrayOfWeatherDescription" nillable="true" type="tns:ArrayOfWeatherDescription" /> <s:element name="ForecastReturn" nillable="true" type="tns:ForecastReturn" /> <s:element name="WeatherReturn" type="tns:WeatherReturn" /> </s:schema>'''
    }
  }
}

ARM template resource definition

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

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

Property Values

Microsoft.ApiManagement/service/apis/schemas

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

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
properties Properties of the Schema. SchemaCreateOrUpdatePropertiesOrSchemaContractProperties
type The resource type 'Microsoft.ApiManagement/service/apis/schemas'

SchemaCreateOrUpdatePropertiesOrSchemaContractProperties

Name Description Value
contentType 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/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (required)
document Create or update Properties of the Schema Document. SchemaDocumentPropertiesOrAnyObject

SchemaDocumentPropertiesOrAnyObject

Name Description Value
value Json escaped string defining the document representing the Schema. string

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/schemas@2019-01-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      contentType = "string"
      document = {
        value = "string"
      }
    }
  }
}

Property Values

Microsoft.ApiManagement/service/apis/schemas

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/apis
properties Properties of the Schema. SchemaCreateOrUpdatePropertiesOrSchemaContractProperties
type The resource type "Microsoft.ApiManagement/service/apis/schemas@2019-01-01"

SchemaCreateOrUpdatePropertiesOrSchemaContractProperties

Name Description Value
contentType 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/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (required)
document Create or update Properties of the Schema Document. SchemaDocumentPropertiesOrAnyObject

SchemaDocumentPropertiesOrAnyObject

Name Description Value
value Json escaped string defining the document representing the Schema. string

Usage Examples

Terraform Samples

A basic example of deploying API Schema within an API Management Service.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "api" {
  type      = "Microsoft.ApiManagement/service/apis@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = "${var.resource_name};rev=1"
  body = {
    properties = {
      apiRevisionDescription = ""
      apiType                = "http"
      apiVersion             = ""
      apiVersionDescription  = ""
      authenticationSettings = {
      }
      description = ""
      displayName = "api1"
      path        = "api1"
      protocols = [
        "https",
      ]
      serviceUrl           = ""
      subscriptionRequired = true
      type                 = "http"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "schema" {
  type      = "Microsoft.ApiManagement/service/apis/schemas@2021-08-01"
  parent_id = azapi_resource.api.id
  name      = var.resource_name
  body = {
    properties = {
      contentType = "application/vnd.ms-azure-apim.xsd+xml"
      document = {
        value = "<!--\n Copyright (c) HashiCorp, Inc.\n SPDX-License-Identifier: MPL-2.0\n-->\n\n<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\"> <s:element name=\"GetWeatherInformation\"> <s:complexType /> </s:element> <s:element name=\"GetWeatherInformationResponse\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" /> </s:sequence> </s:complexType> </s:element> <s:complexType name=\"ArrayOfWeatherDescription\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" /> </s:sequence> </s:complexType> <s:complexType name=\"WeatherDescription\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:element name=\"GetCityForecastByZIP\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" /> </s:sequence> </s:complexType> </s:element> <s:element name=\"GetCityForecastByZIPResponse\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" /> </s:sequence> </s:complexType> </s:element> <s:complexType name=\"ForecastReturn\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" /> </s:sequence> </s:complexType> <s:complexType name=\"ArrayOfForecast\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" /> </s:sequence> </s:complexType> <s:complexType name=\"Forecast\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" /> </s:sequence> </s:complexType> <s:complexType name=\"temp\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:complexType name=\"POP\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:element name=\"GetCityWeatherByZIP\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" /> </s:sequence> </s:complexType> </s:element> <s:element name=\"GetCityWeatherByZIPResponse\"> <s:complexType> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" /> </s:sequence> </s:complexType> </s:element> <s:complexType name=\"WeatherReturn\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" /> <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" /> <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" /> </s:schema>"
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on