Compartir a través de


ApiCreateOrUpdateProperties interface

API Crear o actualizar propiedades.

Extends

Propiedades

format

Formato del contenido en el que se importa la API.

soapApiType

Tipo de API que se va a crear.

  • http crea una API REST
  • soap crea una API de paso a través de SOAP
  • websocket crea websocket API
  • graphql crea GraphQL API.
translateRequiredQueryParametersConduct

Estrategia para traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'

value

Valor de contenido al importar una API.

wsdlSelector

Criterios para limitar la importación de WSDL a un subconjunto del documento.

Propiedades heredadas

apiRevision

Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión predeterminada 1.

apiRevisionDescription

Descripción de la revisión de la API.

apiType

Tipo de API.

apiVersion

Indica el identificador de versión de la API si la API tiene versiones

apiVersionDescription

Descripción de la versión de la API.

apiVersionSet

Detalles del conjunto de versiones

apiVersionSetId

Identificador de recurso para apiVersionSet relacionado.

authenticationSettings

Recopilación de la configuración de autenticación incluida en esta API.

contact

Información de contacto de la API.

description

Descripción de la API. Puede incluir etiquetas de formato HTML.

displayName

Nombre de la API. Debe tener entre 1 y 300 caracteres.

isCurrent

Indica si la revisión de la API es la revisión de api actual.

isOnline

Indica si se puede acceder a la revisión de la API a través de la puerta de enlace. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

license

Información de licencia de la API.

path

Dirección URL relativa que identifica de forma única esta API y todas las rutas de acceso a sus recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API que se especificó durante la creación de la instancia de servicio para formar una dirección URL pública para esta API.

protocols

Describe en qué protocolos se pueden invocar las operaciones en esta API.

serviceUrl

Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.

sourceApiId

Identificador de API de la API de origen.

subscriptionKeyParameterNames

Protocolos sobre los que está disponible la API.

subscriptionRequired

Especifica si se requiere una suscripción de API o Producto para acceder a la API.

termsOfServiceUrl

Una dirección URL a los Términos de servicio de la API. DEBE tener el formato de una dirección URL.

Detalles de las propiedades

format

Formato del contenido en el que se importa la API.

format?: string

Valor de propiedad

string

soapApiType

Tipo de API que se va a crear.

  • http crea una API REST
  • soap crea una API de paso a través de SOAP
  • websocket crea websocket API
  • graphql crea GraphQL API.
soapApiType?: string

Valor de propiedad

string

translateRequiredQueryParametersConduct

Estrategia para traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'

translateRequiredQueryParametersConduct?: string

Valor de propiedad

string

value

Valor de contenido al importar una API.

value?: string

Valor de propiedad

string

wsdlSelector

Criterios para limitar la importación de WSDL a un subconjunto del documento.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Valor de propiedad

Detalles de las propiedades heredadas

apiRevision

Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión predeterminada 1.

apiRevision?: string

Valor de propiedad

string

Heredado deApiContractProperties.apiRevision

apiRevisionDescription

Descripción de la revisión de la API.

apiRevisionDescription?: string

Valor de propiedad

string

Heredado deApiContractProperties.apiRevisionDescription

apiType

Tipo de API.

apiType?: string

Valor de propiedad

string

Heredado deApiContractProperties.apiType

apiVersion

Indica el identificador de versión de la API si la API tiene versiones

apiVersion?: string

Valor de propiedad

string

Heredado deApiContractProperties.apiVersion

apiVersionDescription

Descripción de la versión de la API.

apiVersionDescription?: string

Valor de propiedad

string

Heredado deApiContractProperties.apiVersionDescription

apiVersionSet

Detalles del conjunto de versiones

apiVersionSet?: ApiVersionSetContractDetails

Valor de propiedad

Heredado deApiContractProperties.apiVersionSet

apiVersionSetId

Identificador de recurso para apiVersionSet relacionado.

apiVersionSetId?: string

Valor de propiedad

string

Heredado deApiContractProperties.apiVersionSetId

authenticationSettings

Recopilación de la configuración de autenticación incluida en esta API.

authenticationSettings?: AuthenticationSettingsContract

Valor de propiedad

Heredado deApiContractProperties.authenticationSettings

contact

Información de contacto de la API.

contact?: ApiContactInformation

Valor de propiedad

Heredado deApiContractProperties.contact

description

Descripción de la API. Puede incluir etiquetas de formato HTML.

description?: string

Valor de propiedad

string

Heredado deApiContractProperties.description

displayName

Nombre de la API. Debe tener entre 1 y 300 caracteres.

displayName?: string

Valor de propiedad

string

Heredado deApiContractProperties.displayName

isCurrent

Indica si la revisión de la API es la revisión de api actual.

isCurrent?: boolean

Valor de propiedad

boolean

Heredado deApiContractProperties.isCurrent

isOnline

Indica si se puede acceder a la revisión de la API a través de la puerta de enlace. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

isOnline?: boolean

Valor de propiedad

boolean

Heredado deApiContractProperties.isOnline

license

Información de licencia de la API.

license?: ApiLicenseInformation

Valor de propiedad

Heredado deApiContractProperties.license

path

Dirección URL relativa que identifica de forma única esta API y todas las rutas de acceso a sus recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API que se especificó durante la creación de la instancia de servicio para formar una dirección URL pública para esta API.

path: string

Valor de propiedad

string

Heredado deApiContractProperties.path

protocols

Describe en qué protocolos se pueden invocar las operaciones en esta API.

protocols?: string[]

Valor de propiedad

string[]

Heredado deApiContractProperties.protocols

serviceUrl

Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.

serviceUrl?: string

Valor de propiedad

string

Heredado deApiContractProperties.serviceUrl

sourceApiId

Identificador de API de la API de origen.

sourceApiId?: string

Valor de propiedad

string

Heredado deApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocolos sobre los que está disponible la API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor de propiedad

Se hereda deApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

Especifica si se requiere una suscripción de API o Producto para acceder a la API.

subscriptionRequired?: boolean

Valor de propiedad

boolean

Se hereda deApiContractProperties.subscriptionRequired

termsOfServiceUrl

Una dirección URL a los Términos de servicio de la API. DEBE tener el formato de una dirección URL.

termsOfServiceUrl?: string

Valor de propiedad

string

Heredado deApiContractProperties.termsOfServiceUrl