Sdílet prostřednictvím

Služba Microsoft.ApiManagement/apis/schemas 2021-04-01-preview

  • Článek

Definice prostředku Bicep

Typ prostředku služby/apis/schémat je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis/schemas, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    contentType: 'string'
    document: {
      components: any(Azure.Bicep.Types.Concrete.AnyType)
      definitions: any(Azure.Bicep.Types.Concrete.AnyType)
      value: 'string'
    }
  }
}

Hodnoty vlastností

ApiSchemaContractProperties

Jméno Popis Hodnota
contentType Musí být platným typem média použitým v hlavičce Content-Type, jak je definováno v dokumentu RFC 2616. Typ média dokumentu schématu (např. application/json, application/xml).
použití - schématu Swaggerapplication/vnd.ms-azure-apim.swagger.definitions+json
použití - schématu WSDLapplication/vnd.ms-azure-apim.xsd+xml
použití - schématu OpenApiapplication/vnd.oai.openapi.components+json
- WADL Schema použít application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (povinné)
dokument Umožňuje vytvořit nebo aktualizovat vlastnosti dokumentu schématu rozhraní API. apiSchemaDocumentProperties

ApiSchemaDocumentProperties

Jméno Popis Hodnota
součásti Definice typů Používá se pouze pro schémata Swagger/OpenAPI v2/v3, jinak hodnota null. jakýkoliv
definice Definice typů Používá se pouze pro schémata Swagger/OpenAPI v1, jinak hodnota null. jakýkoliv
hodnota Řídicí řetězec JSON definující dokument představující schéma. Používá se pro jiná schémata než Swagger/OpenAPI. řetězec

Microsoft.ApiManagement/service/apis/schemas

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 80 (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: služba /apis
vlastnosti Vlastnosti schématu rozhraní API apiSchemaContractProperties

Definice prostředku šablony ARM

Typ prostředku služby/apis/schémat je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis/schemas, přidejte do šablony následující JSON.

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

Hodnoty vlastností

ApiSchemaContractProperties

Jméno Popis Hodnota
contentType Musí být platným typem média použitým v hlavičce Content-Type, jak je definováno v dokumentu RFC 2616. Typ média dokumentu schématu (např. application/json, application/xml).
použití - schématu Swaggerapplication/vnd.ms-azure-apim.swagger.definitions+json
použití - schématu WSDLapplication/vnd.ms-azure-apim.xsd+xml
použití - schématu OpenApiapplication/vnd.oai.openapi.components+json
- WADL Schema použít application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (povinné)
dokument Umožňuje vytvořit nebo aktualizovat vlastnosti dokumentu schématu rozhraní API. apiSchemaDocumentProperties

ApiSchemaDocumentProperties

Jméno Popis Hodnota
součásti Definice typů Používá se pouze pro schémata Swagger/OpenAPI v2/v3, jinak hodnota null. jakýkoliv
definice Definice typů Používá se pouze pro schémata Swagger/OpenAPI v1, jinak hodnota null. jakýkoliv
hodnota Řídicí řetězec JSON definující dokument představující schéma. Používá se pro jiná schémata než Swagger/OpenAPI. řetězec

Microsoft.ApiManagement/service/apis/schemas

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2021-04-01-preview
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 80 (povinné)
vlastnosti Vlastnosti schématu rozhraní API apiSchemaContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/apis/schemas

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby/apis/schémat je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis/schemas, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

ApiSchemaContractProperties

Jméno Popis Hodnota
contentType Musí být platným typem média použitým v hlavičce Content-Type, jak je definováno v dokumentu RFC 2616. Typ média dokumentu schématu (např. application/json, application/xml).
použití - schématu Swaggerapplication/vnd.ms-azure-apim.swagger.definitions+json
použití - schématu WSDLapplication/vnd.ms-azure-apim.xsd+xml
použití - schématu OpenApiapplication/vnd.oai.openapi.components+json
- WADL Schema použít application/vnd.ms-azure-apim.wadl.grammars+xml.		 string (povinné)
dokument Umožňuje vytvořit nebo aktualizovat vlastnosti dokumentu schématu rozhraní API. apiSchemaDocumentProperties

ApiSchemaDocumentProperties

Jméno Popis Hodnota
součásti Definice typů Používá se pouze pro schémata Swagger/OpenAPI v2/v3, jinak hodnota null. jakýkoliv
definice Definice typů Používá se pouze pro schémata Swagger/OpenAPI v1, jinak hodnota null. jakýkoliv
hodnota Řídicí řetězec JSON definující dokument představující schéma. Používá se pro jiná schémata než Swagger/OpenAPI. řetězec

Microsoft.ApiManagement/service/apis/schemas

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 80 (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služba/ rozhraní API
vlastnosti Vlastnosti schématu rozhraní API apiSchemaContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview