Microsoft.ApiManagement hizmeti/apis/schemas 2022-04-01-preview
Bicep kaynak tanımı
Hizmet/apis/şemalar kaynak türü şunları 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/apis/schemas kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2022-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Özellik değerleri
hizmet/apis/şemalar
Ad | Açıklama | Değer |
---|---|---|
name | Kaynak adı Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
Ü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 . |
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/apis/şemalar kaynak türü şunları 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/apis/schemas kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2022-04-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Özellik değerleri
hizmet/apis/şemalar
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | 'Microsoft.ApiManagement/service/apis/schemas' |
apiVersion | Kaynak API'sinin sürümü | '2022-04-01-preview' |
name | Kaynak adı JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
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 . |
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. | |
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. | string |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Hizmet/apis/ş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/apis/schemas kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2022-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Özellik değerleri
hizmet/apis/şemalar
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | "Microsoft.ApiManagement/service/apis/schemas@2022-04-01-preview" |
name | Kaynak adı | dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
parent_id | Bu kaynağın üst öğesi olan kaynağın kimliği. | Şu tür kaynağın kimliği: api'ler |
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 . |
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. | |
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. | string |