Microsoft.ApiManagement — usługa/schematy

Definicja zasobu Bicep

Typ zasobu usługi/schematów można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Przykłady użycia

Przykłady Bicep

Podstawowy przykład wdrażania schematu globalnego w usłudze API Management.

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

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 0
    name: 'Consumption'
  }
  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'
  }
}

resource schema 'Microsoft.ApiManagement/service/schemas@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    description: ''
    schemaType: 'xml'
    value: '''    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:tns="http://tempuri.org/PurchaseOrderSchema.xsd" targetNamespace="http://tempuri.org/PurchaseOrderSchema.xsd" elementFormDefault="qualified">
    <xsd:element name="PurchaseOrder" type="tns:PurchaseOrderType"/>
    <xsd:complexType name="PurchaseOrderType">
        <xsd:sequence>
            <xsd:element name="ShipTo" type="tns:USAddress" maxOccurs="2"/>
            <xsd:element name="BillTo" type="tns:USAddress"/>
        </xsd:sequence>
        <xsd:attribute name="OrderDate" type="xsd:date"/>
    </xsd:complexType>
    <xsd:complexType name="USAddress">
        <xsd:sequence>
            <xsd:element name="name" type="xsd:string"/>
            <xsd:element name="street" type="xsd:string"/>
            <xsd:element name="city" type="xsd:string"/>
            <xsd:element name="state" type="xsd:string"/>
            <xsd:element name="zip" type="xsd:integer"/>
        </xsd:sequence>
        <xsd:attribute name="country" type="xsd:NMTOKEN" fixed="US"/>
    </xsd:complexType>
</xsd:schema>
'''
  }
}

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/schemas, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/schemas@2025-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    document: any(...)
    schemaType: 'string'
    value: any(...)
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/schemas

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80 (wymagane)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: usługi
Właściwości Właściwości schematu globalnego. Właściwości GlobalSchemaContractProperties

Właściwości GlobalSchemaContractProperties

Nazwa Opis Wartość
opis Opis jednostki schematu w dowolnej formie. ciąg
dokument Obiekt dokumentu schematu globalnego dla formatów schematów opartych na formacie JSON (e.g. json schema). jakikolwiek
schemaType (typ schematu) Typ schematu. Niezmienialny. "json"
"xml" (wymagane)
wartość Ciąg zakodowany w formacie Json dla schematu opartego na formacie JSON. jakikolwiek

Definicja zasobu szablonu usługi ARM

Typ zasobu usługi/schematów można wdrożyć przy użyciu operacji docelowych:

Przykłady użycia

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/schemas, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.ApiManagement/service/schemas

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2025-09-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80 (wymagane)
Właściwości Właściwości schematu globalnego. Właściwości GlobalSchemaContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/schemas"

Właściwości GlobalSchemaContractProperties

Nazwa Opis Wartość
opis Opis jednostki schematu w dowolnej formie. ciąg
dokument Obiekt dokumentu schematu globalnego dla formatów schematów opartych na formacie JSON (e.g. json schema). jakikolwiek
schemaType (typ schematu) Typ schematu. Niezmienialny. "json"
"xml" (wymagane)
wartość Ciąg zakodowany w formacie Json dla schematu opartego na formacie JSON. jakikolwiek

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu usługi/schematów można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania schematu globalnego w usłudze API Management.

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" "schema" {
  type      = "Microsoft.ApiManagement/service/schemas@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      schemaType  = "xml"
      value       = "    <xsd:schema xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n    xmlns:tns=\"http://tempuri.org/PurchaseOrderSchema.xsd\" targetNamespace=\"http://tempuri.org/PurchaseOrderSchema.xsd\" elementFormDefault=\"qualified\">\n    <xsd:element name=\"PurchaseOrder\" type=\"tns:PurchaseOrderType\"/>\n    <xsd:complexType name=\"PurchaseOrderType\">\n        <xsd:sequence>\n            <xsd:element name=\"ShipTo\" type=\"tns:USAddress\" maxOccurs=\"2\"/>\n            <xsd:element name=\"BillTo\" type=\"tns:USAddress\"/>\n        </xsd:sequence>\n        <xsd:attribute name=\"OrderDate\" type=\"xsd:date\"/>\n    </xsd:complexType>\n    <xsd:complexType name=\"USAddress\">\n        <xsd:sequence>\n            <xsd:element name=\"name\" type=\"xsd:string\"/>\n            <xsd:element name=\"street\" type=\"xsd:string\"/>\n            <xsd:element name=\"city\" type=\"xsd:string\"/>\n            <xsd:element name=\"state\" type=\"xsd:string\"/>\n            <xsd:element name=\"zip\" type=\"xsd:integer\"/>\n        </xsd:sequence>\n        <xsd:attribute name=\"country\" type=\"xsd:NMTOKEN\" fixed=\"US\"/>\n    </xsd:complexType>\n</xsd:schema>\n"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/schemas, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/schemas@2025-09-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      document = ?
      schemaType = "string"
      value = ?
    }
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/schemas

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80 (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Właściwości schematu globalnego. Właściwości GlobalSchemaContractProperties
typ Typ zasobu "Microsoft. ApiManagement/service/schemas@2025-09-01-preview"

Właściwości GlobalSchemaContractProperties

Nazwa Opis Wartość
opis Opis jednostki schematu w dowolnej formie. ciąg
dokument Obiekt dokumentu schematu globalnego dla formatów schematów opartych na formacie JSON (e.g. json schema). jakikolwiek
schemaType (typ schematu) Typ schematu. Niezmienialny. "json"
"xml" (wymagane)
wartość Ciąg zakodowany w formacie Json dla schematu opartego na formacie JSON. jakikolwiek