ApiCreateOrUpdateParameter interface

套件:

@azure/arm-apimanagement

API 建立或更新參數。

屬性

apiRevision	描述 API 的修訂。 如果未提供任何值，則會建立預設修訂 1
apiRevisionDescription	API 修訂的描述。
apiType	API 的類型。
apiVersion	如果 API 已設定版本，則指出 API 的版本識別碼
apiVersionDescription	API 版本的描述。
apiVersionSet	版本設定詳細數據
apiVersionSetId	相關 ApiVersionSet 的資源標識碼。
authenticationSettings	此 API 中包含的驗證設定集合。
contact	API 的連絡資訊。
description	API 的描述。 可能包含 HTML 格式標記。
displayName	API 名稱。 長度必須為 1 到 300 個字元。
format	匯入 API 的內容格式。 未來可以新增新格式
isCurrent	指出 API 修訂是否為目前的 API 修訂。
isOnline	指出是否可透過閘道存取 API 修訂。 注意：這個屬性不會串行化。 它只能由伺服器填入。
license	API 的授權資訊。
path	相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。
protocols	描述可以叫用此 API 中作業的通訊協定。
provisioningState	布建狀態注意：此屬性將不會串行化。 它只能由伺服器填入。
serviceUrl	實作此 API 之後端服務的絕對 URL。 長度不能超過 2000 個字元。
soapApiType	要建立的 API 類型。 http 建立 REST API soap 建立SOAP傳遞 API websocket 建立 websocket API graphql 建立 GraphQL API。 未來可以新增類型。
sourceApiId	來源 API 的 API 識別碼。
subscriptionKeyParameterNames	API 可供使用之通訊協定。
subscriptionRequired	指定存取 API 是否需要 API 或 Product 訂用帳戶。
termsOfServiceUrl	API 服務條款的 URL。 必須是 URL 的格式。
translateRequiredQueryParametersConduct	將所需的查詢參數轉譯為範本的策略。 根據預設，值為 'template'。 可能的值：'template'、'query'
value	匯入 API 時的內容值。
wsdlSelector	將 WSDL 匯入限制為檔的子集的準則。

屬性詳細資料

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

apiVersionSet

版本設定詳細數據

apiVersionSet?: ApiVersionSetContractDetails

屬性值

ApiVersionSetContractDetails

apiVersionSetId

相關 ApiVersionSet 的資源標識碼。

apiVersionSetId?: string

屬性值

string

authenticationSettings

此 API 中包含的驗證設定集合。

authenticationSettings?: AuthenticationSettingsContract

屬性值

AuthenticationSettingsContract

contact

API 的連絡資訊。

contact?: ApiContactInformation

屬性值

ApiContactInformation

description

API 的描述。 可能包含 HTML 格式標記。

description?: string

屬性值

string

displayName

API 名稱。 長度必須為 1 到 300 個字元。

displayName?: string

屬性值

string

format

匯入 API 的內容格式。 未來可以新增新格式

format?: string

屬性值

string

isCurrent

指出 API 修訂是否為目前的 API 修訂。

isCurrent?: boolean

屬性值

boolean

isOnline

指出是否可透過閘道存取 API 修訂。 注意：這個屬性不會串行化。 它只能由伺服器填入。

isOnline?: boolean

屬性值

boolean

license

API 的授權資訊。

license?: ApiLicenseInformation

屬性值

ApiLicenseInformation

path

相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。 它會附加至服務實例建立期間指定的 API 端點基底 URL，以形成此 API 的公用 URL。

path?: string

屬性值

string

protocols

描述可以叫用此 API 中作業的通訊協定。

protocols?: string[]

屬性值

string[]

provisioningState

布建狀態注意：此屬性將不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

serviceUrl

實作此 API 之後端服務的絕對 URL。 長度不能超過 2000 個字元。

serviceUrl?: string

屬性值

string

soapApiType

要建立的 API 類型。

• http 建立 REST API
• soap 建立SOAP傳遞 API
• websocket 建立 websocket API
• graphql 建立 GraphQL API。 未來可以新增類型。

soapApiType?: string

屬性值

string

sourceApiId

來源 API 的 API 識別碼。

sourceApiId?: string

屬性值

string

subscriptionKeyParameterNames

API 可供使用之通訊協定。

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

屬性值

SubscriptionKeyParameterNamesContract

subscriptionRequired

指定存取 API 是否需要 API 或 Product 訂用帳戶。

subscriptionRequired?: boolean

屬性值

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

屬性值

string

translateRequiredQueryParametersConduct

將所需的查詢參數轉譯為範本的策略。 根據預設，值為 'template'。 可能的值：'template'、'query'

translateRequiredQueryParametersConduct?: string

屬性值

string

value

匯入 API 時的內容值。

value?: string

屬性值

string

wsdlSelector

將 WSDL 匯入限制為檔的子集的準則。

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

屬性值

ApiCreateOrUpdatePropertiesWsdlSelector