ApiEntityBaseContract interface

Paket:

@azure/arm-apimanagement

Information om API-baskontrakt.

Egenskaper

apiRevision	Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1
apiRevisionDescription	Beskrivning av API Revision.
apiType	Typ av API.
apiVersion	Anger versionsidentifieraren för API:et om API:et är versionshanterat
apiVersionDescription	Beskrivning av API-versionen.
apiVersionSetId	En resursidentifierare för den relaterade ApiVersionSet.
authenticationSettings	Samling autentiseringsinställningar som ingår i det här API:et.
contact	Kontaktuppgifter för API:et.
description	Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
isCurrent	Anger om API-revision är aktuell API-revision.
isOnline	Anger om API-revisionen är tillgänglig via gatewayen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
license	Licensinformation för API:et.
subscriptionKeyParameterNames	Protokoll över vilka API:et görs tillgängligt.
subscriptionRequired	Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.
termsOfServiceUrl	En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL.

Egenskapsinformation

apiRevision

Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1

apiRevision?: string

Egenskapsvärde

string

apiRevisionDescription

Beskrivning av API Revision.

apiRevisionDescription?: string

Egenskapsvärde

string

apiType

Typ av API.

apiType?: string

Egenskapsvärde

string

apiVersion

Anger versionsidentifieraren för API:et om API:et är versionshanterat

apiVersion?: string

Egenskapsvärde

string

apiVersionDescription

Beskrivning av API-versionen.

apiVersionDescription?: string

Egenskapsvärde

string

apiVersionSetId

En resursidentifierare för den relaterade ApiVersionSet.

apiVersionSetId?: string

Egenskapsvärde

string

authenticationSettings

Samling autentiseringsinställningar som ingår i det här API:et.

authenticationSettings?: AuthenticationSettingsContract

Egenskapsvärde

AuthenticationSettingsContract

contact

Kontaktuppgifter för API:et.

contact?: ApiContactInformation

Egenskapsvärde

ApiContactInformation

description

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

description?: string

Egenskapsvärde

string

isCurrent

Anger om API-revision är aktuell API-revision.

isCurrent?: boolean

Egenskapsvärde

boolean

isOnline

Anger om API-revisionen är tillgänglig via gatewayen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

isOnline?: boolean

Egenskapsvärde

boolean

license

Licensinformation för API:et.

license?: ApiLicenseInformation

Egenskapsvärde

ApiLicenseInformation

subscriptionKeyParameterNames

Protokoll över vilka API:et görs tillgängligt.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Egenskapsvärde

SubscriptionKeyParameterNamesContract

subscriptionRequired

Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.

subscriptionRequired?: boolean

Egenskapsvärde

boolean

termsOfServiceUrl

En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL.

termsOfServiceUrl?: string

Egenskapsvärde

string