Compartir a través de

ApiContract interface

  • Referencia
Paquete:
@azure/arm-apimanagement

Detalles de la API.

Extends
ProxyResource

Propiedades

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.

Propiedades heredadas

id

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

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

apiRevisionDescription

Descripción de la revisión de la 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

apiVersionSet

Detalles del conjunto de versiones

apiVersionSet?: ApiVersionSetContractDetails

Valor de propiedad

ApiVersionSetContractDetails

apiVersionSetId

Identificador de recurso para apiVersionSet relacionado.

apiVersionSetId?: string

Valor de propiedad

string

authenticationSettings

Recopilación de la configuración de autenticación incluida 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

displayName

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

displayName?: string

Valor de propiedad

string

isCurrent

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

isCurrent?: boolean

Valor de propiedad

boolean

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

license

Información de licencia de la API.

license?: ApiLicenseInformation

Valor de propiedad

ApiLicenseInformation

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.

serviceUrl?: string

Valor de propiedad

string

sourceApiId

Identificador de API de la API de origen.

sourceApiId?: string

Valor de propiedad

string

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 de servicio de la API. DEBE tener el formato de una dirección URL.

termsOfServiceUrl?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

id

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

Heredado deProxyResource.id

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

Heredado deProxyResource.name

type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredado deProxyResource.type