你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ApiContractProperties interface

包:

@azure/arm-apimanagement

API 实体属性

扩展

ApiEntityBaseContract

属性

apiVersionSet	版本集详细信息
displayName	API 名称。 长度必须为 1 到 300 个字符。
path	相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。 可将其追加到在服务实例创建过程中指定的 API 终结点基 URL，构成此 API 的公共 URL。
protocols	说明可在哪些协议上调用此 API 中的操作。
serviceUrl	实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。
sourceApiId	源 API 的 API 标识符。

继承属性

apiRevision	描述 API 的修订。 如果未提供任何值，则会创建默认修订版 1
apiRevisionDescription	API 修订的说明。
apiType	API 的类型。
apiVersion	指示 API 的版本标识符（如果 API 已版本控制）
apiVersionDescription	API 版本的说明。
apiVersionSetId	相关 ApiVersionSet 的资源标识符。
authenticationSettings	此 API 中包含的身份验证设置的集合。
contact	API 的联系信息。
description	API 的说明。 可以包含 HTML 格式标记。
isCurrent	指示 API 修订是否为当前 API 修订。
isOnline	指示是否可通过网关访问 API 修订。 注意：此属性不会被序列化。 它只能由服务器填充。
license	API 的许可证信息。
subscriptionKeyParameterNames	提供 API 的协议。
subscriptionRequired	指定访问 API 是否需要 API 订阅或产品订阅。
termsOfServiceUrl	API 服务条款的 URL。 必须采用 URL 的格式。

属性详细信息

apiVersionSet

版本集详细信息

apiVersionSet?: ApiVersionSetContractDetails

属性值

ApiVersionSetContractDetails

displayName

API 名称。 长度必须为 1 到 300 个字符。

displayName?: string

属性值

string

path

相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。 可将其追加到在服务实例创建过程中指定的 API 终结点基 URL，构成此 API 的公共 URL。

path: string

属性值

string

protocols

说明可在哪些协议上调用此 API 中的操作。

protocols?: string[]

属性值

string[]

serviceUrl

实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。

serviceUrl?: string

属性值

string

sourceApiId

源 API 的 API 标识符。

sourceApiId?: string

属性值

string

继承属性详细信息

apiRevision

描述 API 的修订。 如果未提供任何值，则会创建默认修订版 1

apiRevision?: string

属性值

string

继承自ApiEntityBaseContract.apiRevision

apiRevisionDescription

API 修订的说明。

apiRevisionDescription?: string

属性值

string

继承自ApiEntityBaseContract.apiRevisionDescription

apiType

API 的类型。

apiType?: string

属性值

string

继承自ApiEntityBaseContract.apiType

apiVersion

指示 API 的版本标识符（如果 API 已版本控制）

apiVersion?: string

属性值

string

继承自ApiEntityBaseContract.apiVersion

apiVersionDescription

API 版本的说明。

apiVersionDescription?: string

属性值

string

继承自ApiEntityBaseContract.apiVersionDescription

apiVersionSetId

相关 ApiVersionSet 的资源标识符。

apiVersionSetId?: string

属性值

string

继承自ApiEntityBaseContract.apiVersionSetId

authenticationSettings

此 API 中包含的身份验证设置的集合。

authenticationSettings?: AuthenticationSettingsContract

属性值

AuthenticationSettingsContract

继承自ApiEntityBaseContract.authenticationSettings

contact

API 的联系信息。

contact?: ApiContactInformation

属性值

ApiContactInformation

继承自ApiEntityBaseContract.contact

description

API 的说明。 可以包含 HTML 格式标记。

description?: string

属性值

string

继承自ApiEntityBaseContract.description

isCurrent

指示 API 修订是否为当前 API 修订。

isCurrent?: boolean

属性值

boolean

继承自ApiEntityBaseContract.isCurrent

isOnline

指示是否可通过网关访问 API 修订。 注意：此属性不会被序列化。 它只能由服务器填充。

isOnline?: boolean

属性值

boolean

继承自ApiEntityBaseContract.isOnline

license

API 的许可证信息。

license?: ApiLicenseInformation

属性值

ApiLicenseInformation

继承自ApiEntityBaseContract.license

subscriptionKeyParameterNames

提供 API 的协议。

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

属性值

SubscriptionKeyParameterNamesContract

继承自ApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

指定访问 API 是否需要 API 订阅或产品订阅。

subscriptionRequired?: boolean

属性值

boolean

继承自ApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

API 服务条款的 URL。 必须采用 URL 的格式。

termsOfServiceUrl?: string

属性值

string

继承自ApiEntityBaseContract.termsOfServiceUrl