Condividi tramite

ApiCreateOrUpdateProperties interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Creazione o aggiornamento delle proprietà dell'API.

Extends
ApiContractProperties

Proprietà

format

Formato del contenuto in cui viene importata l'API.
soapApiType

Tipo di API da creare.

  • http crea un'API REST
  • soap crea un'API pass-through SOAP
  • websocket crea l'API Websocket
  • graphql crea l'API GraphQL.
translateRequiredQueryParametersConduct

Strategia di conversione dei parametri di query necessari in quelli del modello. Per impostazione predefinita, il valore 'template'. Valori possibili: 'template', 'query'
value

Valore del contenuto durante l'importazione di un'API.
wsdlSelector

Criteri per limitare l'importazione di WSDL a un subset del documento.

Proprietà ereditate

apiRevision

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1
apiRevisionDescription

Descrizione della revisione DELL'API.
apiType

Tipo di API.
apiVersion

Indica l'identificatore della versione dell'API se l'API è in versione
apiVersionDescription

Descrizione della versione dell'API.
apiVersionSet

Dettagli del set di versioni
apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.
authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.
contact

Informazioni di contatto per l'API.
description

Descrizione dell'API. Può includere tag di formattazione HTML.
displayName

Nome API. Deve contenere da 1 a 300 caratteri.
isCurrent

Indica se la revisione dell'API è la revisione api corrente.
isOnline

Indica se la revisione dell'API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
license

Informazioni sulla licenza per l'API.
path

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.
protocols

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.
serviceUrl

URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.
sourceApiId

Identificatore API dell'API di origine.
subscriptionKeyParameterNames

Protocolli su cui viene resa disponibile l'API.
subscriptionRequired

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.
termsOfServiceUrl

URL delle Condizioni per il servizio per l'API. DEVE essere nel formato di un URL.

Dettagli proprietà

format

Formato del contenuto in cui viene importata l'API.

format?: string

Valore della proprietà

string

soapApiType

Tipo di API da creare.

  • http crea un'API REST
  • soap crea un'API pass-through SOAP
  • websocket crea l'API Websocket
  • graphql crea l'API GraphQL.
soapApiType?: string

Valore della proprietà

string

translateRequiredQueryParametersConduct

Strategia di conversione dei parametri di query necessari in quelli del modello. Per impostazione predefinita, il valore 'template'. Valori possibili: 'template', 'query'

translateRequiredQueryParametersConduct?: string

Valore della proprietà

string

value

Valore del contenuto durante l'importazione di un'API.

value?: string

Valore della proprietà

string

wsdlSelector

Criteri per limitare l'importazione di WSDL a un subset del documento.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Valore della proprietà

ApiCreateOrUpdatePropertiesWsdlSelector

Dettagli proprietà ereditate

apiRevision

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

apiRevision?: string

Valore della proprietà

string

Ereditato daApiContractProperties.apiRevision

apiRevisionDescription

Descrizione della revisione DELL'API.

apiRevisionDescription?: string

Valore della proprietà

string

Ereditato daApiContractProperties.apiRevisionDescription

apiType

Tipo di API.

apiType?: string

Valore della proprietà

string

Ereditato daApiContractProperties.apiType

apiVersion

Indica l'identificatore della versione dell'API se l'API è in versione

apiVersion?: string

Valore della proprietà

string

Ereditato daApiContractProperties.apiVersion

apiVersionDescription

Descrizione della versione dell'API.

apiVersionDescription?: string

Valore della proprietà

string

Ereditato daApiContractProperties.apiVersionDescription

apiVersionSet

Dettagli del set di versioni

apiVersionSet?: ApiVersionSetContractDetails

Valore della proprietà

ApiVersionSetContractDetails

Ereditato daApiContractProperties.apiVersionSet

apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.

apiVersionSetId?: string

Valore della proprietà

string

Ereditato daApiContractProperties.apiVersionSetId

authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.

authenticationSettings?: AuthenticationSettingsContract

Valore della proprietà

AuthenticationSettingsContract

Ereditato daApiContractProperties.authenticationSettings

contact

Informazioni di contatto per l'API.

contact?: ApiContactInformation

Valore della proprietà

ApiContactInformation

Ereditato daApiContractProperties.contact

description

Descrizione dell'API. Può includere tag di formattazione HTML.

description?: string

Valore della proprietà

string

Ereditato daApiContractProperties.description

displayName

Nome API. Deve contenere da 1 a 300 caratteri.

displayName?: string

Valore della proprietà

string

Ereditato daApiContractProperties.displayName

isCurrent

Indica se la revisione dell'API è la revisione api corrente.

isCurrent?: boolean

Valore della proprietà

boolean

Ereditato daApiContractProperties.isCurrent

isOnline

Indica se la revisione dell'API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

isOnline?: boolean

Valore della proprietà

boolean

Ereditato daApiContractProperties.isOnline

license

Informazioni sulla licenza per l'API.

license?: ApiLicenseInformation

Valore della proprietà

ApiLicenseInformation

Ereditato daApiContractProperties.license

path

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.

path: string

Valore della proprietà

string

Ereditato daApiContractProperties.path

protocols

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

protocols?: string[]

Valore della proprietà

string[]

Ereditato daApiContractProperties.protocols

serviceUrl

URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.

serviceUrl?: string

Valore della proprietà

string

Ereditato daApiContractProperties.serviceUrl

sourceApiId

Identificatore API dell'API di origine.

sourceApiId?: string

Valore della proprietà

string

Ereditato daApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocolli su cui viene resa disponibile l'API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valore della proprietà

SubscriptionKeyParameterNamesContract

Ereditato daApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

subscriptionRequired?: boolean

Valore della proprietà

boolean

Ereditato daApiContractProperties.subscriptionRequired

termsOfServiceUrl

URL delle Condizioni per il servizio per l'API. DEVE essere nel formato di un URL.

termsOfServiceUrl?: string

Valore della proprietà

string

Ereditato daApiContractProperties.termsOfServiceUrl