Delen via

ApiContractProperties interface

  • Referentie
Pakket:
@azure/arm-apimanagement

Eigenschappen van API-entiteit

Uitbreiding
ApiEntityBaseContract

Eigenschappen

apiVersionSet

Details van versieset
displayName

API-naam. Moet 1 tot 300 tekens lang zijn.
path

Relatieve URL die deze API en alle bijbehorende resourcepaden in het API Management service-exemplaar uniek identificeert. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen.
protocols

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
serviceUrl

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.
sourceApiId

API-id van de bron-API.

Overgenomen eigenschappen

apiRevision

Beschrijft de revisie van de API. Als er geen waarde wordt opgegeven, wordt standaardrevisie 1 gemaakt
apiRevisionDescription

Beschrijving van de API-revisie.
apiType

Type of API.
apiVersion

Geeft de versie-id van de API aan als er versieversies van de API zijn
apiVersionDescription

Beschrijving van de API-versie.
apiVersionSetId

Een resource-id voor de gerelateerde ApiVersionSet.
authenticationSettings

Verzameling van verificatie-instellingen die zijn opgenomen in deze API.
contact

Contactgegevens voor de API.
description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.
isCurrent

Geeft aan of API-revisie de huidige API-revisie is.
isOnline

Geeft aan of API-revisie toegankelijk is via de gateway. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
license

Licentiegegevens voor de API.
subscriptionKeyParameterNames

Protocollen waarvoor DE API beschikbaar wordt gesteld.
subscriptionRequired

Hiermee geeft u op of een API- of productabonnement is vereist voor toegang tot de API.
termsOfServiceUrl

Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.

Eigenschapdetails

apiVersionSet

Details van versieset

apiVersionSet?: ApiVersionSetContractDetails

Waarde van eigenschap

ApiVersionSetContractDetails

displayName

API-naam. Moet 1 tot 300 tekens lang zijn.

displayName?: string

Waarde van eigenschap

string

path

Relatieve URL die deze API en alle bijbehorende resourcepaden in het API Management service-exemplaar uniek identificeert. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen.

path: string

Waarde van eigenschap

string

protocols

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

protocols?: string[]

Waarde van eigenschap

string[]

serviceUrl

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.

serviceUrl?: string

Waarde van eigenschap

string

sourceApiId

API-id van de bron-API.

sourceApiId?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

apiRevision

Beschrijft de revisie van de API. Als er geen waarde wordt opgegeven, wordt standaardrevisie 1 gemaakt

apiRevision?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.apiRevision

apiRevisionDescription

Beschrijving van de API-revisie.

apiRevisionDescription?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.apiRevisionDescription

apiType

Type of API.

apiType?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.apiType

apiVersion

Geeft de versie-id van de API aan als er versieversies van de API zijn

apiVersion?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.apiVersion

apiVersionDescription

Beschrijving van de API-versie.

apiVersionDescription?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Een resource-id voor de gerelateerde ApiVersionSet.

apiVersionSetId?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.apiVersionSetId

authenticationSettings

Verzameling van verificatie-instellingen die zijn opgenomen in deze API.

authenticationSettings?: AuthenticationSettingsContract

Waarde van eigenschap

AuthenticationSettingsContract

Overgenomen vanApiEntityBaseContract.authenticationSettings

contact

Contactgegevens voor de API.

contact?: ApiContactInformation

Waarde van eigenschap

ApiContactInformation

Overgenomen vanApiEntityBaseContract.contact

description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

description?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.description

isCurrent

Geeft aan of API-revisie de huidige API-revisie is.

isCurrent?: boolean

Waarde van eigenschap

boolean

Overgenomen vanApiEntityBaseContract.isCurrent

isOnline

Geeft aan of API-revisie toegankelijk is via de gateway. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

isOnline?: boolean

Waarde van eigenschap

boolean

Overgenomen vanApiEntityBaseContract.isOnline

license

Licentiegegevens voor de API.

license?: ApiLicenseInformation

Waarde van eigenschap

ApiLicenseInformation

Overgenomen vanApiEntityBaseContract.license

subscriptionKeyParameterNames

Protocollen waarvoor DE API beschikbaar wordt gesteld.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Waarde van eigenschap

SubscriptionKeyParameterNamesContract

Overgenomen vanApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

Hiermee geeft u op of een API- of productabonnement is vereist voor toegang tot de API.

subscriptionRequired?: boolean

Waarde van eigenschap

boolean

Overgenomen vanApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.

termsOfServiceUrl?: string

Waarde van eigenschap

string

Overgenomen vanApiEntityBaseContract.termsOfServiceUrl