ApiTagResourceContractProperties interface

パッケージ:

@azure/arm-apimanagement

タグ リソースの API コントラクト プロパティ。

Extends

ApiEntityBaseContract

プロパティ

id	/apis/{apiId} という形式の API 識別子。
name	API 名。
path	API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
protocols	この API の操作を呼び出すことができるプロトコルを記述します。
serviceUrl	この API を実装するバックエンド サービスの絶対 URL。

継承されたプロパティ

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 の形式にする必要があります。

プロパティの詳細

id

/apis/{apiId} という形式の API 識別子。

id?: string

プロパティ値

string

name

API 名。

name?: string

プロパティ値

string

path

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

path?: string

プロパティ値

string

protocols

この API の操作を呼び出すことができるプロトコルを記述します。

protocols?: string[]

プロパティ値

string[]

serviceUrl

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

serviceUrl?: 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から継承