ApiUpdateContract interface

パッケージ:

@azure/arm-apimanagement

API 更新コントラクトの詳細。

プロパティ

apiRevision	API のリビジョンについて説明します。 値が指定されていない場合は、既定のリビジョン 1 が作成されます
apiRevisionDescription	API リビジョンの説明。
apiType	API の種類。
apiVersion	API がバージョン管理されている場合は、API のバージョン識別子を示します
apiVersionDescription	API バージョンの説明。
apiVersionSetId	関連する ApiVersionSet のリソース識別子。
authenticationSettings	この API に含まれる認証設定のコレクション。
contact	API の連絡先情報。
description	API の説明。 HTML 書式設定タグを含めることができます。
displayName	API 名。
isCurrent	API リビジョンが現在の API リビジョンであるかどうかを示します。
isOnline	API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
license	API のライセンス情報。
path	この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
protocols	この API の操作を呼び出すことができるプロトコルについて説明します。
serviceUrl	この API を実装するバックエンド サービスの絶対 URL。
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。
subscriptionRequired	API にアクセスするために API サブスクリプションまたは製品サブスクリプションが必要かどうかを指定します。
termsOfServiceUrl	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

プロパティ値

AuthenticationSettingsContract

contact

API の連絡先情報。

contact?: ApiContactInformation

プロパティ値

ApiContactInformation

description

API の説明。 HTML 書式設定タグを含めることができます。

description?: string

プロパティ値

string

displayName

API 名。

displayName?: string

プロパティ値

string

isCurrent

API リビジョンが現在の API リビジョンであるかどうかを示します。

isCurrent?: boolean

プロパティ値

boolean

isOnline

API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

isOnline?: boolean

プロパティ値

boolean

license

API のライセンス情報。

license?: ApiLicenseInformation

プロパティ値

ApiLicenseInformation

path

この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。

path?: string

プロパティ値

string

protocols

この API の操作を呼び出すことができるプロトコルについて説明します。

protocols?: string[]

プロパティ値

string[]

serviceUrl

この API を実装するバックエンド サービスの絶対 URL。

serviceUrl?: string

プロパティ値

string

subscriptionKeyParameterNames

API を使用できるようにするプロトコル。

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

プロパティ値

SubscriptionKeyParameterNamesContract

subscriptionRequired

API にアクセスするために API サブスクリプションまたは製品サブスクリプションが必要かどうかを指定します。

subscriptionRequired?: boolean

プロパティ値

boolean

termsOfServiceUrl

API のサービス利用規約への URL。 URL の形式にする必要があります。

termsOfServiceUrl?: string

プロパティ値

string