Dela via


Microsoft.ApiManagement service/apis/schemas 2021-08-01

Bicep-resursdefinition

Resurstypen service/apis/scheman kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/schemas-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    contentType: 'string'
    document: {
      components: any()
      definitions: any()
      value: 'string'
    }
  }
}

Egenskapsvärden

service/apis/scheman

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.
sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.
Symboliskt namn för resurs av typen: apis
properties Egenskaper för API-schemat. SchemaContractEgenskaper

SchemaContractEgenskaper

Name Beskrivning Värde
Contenttype Måste vara en giltig medietyp som används i ett innehållstypshuvud enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml).
- Swagger Schemaanvändning application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schemaanvändning application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schemaanvändning application/vnd.oai.openapi.components+json
- WADL Schema använd application/vnd.ms-azure-apim.wadl.grammars+xml.
sträng (krävs)
dokument Skapa eller uppdatera egenskaper för API-schemadokumentet. SchemaDocumentEgenskaper

SchemaDocumentEgenskaper

Name Beskrivning Värde
Komponenter Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. För Bicep kan du använda funktionen any().
definitioner Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. För Bicep kan du använda funktionen any().
värde Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. sträng

Resursdefinition för ARM-mall

Resurstypen service/apis/scheman kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/schemas-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

service/apis/scheman

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/apis/schemas"
apiVersion Resurs-API-versionen '2021-08-01'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.
sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
properties Egenskaper för API-schemat. SchemaContractEgenskaper

SchemaContractEgenskaper

Name Beskrivning Värde
Contenttype Måste vara en giltig medietyp som används i en Content-Type-rubrik enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml).
- Swagger Schemaanvändning application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schemaanvändning application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schemaanvändning application/vnd.oai.openapi.components+json
- WADL Schema använd application/vnd.ms-azure-apim.wadl.grammars+xml.
sträng (krävs)
dokument Skapa eller uppdatera egenskaper för API-schemadokumentet. SchemaDocumentProperties

SchemaDocumentProperties

Name Beskrivning Värde
Komponenter Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null.
definitioner Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null.
värde Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/apis/scheman kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.ApiManagement/service/apis/schemas lägger du till följande Terraform i mallen.

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

Egenskapsvärden

service/apis/scheman

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/apis/schemas@2021-08-01"
name Resursnamnet sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: apis
properties Egenskaper för API-schemat. SchemaContractProperties

SchemaContractProperties

Name Beskrivning Värde
Contenttype Måste vara en giltig medietyp som används i en Content-Type-rubrik enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml).
- Swagger Schemaanvändning application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schemaanvändning application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schemaanvändning application/vnd.oai.openapi.components+json
- WADL Schema använd application/vnd.ms-azure-apim.wadl.grammars+xml.
sträng (krävs)
dokument Skapa eller uppdatera egenskaper för API-schemadokumentet. SchemaDocumentProperties

SchemaDocumentProperties

Name Beskrivning Värde
Komponenter Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null.
definitioner Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null.
värde Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. sträng