Delen via

ApiCreateOrUpdateProperties interface

  • Referentie
Pakket:
@azure/arm-apimanagement

API-eigenschappen maken of bijwerken.

Uitbreiding
ApiContractProperties

Eigenschappen

format

Indeling van de inhoud waarin de API wordt geïmporteerd.
soapApiType

Type API dat moet worden gemaakt.

  • http maakt een REST API
  • soap maakt een SOAP-passthrough-API
  • websocket maakt websocket-API
  • graphql maakt GraphQL API.
translateRequiredQueryParametersConduct

Strategie voor het vertalen van vereiste queryparameters naar sjabloonparameters. Heeft standaard de waarde 'sjabloon'. Mogelijke waarden: 'template', 'query'
value

Inhoudswaarde bij het importeren van een API.
wsdlSelector

Criteria om het importeren van WSDL te beperken tot een subset van het document.

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.
apiVersionSet

Details van versieset
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.
displayName

API-naam. Moet 1 tot 300 tekens lang zijn.
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.
path

Relatieve URL die deze API en alle resourcepaden binnen 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

Hierin wordt beschreven op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
serviceUrl

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

API-id van de bron-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

format

Indeling van de inhoud waarin de API wordt geïmporteerd.

format?: string

Waarde van eigenschap

string

soapApiType

Type API dat moet worden gemaakt.

  • http maakt een REST API
  • soap maakt een SOAP-passthrough-API
  • websocket maakt websocket-API
  • graphql maakt GraphQL API.
soapApiType?: string

Waarde van eigenschap

string

translateRequiredQueryParametersConduct

Strategie voor het vertalen van vereiste queryparameters naar sjabloonparameters. Heeft standaard de waarde 'sjabloon'. Mogelijke waarden: 'template', 'query'

translateRequiredQueryParametersConduct?: string

Waarde van eigenschap

string

value

Inhoudswaarde bij het importeren van een API.

value?: string

Waarde van eigenschap

string

wsdlSelector

Criteria om het importeren van WSDL te beperken tot een subset van het document.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Waarde van eigenschap

ApiCreateOrUpdatePropertiesWsdlSelector

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 vanApiContractProperties.apiRevision

apiRevisionDescription

Beschrijving van de API-revisie.

apiRevisionDescription?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.apiRevisionDescription

apiType

Type of API.

apiType?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.apiType

apiVersion

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

apiVersion?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.apiVersion

apiVersionDescription

Beschrijving van de API-versie.

apiVersionDescription?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.apiVersionDescription

apiVersionSet

Details van versieset

apiVersionSet?: ApiVersionSetContractDetails

Waarde van eigenschap

ApiVersionSetContractDetails

Overgenomen vanApiContractProperties.apiVersionSet

apiVersionSetId

Een resource-id voor de gerelateerde ApiVersionSet.

apiVersionSetId?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Waarde van eigenschap

AuthenticationSettingsContract

Overgenomen vanApiContractProperties.authenticationSettings

contact

Contactgegevens voor de API.

contact?: ApiContactInformation

Waarde van eigenschap

ApiContactInformation

Overgenomen vanApiContractProperties.contact

description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

description?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.description

displayName

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

displayName?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.displayName

isCurrent

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

isCurrent?: boolean

Waarde van eigenschap

boolean

Overgenomen vanApiContractProperties.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 vanApiContractProperties.isOnline

license

Licentiegegevens voor de API.

license?: ApiLicenseInformation

Waarde van eigenschap

ApiLicenseInformation

Overgenomen vanApiContractProperties.license

path

Relatieve URL die deze API en alle resourcepaden binnen 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

Overgenomen vanApiContractProperties.path

protocols

Hierin wordt beschreven op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

protocols?: string[]

Waarde van eigenschap

string[]

Overgenomen vanApiContractProperties.protocols

serviceUrl

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

serviceUrl?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.serviceUrl

sourceApiId

API-id van de bron-API.

sourceApiId?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocollen waarvoor DE API beschikbaar wordt gesteld.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Waarde van eigenschap

SubscriptionKeyParameterNamesContract

Overgenomen vanApiContractProperties.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 vanApiContractProperties.subscriptionRequired

termsOfServiceUrl

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

termsOfServiceUrl?: string

Waarde van eigenschap

string

Overgenomen vanApiContractProperties.termsOfServiceUrl