ApiCreateOrUpdateProperties interface

Paket:

@azure/arm-apimanagement

API Skapa eller uppdatera egenskaper.

Extends

ApiContractProperties

Egenskaper

format	Format för det innehåll där API:et importeras.
soapApiType	Typ av API som ska skapas. http skapar ett REST-API soap skapar ett SOAP-API för direktströmning websocket skapar websocket-API graphql skapar GraphQL API.
translateRequiredQueryParametersConduct	Strategi för att översätta obligatoriska frågeparametrar till mallparametrar. Som standard har värdet "mall". Möjliga värden: "mall", "fråga"
value	Innehållsvärde vid import av ett API.
wsdlSelector	Villkor för att begränsa importen av WSDL till en delmängd av dokumentet.

Ärvda 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.
apiVersionSet	Information om versionsuppsättning
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.
displayName	API-namn. Måste vara mellan 1 och 300 tecken långt.
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.
path	Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
protocols	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
serviceUrl	Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.
sourceApiId	API-identifierare för käll-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

format

Format för det innehåll där API:et importeras.

format?: string

Egenskapsvärde

string

soapApiType

Typ av API som ska skapas.

• http skapar ett REST-API
• soap skapar ett SOAP-API för direktströmning
• websocket skapar websocket-API
• graphql skapar GraphQL API.

soapApiType?: string

Egenskapsvärde

string

translateRequiredQueryParametersConduct

Strategi för att översätta obligatoriska frågeparametrar till mallparametrar. Som standard har värdet "mall". Möjliga värden: "mall", "fråga"

translateRequiredQueryParametersConduct?: string

Egenskapsvärde

string

value

Innehållsvärde vid import av ett API.

value?: string

Egenskapsvärde

string

wsdlSelector

Villkor för att begränsa importen av WSDL till en delmängd av dokumentet.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Egenskapsvärde

ApiCreateOrUpdatePropertiesWsdlSelector

Information om ärvda egenskaper

apiRevision

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

apiRevision?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.apiRevision

apiRevisionDescription

Beskrivning av API Revision.

apiRevisionDescription?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.apiRevisionDescription

apiType

Typ av API.

apiType?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.apiType

apiVersion

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

apiVersion?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.apiVersion

apiVersionDescription

Beskrivning av API-versionen.

apiVersionDescription?: string

Egenskapsvärde

string

Ärvt frånApiContractProperties.apiVersionDescription

apiVersionSet

Information om versionsuppsättning

apiVersionSet?: ApiVersionSetContractDetails

Egenskapsvärde

ApiVersionSetContractDetails

Ärvt frånApiContractProperties.apiVersionSet

apiVersionSetId

En resursidentifierare för den relaterade ApiVersionSet.

apiVersionSetId?: string

Egenskapsvärde

string

Ärvt frånApiContractProperties.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Egenskapsvärde

AuthenticationSettingsContract

Ärvd frånApiContractProperties.authenticationSettings

contact

Kontaktuppgifter för API:et.

contact?: ApiContactInformation

Egenskapsvärde

ApiContactInformation

Ärvd frånApiContractProperties.contact

description

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

description?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.description

displayName

API-namn. Måste vara mellan 1 och 300 tecken långt.

displayName?: string

Egenskapsvärde

string

Ärvt frånApiContractProperties.displayName

isCurrent

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

isCurrent?: boolean

Egenskapsvärde

boolean

Ärvd frånApiContractProperties.isCurrent

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

Ärvd frånApiContractProperties.isOnline

license

Licensinformation för API:et.

license?: ApiLicenseInformation

Egenskapsvärde

ApiLicenseInformation

Ärvd frånApiContractProperties.license

path

Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.

path: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.path

protocols

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

protocols?: string[]

Egenskapsvärde

string[]

Ärvt frånApiContractProperties.protocols

serviceUrl

Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.

serviceUrl?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.serviceUrl

sourceApiId

API-identifierare för käll-API:et.

sourceApiId?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.sourceApiId

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Egenskapsvärde

SubscriptionKeyParameterNamesContract

Ärvd frånApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Egenskapsvärde

boolean

Ärvd frånApiContractProperties.subscriptionRequired

termsOfServiceUrl

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

termsOfServiceUrl?: string

Egenskapsvärde

string

Ärvd frånApiContractProperties.termsOfServiceUrl