Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/çalışma alanları/apis/şemalar

  • Makale

Bicep kaynak tanımı

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

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

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 Bicep'i ekleyin.

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

Özellik değerleri

service/workspaces/apis/schemas

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

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

Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında.		 Tür kaynağı için sembolik ad: api'leri
Özellikler 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ü (ö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 application/vnd.ms-azure-apim.wadl.grammars+xml kullanma
- OData Schema application/vnd.ms-azure-apim.odata.schema kullanma
- gRPC Schema text/protobufkullanın.		 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 olur. 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. dizgi

ARM şablonu kaynak tanımı

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

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

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'u ekleyin.

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

Özellik değerleri

service/workspaces/apis/schemas

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

JSON ARM şablonlarında alt kaynakların adlarını ve türlerini ayarlamayı öğrenin.		 dize (gerekli)
Özellikler 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ü (ö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 application/vnd.ms-azure-apim.wadl.grammars+xml kullanma
- OData Schema application/vnd.ms-azure-apim.odata.schema kullanma
- gRPC Schema text/protobufkullanın.		 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 olur.
tanımlar Tür tanımları. 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. dizgi

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

Hizmet/çalışma alanları/apis/şemalar kaynak türü, aşağıdakileri 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-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      contentType = "string"
      document = {
        value = "string"
      }
    }
  })
}

Özellik değerleri

service/workspaces/apis/schemas

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview"
ad Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Tür kaynağı kimliği: API'leri
Özellikler 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ü (ö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 application/vnd.ms-azure-apim.wadl.grammars+xml kullanma
- OData Schema application/vnd.ms-azure-apim.odata.schema kullanma
- gRPC Schema text/protobufkullanın.		 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 olur.
tanımlar Tür tanımları. 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. dizgi