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