Compartir a través de

ApiEntityBaseContract interface

  • Referencia
Paquete:
@azure/arm-apimanagement

Detalles del contrato base de API.

Propiedades

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 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 API es la revisión de API actual.
isOnline

Indica si la revisión de API es accesible 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 del servicio para la API. DEBE estar en el formato de una dirección URL.

Detalles de las propiedades

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

apiRevisionDescription

Descripción de la revisión de API.

apiRevisionDescription?: string

Valor de propiedad

string

apiType

Tipo de API.

apiType?: string

Valor de propiedad

string

apiVersion

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

apiVersion?: string

Valor de propiedad

string

apiVersionDescription

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

apiVersionDescription?: string

Valor de propiedad

string

apiVersionSetId

Identificador de recurso para apiVersionSet relacionado.

apiVersionSetId?: string

Valor de propiedad

string

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valor de propiedad

AuthenticationSettingsContract

contact

Información de contacto de la API.

contact?: ApiContactInformation

Valor de propiedad

ApiContactInformation

description

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

description?: string

Valor de propiedad

string

isCurrent

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

isCurrent?: boolean

Valor de propiedad

boolean

isOnline

Indica si la revisión de API es accesible 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

license

Información de licencia de la API.

license?: ApiLicenseInformation

Valor de propiedad

ApiLicenseInformation

subscriptionKeyParameterNames

Protocolos sobre los que está disponible la API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor de propiedad

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

Valor de propiedad

boolean

termsOfServiceUrl

Una dirección URL a los Términos del servicio para la API. DEBE estar en el formato de una dirección URL.

termsOfServiceUrl?: string

Valor de propiedad

string