次の方法で共有

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

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

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

この API を実装するバックエンド サービスの絶対 URL。 2,000 文字を超えることはできません。
soapApiType

作成する API の種類。

  • http REST API を作成する
  • soap SOAP パススルー API を作成する
  • websocket websocket API を作成する
  • graphqlは API GraphQL作成します。
sourceApiId

ソース API の API 識別子。
subscriptionKeyParameterNames

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

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

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

path?: string

プロパティ値

string

protocols

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

protocols?: string[]

プロパティ値

string[]

serviceUrl

この API を実装するバックエンド サービスの絶対 URL。 2,000 文字を超えることはできません。

serviceUrl?: string

プロパティ値

string

soapApiType

作成する API の種類。

  • http REST API を作成する
  • soap SOAP パススルー API を作成する
  • websocket websocket API を作成する
  • graphqlは API GraphQL作成します。
soapApiType?: string

プロパティ値

string

sourceApiId

ソース API の API 識別子。

sourceApiId?: string

プロパティ値

string

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

プロパティ値

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

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