SchemaContract interface

套件:

@azure/arm-apimanagement

API 架構合約詳細數據。

Extends

ProxyResource

屬性

components	類型定義。 僅用於 Swagger/OpenAPI v2/v3 架構，否則為 null。
contentType	必須是 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。
definitions	類型定義。 僅用於 Swagger/OpenAPI v1 架構，否則為 null。
value	定義代表架構之檔的 Json 逸出字串。 用於 Swagger/OpenAPI 以外的架構。

繼承的屬性

id	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此屬性將不會串行化。 它只能由伺服器填入。
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
type	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

屬性詳細資料

components

類型定義。 僅用於 Swagger/OpenAPI v2/v3 架構，否則為 null。

components?: Record<string, unknown>

屬性值

Record<string, unknown>

contentType

必須是 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。

contentType?: string

屬性值

string

definitions

類型定義。 僅用於 Swagger/OpenAPI v1 架構，否則為 null。

definitions?: Record<string, unknown>

屬性值

Record<string, unknown>

value

定義代表架構之檔的 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