ApiCreateOrUpdateProperties interface
API の作成または更新のプロパティ。
- Extends
プロパティ
format | API がインポートされるコンテンツの形式。 |
soap |
作成する API の種類。
|
translate |
必要なクエリ パラメーターをテンプレートに変換する戦略。 既定では、値は 'template' です。 使用可能な値: 'template'、'query' |
value | API のインポート時のコンテンツ値。 |
wsdl |
WSDL のインポートをドキュメントのサブセットに制限する条件。 |
継承されたプロパティ
api |
API のリビジョンについて説明します。 値が指定されていない場合、既定のリビジョン 1 が作成されます |
api |
API リビジョンの説明。 |
api |
API の種類。 |
api |
API がバージョン管理されている場合の API のバージョン識別子を示します |
api |
API バージョンの説明。 |
api |
バージョン セットの詳細 |
api |
関連する ApiVersionSet のリソース識別子。 |
authentication |
この API に含まれる認証設定のコレクション。 |
contact | API の連絡先情報。 |
description | API の説明。 HTML 書式設定タグを含めることができます。 |
display |
API 名。 1 から 300 文字の長さにする必要があります。 |
is |
API リビジョンが現在の API リビジョンであるかどうかを示します。 |
is |
API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
license | API のライセンス情報。 |
path | API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。 |
protocols | この API の操作を呼び出すことができるプロトコルを記述します。 |
service |
この API を実装するバックエンド サービスの絶対 URL。 2,000 文字を超えることはできません。 |
source |
ソース API の API 識別子。 |
subscription |
API を使用できるようにするプロトコル。 |
subscription |
API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。 |
terms |
API のサービス利用規約への URL。 URL の形式にする必要があります。 |
プロパティの詳細
format
API がインポートされるコンテンツの形式。
format?: string
プロパティ値
string
soapApiType
作成する API の種類。
-
http
REST API を作成する -
soap
SOAP パススルー API を作成する -
websocket
websocket API を作成する -
graphql
は API GraphQL作成します。
soapApiType?: string
プロパティ値
string
translateRequiredQueryParametersConduct
必要なクエリ パラメーターをテンプレートに変換する戦略。 既定では、値は 'template' です。 使用可能な値: 'template'、'query'
translateRequiredQueryParametersConduct?: string
プロパティ値
string
value
API のインポート時のコンテンツ値。
value?: string
プロパティ値
string
wsdlSelector
WSDL のインポートをドキュメントのサブセットに制限する条件。
wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector
プロパティ値
継承されたプロパティの詳細
apiRevision
API のリビジョンについて説明します。 値が指定されていない場合、既定のリビジョン 1 が作成されます
apiRevision?: string
プロパティ値
string
apiRevisionDescription
API リビジョンの説明。
apiRevisionDescription?: string
プロパティ値
string
apiType
apiVersion
API がバージョン管理されている場合の API のバージョン識別子を示します
apiVersion?: string
プロパティ値
string
apiVersionDescription
API バージョンの説明。
apiVersionDescription?: string
プロパティ値
string
apiVersionSet
バージョン セットの詳細
apiVersionSet?: ApiVersionSetContractDetails
プロパティ値
apiVersionSetId
関連する ApiVersionSet のリソース識別子。
apiVersionSetId?: string
プロパティ値
string
authenticationSettings
この API に含まれる認証設定のコレクション。
authenticationSettings?: AuthenticationSettingsContract
プロパティ値
contact
API の連絡先情報。
contact?: ApiContactInformation
プロパティ値
description
API の説明。 HTML 書式設定タグを含めることができます。
description?: string
プロパティ値
string
displayName
API 名。 1 から 300 文字の長さにする必要があります。
displayName?: string
プロパティ値
string
isCurrent
API リビジョンが現在の API リビジョンであるかどうかを示します。
isCurrent?: boolean
プロパティ値
boolean
isOnline
API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
isOnline?: boolean
プロパティ値
boolean
license
API のライセンス情報。
license?: 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
sourceApiId
subscriptionKeyParameterNames
API を使用できるようにするプロトコル。
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract
プロパティ値
subscriptionRequired
API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。
subscriptionRequired?: boolean
プロパティ値
boolean
termsOfServiceUrl
API のサービス利用規約への URL。 URL の形式にする必要があります。
termsOfServiceUrl?: string
プロパティ値
string