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

ApiContract 类

定义

API 详细信息。

[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiContract : Microsoft.Azure.Management.ApiManagement.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ApiContract = class
    inherit Resource
Public Class ApiContract
Inherits Resource
继承
ApiContract
属性

构造函数

ApiContract()

初始化 ApiContract 类的新实例。

ApiContract(String, String, String, String, String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, ApiContactInformation, ApiLicenseInformation, String, String, String, IList<String>, ApiVersionSetContractDetails)

初始化 ApiContract 类的新实例。

属性

ApiRevision

获取或设置描述 API 的修订。 如果未提供任何值,则创建默认修订版 1

ApiRevisionDescription

获取或设置 API 修订版的说明。

ApiType

获取或设置 API 的类型。 可能的值包括:“http”、“soap”、“websocket”、“graphql”

ApiVersion

获取或设置指示 API 的版本标识符(如果 API 已进行版本控制)

ApiVersionDescription

获取或设置 API 版本的说明。

ApiVersionSet

获取或设置版本集详细信息

ApiVersionSetId

获取或设置相关 ApiVersionSet 的资源标识符。

AuthenticationSettings

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

Contact

获取或设置 API 的联系信息。

Description

获取或设置 API 的说明。 可以包含 HTML 格式标记。

DisplayName

获取或设置 API 名称。 长度必须为 1 到 300 个字符。

Id

获取资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(继承自 Resource)
IsCurrent

获取或设置指示 API 修订是否为当前 API 修订版。

IsOnline

获取指示是否可通过网关访问 API 修订。

License

获取或设置 API 的许可证信息。

Name

获取资源的名称

(继承自 Resource)
Path

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

Protocols

获取或设置描述可基于哪些协议调用此 API 中的操作。

ServiceUrl

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

SourceApiId

获取或设置源 API 的 API 标识符。

SubscriptionKeyParameterNames

获取或设置提供 API 的协议。

SubscriptionRequired

获取或设置指定访问 API 是否需要 API 或产品订阅。

TermsOfServiceUrl

获取或设置 API 的服务条款的 URL。 必须采用 URL 的格式。

Type

获取资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

(继承自 Resource)

方法

Validate()

验证 对象。

适用于