Служба Microsoft.ApiManagement/workspaces/apis/schemas 2023-09-01-preview
- последние
- 2023-09-01-preview
Определение ресурсов Bicep
Тип ресурса service/workspaces/apis/schemas можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apis/schemas, добавьте следующий Bicep в шаблон.
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'
}
}
}
Значения свойств
service/workspaces/apis/schemas
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в Bicep. |
строка (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: API |
| свойства | Свойства схемы API. | schemaContractProperties |
SchemaContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| contentType | Должен быть допустимым типом носителя, используемым в заголовке Content-Type, как определено в RFC 2616. Тип носителя документа схемы (например, application/json, application/xml). использование схемы - Swaggerapplication/vnd.ms-azure-apim.swagger.definitions+json использование схемы - WSDLapplication/vnd.ms-azure-apim.xsd+xml использование схемы - OpenApiapplication/vnd.oai.openapi.components+json - WADL Schema использовать application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema использовать application/vnd.ms-azure-apim.odata.schema - gRPC Schema использовать text/protobuf. |
строка (обязательно) |
| документ | Создание или обновление свойств документа схемы API. | SchemaDocumentProperties (обязательно) |
SchemaDocumentProperties
| Имя | Описание | Ценность |
|---|---|---|
| Компоненты | Определения типов. Используется только для схем Swagger/OpenAPI версии 2/v3, значение NULL в противном случае. | Для Bicep можно использовать функцию any(). |
| Определения | Определения типов. Используется только для схем Swagger/OpenAPI версии 1, значение NULL в противном случае. | Для Bicep можно использовать функцию any(). |
| ценность | Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI. | струна |
Определение ресурса шаблона ARM
Тип ресурса service/workspaces/apis/schemas можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apis/schemas, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Значения свойств
service/workspaces/apis/schemas
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/workspaces/apis/schemas" |
| apiVersion | Версия API ресурсов | '2023-09-01-preview' |
| имя | Имя ресурса Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON. |
строка (обязательно) |
| свойства | Свойства схемы API. | schemaContractProperties |
SchemaContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| contentType | Должен быть допустимым типом носителя, используемым в заголовке Content-Type, как определено в RFC 2616. Тип носителя документа схемы (например, application/json, application/xml). использование схемы - Swaggerapplication/vnd.ms-azure-apim.swagger.definitions+json использование схемы - WSDLapplication/vnd.ms-azure-apim.xsd+xml использование схемы - OpenApiapplication/vnd.oai.openapi.components+json - WADL Schema использовать application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema использовать application/vnd.ms-azure-apim.odata.schema - gRPC Schema использовать text/protobuf. |
строка (обязательно) |
| документ | Создание или обновление свойств документа схемы API. | SchemaDocumentProperties (обязательно) |
SchemaDocumentProperties
| Имя | Описание | Ценность |
|---|---|---|
| Компоненты | Определения типов. Используется только для схем Swagger/OpenAPI версии 2/v3, значение NULL в противном случае. | |
| Определения | Определения типов. Используется только для схем Swagger/OpenAPI версии 1, значение NULL в противном случае. | |
| ценность | Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/workspaces/apis/schemas можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apis/schemas, добавьте следующий объект Terraform в шаблон.
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"
}
}
})
}
Значения свойств
service/workspaces/apis/schemas
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview" |
| имя | Имя ресурса | строка (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: API |
| свойства | Свойства схемы API. | schemaContractProperties |
SchemaContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| contentType | Должен быть допустимым типом носителя, используемым в заголовке Content-Type, как определено в RFC 2616. Тип носителя документа схемы (например, application/json, application/xml). использование схемы - Swaggerapplication/vnd.ms-azure-apim.swagger.definitions+json использование схемы - WSDLapplication/vnd.ms-azure-apim.xsd+xml использование схемы - OpenApiapplication/vnd.oai.openapi.components+json - WADL Schema использовать application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema использовать application/vnd.ms-azure-apim.odata.schema - gRPC Schema использовать text/protobuf. |
строка (обязательно) |
| документ | Создание или обновление свойств документа схемы API. | SchemaDocumentProperties (обязательно) |
SchemaDocumentProperties
| Имя | Описание | Ценность |
|---|---|---|
| Компоненты | Определения типов. Используется только для схем Swagger/OpenAPI версии 2/v3, значение NULL в противном случае. | |
| Определения | Определения типов. Используется только для схем Swagger/OpenAPI версии 1, значение NULL в противном случае. | |
| ценность | Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI. | струна |