Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/çalışma alanları/apis/schemas 2023-05-01-preview

  • Makale

Bicep kaynak tanımı

Hizmet/çalışma alanları/apis/şemalar kaynak türü şu işlemleri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/workspaces/apis/schemas kaynağı oluşturmak için aşağıdaki Bicep'i şablonunuza ekleyin.

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

Özellik değerleri

hizmet/çalışma alanları/apis/şemalar

Ad Açıklama Değer
name Kaynak adı

Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
Üst Bicep'te alt kaynak için üst kaynağı belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak.		 Kaynak türü için sembolik ad: apis
properties API Şemasının özellikleri. SchemaContractProperties

SchemaContractProperties

Ad Açıklama Değer
Contenttype RFC 2616'da tanımlandığı gibi İçerik Türü üst bilgisinde kullanılan geçerli bir medya türü olmalıdır. Şema belgesinin medya türü (örneğin, application/json, application/xml).
- Swagger Şema kullanımı application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Şema kullanımı application/vnd.ms-azure-apim.xsd+xml
- OpenApi Şema kullanımı application/vnd.oai.openapi.components+json
- WADL Schema Kullanın application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema Kullanın application/vnd.ms-azure-apim.odata.schema
- gRPC Schema kullanın text/protobuf.		 dize (gerekli)
belge API Şema Belgesinin Özelliklerini oluşturun veya güncelleştirin. SchemaDocumentProperties (gerekli)

SchemaDocumentProperties

Ad Açıklama Değer
Bileşen Tür tanımları. Yalnızca Swagger/OpenAPI v2/v3 şemaları için kullanılır, aksi takdirde null. Bicep için any() işlevini kullanabilirsiniz.
tanımlar Tür tanımları. Yalnızca Swagger/OpenAPI v1 şemaları için kullanılır, aksi takdirde null. Bicep için any() işlevini kullanabilirsiniz.
değer Json, Şemayı temsil eden belgeyi tanımlayan dizeden kaçtı. Swagger/OpenAPI dışındaki şemalar için kullanılır. string

ARM şablonu kaynak tanımı

Hizmet/çalışma alanları/apis/şemalar kaynak türü şu işlemleri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/workspaces/apis/schemas kaynağı oluşturmak için şablonunuza aşağıdaki JSON dosyasını ekleyin.

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

Özellik değerleri

hizmet/çalışma alanları/apis/şemalar

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/workspaces/apis/schemas'
apiVersion Kaynak API'sinin sürümü '2023-05-01-preview'
name Kaynak adı

JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
properties API Şemasının özellikleri. SchemaContractProperties

SchemaContractProperties

Ad Açıklama Değer
Contenttype RFC 2616'da tanımlandığı gibi İçerik Türü üst bilgisinde kullanılan geçerli bir medya türü olmalıdır. Şema belgesinin medya türü (örneğin, application/json, application/xml).
- Swagger Şema kullanımı application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Şema kullanımı application/vnd.ms-azure-apim.xsd+xml
- OpenApi Şema kullanımı application/vnd.oai.openapi.components+json
- WADL Schema Kullanın application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema Kullanın application/vnd.ms-azure-apim.odata.schema
- gRPC Schema kullanın text/protobuf.		 dize (gerekli)
belge API Şema Belgesinin Özelliklerini oluşturun veya güncelleştirin. SchemaDocumentProperties (gerekli)

SchemaDocumentProperties

Ad Açıklama Değer
Bileşen Tanımları türleri. Yalnızca Swagger/OpenAPI v2/v3 şemaları için kullanılır; aksi takdirde null.
tanımlar Tanımları türleri. Yalnızca Swagger/OpenAPI v1 şemaları için kullanılır, aksi takdirde null.
değer Json, Şemayı temsil eden belgeyi tanımlayan dizeden kaçtı. Swagger/OpenAPI dışındaki şemalar için kullanılır. string

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Hizmet/çalışma alanları/api'ler/şemalar kaynak türü şunları hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/workspaces/apis/schemas kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

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

Özellik değerleri

hizmet/çalışma alanları/api'ler/şemalar

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview"
name Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: api'ler için kimlik
properties API Şemasının Özellikleri. SchemaContractProperties

SchemaContractProperties

Ad Açıklama Değer
Contenttype RFC 2616'da tanımlandığı gibi content-Type üst bilgisinde kullanılan geçerli bir medya türü olmalıdır. Şema belgesinin medya türü (örn. application/json, application/xml).
- Swagger Şema kullanımı application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Şema kullanımı application/vnd.ms-azure-apim.xsd+xml
- OpenApi Şema kullanımı application/vnd.oai.openapi.components+json
- WADL Schema Kullanın application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema Kullanın application/vnd.ms-azure-apim.odata.schema
- gRPC Schema kullanın text/protobuf.		 dize (gerekli)
belge API Şema Belgesinin Özelliklerini oluşturun veya güncelleştirin. SchemaDocumentProperties (gerekli)

SchemaDocumentProperties

Ad Açıklama Değer
Bileşen Tanımları türleri. Yalnızca Swagger/OpenAPI v2/v3 şemaları için kullanılır; aksi takdirde null.
tanımlar Tanımları türleri. Yalnızca Swagger/OpenAPI v1 şemaları için kullanılır, aksi takdirde null.
değer Json, Şemayı temsil eden belgeyi tanımlayan dizeden kaçtı. Swagger/OpenAPI dışındaki şemalar için kullanılır. string