Compartir a través de

ApiContractProperties interface

  • Referencia
Paquete:
@azure/arm-apimanagement

Propiedades de entidad de API

Extends
ApiEntityBaseContract

Propiedades

apiVersionSet

Detalles del conjunto de versiones
displayName

Nombre de la API. Debe tener entre 1 y 300 caracteres.
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 de longitud.
sourceApiId

Identificador de API de la API de origen.

Propiedades heredadas

apiRevision

Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada.
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.
apiVersionSetId

Identificador de recurso para apiVersionSet relacionado.
authenticationSettings

Colección de opciones de configuración de autenticación incluidas en esta API.
contact

Información de contacto de la API.
description

Descripción de la API. Puede incluir etiquetas de formato HTML.
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.
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

apiVersionSet

Detalles del conjunto de versiones

apiVersionSet?: ApiVersionSetContractDetails

Valor de propiedad

ApiVersionSetContractDetails

displayName

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

displayName?: string

Valor de propiedad

string

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

protocols

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

protocols?: string[]

Valor de propiedad

string[]

serviceUrl

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

serviceUrl?: string

Valor de propiedad

string

sourceApiId

Identificador de API de la API de origen.

sourceApiId?: string

Valor de propiedad

string

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 1 predeterminada.

apiRevision?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.apiRevision

apiRevisionDescription

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

apiRevisionDescription?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.apiRevisionDescription

apiType

Tipo de API.

apiType?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.apiVersion

apiVersionDescription

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

apiVersionDescription?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Identificador de recurso para apiVersionSet relacionado.

apiVersionSetId?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.apiVersionSetId

authenticationSettings

Colección de opciones de configuración de autenticación incluidas en esta API.

authenticationSettings?: AuthenticationSettingsContract

Valor de propiedad

AuthenticationSettingsContract

Heredado deApiEntityBaseContract.authenticationSettings

contact

Información de contacto de la API.

contact?: ApiContactInformation

Valor de propiedad

ApiContactInformation

Heredado deApiEntityBaseContract.contact

description

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

description?: string

Valor de propiedad

string

Heredado deApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Valor de propiedad

boolean

Heredado deApiEntityBaseContract.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 deApiEntityBaseContract.isOnline

license

Información de licencia de la API.

license?: ApiLicenseInformation

Valor de propiedad

ApiLicenseInformation

Heredado deApiEntityBaseContract.license

subscriptionKeyParameterNames

Protocolos sobre los que está disponible la API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor de propiedad

SubscriptionKeyParameterNamesContract

Heredado deApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valor de propiedad

boolean

Heredado deApiEntityBaseContract.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 deApiEntityBaseContract.termsOfServiceUrl