Share via

Microsoft.ApiManagement service/apis/schemas 2021-04-01-preview

  • Статья

Определение ресурса Bicep

Тип ресурса service/apis/schemas можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/apis/schemas, добавьте в шаблон следующий код Bicep.

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

Значения свойств

service/apis/schemas

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.		 строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа API
properties Свойства схемы API. ApiSchemaContractProperties

ApiSchemaContractProperties

Имя Описание Значение
сontentType Должен быть допустимым типом мультимедиа, используемым в заголовке Content-Type, как определено в RFC 2616. Тип носителя документа схемы (например, application/json, application/xml).
- Swagger Использование схемы application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Использование схемы application/vnd.ms-azure-apim.xsd+xml
- OpenApi Использование схемы application/vnd.oai.openapi.components+json
- WADL Schema используйте application/vnd.ms-azure-apim.wadl.grammars+xml.		 строка (обязательно)
документ Создайте или обновите свойства документа схемы API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Имя Описание Значение
components Определения типов. Используется только для схем Swagger/OpenAPI версии 2 и 3, в противном случае — null. Для Bicep можно использовать функцию any().
definitions Определения типов. Используется только для схем Swagger/OpenAPI версии 1, в противном случае — null. Для Bicep можно использовать функцию any().
значение Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI. строка

Определение ресурса шаблона ARM

Тип ресурса service/apis/schemas можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/apis/schemas, добавьте следующий код JSON в шаблон.

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

Значения свойств

service/apis/schemas

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service/apis/schemas
версия_API Версия API ресурсов '2021-04-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.
properties Свойства схемы API. ApiSchemaContractProperties

ApiSchemaContractProperties

Имя Описание Значение
сontentType Должен быть допустимым типом мультимедиа, используемым в заголовке Content-Type, как определено в RFC 2616. Тип носителя документа схемы (например, application/json, application/xml).
- Swagger Использование схемы application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Использование схемы application/vnd.ms-azure-apim.xsd+xml
- OpenApi Использование схемы application/vnd.oai.openapi.components+json
- WADL Schema используйте application/vnd.ms-azure-apim.wadl.grammars+xml.		 строка (обязательно)
документ Создайте или обновите свойства документа схемы API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Имя Описание Значение
components Определения типов. Используется только для схем Swagger/OpenAPI версии 2 и 3, в противном случае — null.
definitions Определения типов. Используется только для схем Swagger/OpenAPI версии 1, в противном случае — null.
значение Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI. строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса service/apis/schemas можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/apis/schemas, добавьте в шаблон следующую terraform.

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

Значения свойств

service/apis/schemas

Имя Описание Значение
тип Тип ресурса "Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview"
name имя ресурса. строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые символы и дефисы.

Начинается с буквы и заканчивается буквенно-цифровым символом.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа API
properties Свойства схемы API. ApiSchemaContractProperties

ApiSchemaContractProperties

Имя Описание Значение
сontentType Должен быть допустимым типом мультимедиа, используемым в заголовке Content-Type, как определено в RFC 2616. Тип носителя документа схемы (например, application/json, application/xml).
- Swagger Использование схемы application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Использование схемы application/vnd.ms-azure-apim.xsd+xml
- OpenApi Использование схемы application/vnd.oai.openapi.components+json
- WADL Schema используйте application/vnd.ms-azure-apim.wadl.grammars+xml.		 строка (обязательно)
документ Создайте или обновите свойства документа схемы API. ApiSchemaDocumentProperties

ApiSchemaDocumentProperties

Имя Описание Значение
components Определения типов. Используется только для схем Swagger/OpenAPI версии 2 и 3, в противном случае — null.
definitions Определения типов. Используется только для схем Swagger/OpenAPI версии 1, в противном случае — null.
значение Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI. строка