共用方式為

ApiContractProperties interface

  • 參考
套件:
@azure/arm-apimanagement

API 實體屬性

Extends
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 或 Product 訂用帳戶。
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 或 Product 訂用帳戶。

subscriptionRequired?: boolean

屬性值

boolean

繼承自ApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

API 服務條款的 URL。 必須是 URL 的格式。

termsOfServiceUrl?: string

屬性值

string

繼承自ApiEntityBaseContract.termsOfServiceUrl