Share via

SchemaContract interface

Package:
@azure/arm-apimanagement

API Schema Contract details.

Extends
ProxyResource

Properties

components

Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
contentType

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema use application/vnd.ms-azure-apim.odata.schema
- gRPC Schema use text/protobuf.
definitions

Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
provisioningState

The provisioning state NOTE: This property will not be serialized. It can only be populated by the server.
value

Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

components

Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.

components?: Record<string, unknown>

Property Value

Record<string, unknown>

contentType

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema use application/vnd.ms-azure-apim.odata.schema
- gRPC Schema use text/protobuf.

contentType?: string

Property Value

string

definitions

Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.

definitions?: Record<string, unknown>

Property Value

Record<string, unknown>

provisioningState

The provisioning state NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

value

Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.

value?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type