你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ApiEntityBaseContract interface
API 基本协定详细信息。
属性
| api |
描述 API 的修订。 如果未提供任何值，则会创建默认修订版 1 |
| api |
API 修订的说明。 |
| api |
API 的类型。 |
| api |
指示 API 的版本标识符（如果 API 已版本控制） |
| api |
API 版本的说明。 |
| api |
相关 ApiVersionSet 的资源标识符。 |
| authentication |
此 API 中包含的身份验证设置的集合。 |
| contact | API 的联系信息。 |
| description | API 的说明。 可以包含 HTML 格式标记。 |
| is |
指示 API 修订是否为当前 API 修订。 |
| is |
指示是否可通过网关访问 API 修订。 注意：此属性不会被序列化。 它只能由服务器填充。 |
| license | API 的许可证信息。 |
| subscription |
提供 API 的协议。 |
| subscription |
指定访问 API 是否需要 API 订阅或产品订阅。 |
| terms |
API 服务条款的 URL。 必须采用 URL 的格式。 |
属性详细信息
apiRevision
描述 API 的修订。 如果未提供任何值，则会创建默认修订版 1
apiRevision?: string属性值
string
apiRevisionDescription
API 修订的说明。
apiRevisionDescription?: string属性值
string
apiType
API 的类型。
apiType?: string属性值
string
apiVersion
指示 API 的版本标识符（如果 API 已版本控制）
apiVersion?: string属性值
string
apiVersionDescription
API 版本的说明。
apiVersionDescription?: string属性值
string
apiVersionSetId
相关 ApiVersionSet 的资源标识符。
apiVersionSetId?: string属性值
string
authenticationSettings
此 API 中包含的身份验证设置的集合。
authenticationSettings?: AuthenticationSettingsContract属性值
contact
description
API 的说明。 可以包含 HTML 格式标记。
description?: string属性值
string
isCurrent
指示 API 修订是否为当前 API 修订。
isCurrent?: boolean属性值
boolean
isOnline
指示是否可通过网关访问 API 修订。 注意：此属性不会被序列化。 它只能由服务器填充。
isOnline?: boolean属性值
boolean
license
subscriptionKeyParameterNames
提供 API 的协议。
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract属性值
subscriptionRequired
指定访问 API 是否需要 API 订阅或产品订阅。
subscriptionRequired?: boolean属性值
boolean
termsOfServiceUrl
API 服务条款的 URL。 必须采用 URL 的格式。
termsOfServiceUrl?: string属性值
string