Поделиться через

SchemaContract interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

Сведения о контракте схемы API.

Extends
ProxyResource

Свойства

components

Определения типов. Используется только для схем Swagger/OpenAPI версии 2 и 3, в противном случае — null.
contentType

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

Определения типов. Используется только для схем Swagger/OpenAPI версии 1, в противном случае — null.
value

Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI.

Унаследованные свойства

id

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.
name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.
type

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

Сведения о свойстве

components

Определения типов. Используется только для схем Swagger/OpenAPI версии 2 и 3, в противном случае — null.

components?: Record<string, unknown>

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

Record<string, unknown>

contentType

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

contentType?: string

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

string

definitions

Определения типов. Используется только для схем Swagger/OpenAPI версии 1, в противном случае — null.

definitions?: Record<string, unknown>

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

Record<string, unknown>

value

Escape-строка JSON, определяющая документ, представляющий схему. Используется для схем, отличных от Swagger/OpenAPI.

value?: string

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

string

Сведения об унаследованном свойстве

id

Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

id?: string

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

string

Наследуется отProxyResource.id

name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.

name?: string

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

string

Наследуется отProxyResource.name

type

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" ПРИМЕЧАНИЕ. Это свойство не сериализуется. Его может заполнить только сервер.

type?: string

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

string

Наследуется отProxyResource.type