@azure/api-management-custom-widgets-tools package

Interfaces

EditorData	Objeto JSON con todos los datos que recibirá del Portal de desarrollo
PortalData	Información sobre la instancia del widget recibida desde el Portal de desarrollo

Alias de tipos

DeployConfig	Objeto de opciones opcionales para configurar la función de implementación.
Environment	Todos los entornos de tiempo de ejecución posibles
OnChange	Tipo de la función onChange.
Secrets	Secretos necesarios para la comunicación con el back-end del Portal de desarrollo y otros datos en tiempo de ejecución
ServiceInformation	resourceId: identificador de recurso del servicio API Management "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint: dirección URL con protocolo (por ejemplo, `https://management.azure.com`) apiVersion: opcional para invalidar el valor predeterminado (por ejemplo, "2019-01-01") tokenOverride: opcional, proporciona el token para la autenticación, en lugar del enfoque "az login".
TargetModule	Posibles módulos de destino "app" para la aplicación principal que está incrustado en el "editor" del Portal de desarrollo para formulario en el panel de administración
ValuesCommon	Base de un valor obj

Funciones

askForSecrets(TargetModule)	Solicitar secretos: token & userId, desde la ventana principal del portal de desarrollo.
buildBlobConfigPath(string)	Generación de la ruta de acceso relativa para la configuración de widgets en Blob Storage
buildBlobDataPath(string)	Generación de una ruta de acceso relativa para los datos de widgets en Blob Storage
buildOnChange<Values>()	Compile la función onChange, que puede usar, para enviar datos modificados desde el editor.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	Implementa todo desde la carpeta /dist en el almacenamiento de blobs de API Management DevPortals.
getEditorValues<Values>()	Función para obtener los valores que ha establecido en la ventana del editor de administración.
getValues<Values>(Values)	Función para obtener los valores que ha establecido en la ventana del editor de administración. Los valores no definidos o vacíos se reemplazan por valores predeterminados.
getWidgetData<Values>()	Función para obtener todos los datos relacionados con el widget, incluidos los valores técnicos que no se espera que sean necesarios en la mayoría de los casos. Diseñado principalmente para uso interno, la API podría cambiar. Considere la posibilidad de usar getValues o getEditorValues en su lugar.
onChangeWithOrigin<Values>(string, string, Values)	La propia función onChange con 'origin' proporcionada como parámetro.

Variables

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	Clave para un objeto de mensaje de publicación, se usa para solicitar y enviar secretos - token e ID de usuario, desde DevPortal. Se usa para evitar interferencias con otras aplicaciones.
APIM_CONFIG_FILE_NAME	Nombre del archivo de configuración
APIM_EDITOR_DATA_KEY	Clave para un parámetro de búsqueda, desde donde se cargarán los datos del editor.
APIM_ON_CHANGE_MESSAGE_KEY	Clave para un objeto de mensaje de publicación, se utiliza para propagar cambios del editor al DevPortal. Se usa para evitar interferencias con otras aplicaciones.
BLOB_CONFIGS_FOLDER	Nombre de la carpeta de almacenamiento de blobs con configuraciones de widgets
BLOB_DATA_FOLDER	Nombre de la carpeta de almacenamiento de blob con implementación de widgets
BLOB_ROOT	raíz de la carpeta de almacenamiento de blob

Detalles de la función

askForSecrets(TargetModule)

Solicitar secretos: token & userId, desde la ventana principal del portal de desarrollo.

function askForSecrets(targetModule: TargetModule): Promise<Secrets>

Parámetros

targetModule: TargetModule

¿se invoca la función desde la ventana principal "app" o el administrador "editor"?

Devoluciones

Promise<Secrets>

buildBlobConfigPath(string)

Generación de la ruta de acceso relativa para la configuración de widgets en Blob Storage

function buildBlobConfigPath(name: string): string

Parámetros

name: string

nombre del widget

Devoluciones

string

buildBlobDataPath(string)

Generación de una ruta de acceso relativa para los datos de widgets en Blob Storage

function buildBlobDataPath(name: string): string

Parámetros

name: string

nombre del widget

Devoluciones

string

buildOnChange<Values>()

Compile la función onChange, que puede usar, para enviar datos modificados desde el editor.

function buildOnChange<Values>(): OnChange<Values>

Devoluciones

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

Implementa todo desde la carpeta /dist en el almacenamiento de blobs de API Management DevPortals.

function deployNodeJS(serviceInformation: ServiceInformation, name: string, fallbackConfigPath?: string, config?: DeployConfig): Promise<void>

Parámetros

serviceInformation: ServiceInformation

información del servicio para la implementación

name: string

nombre del widget que se va a implementar

fallbackConfigPath: string

ruta de acceso local al archivo de configuración (de forma predeterminada "./static/config.msapim.json")

config: DeployConfig

objeto de configuración opcional

Devoluciones

Promise<void>

getEditorValues<Values>()

Función para obtener los valores que ha establecido en la ventana del editor de administración.

function getEditorValues<Values>(): Partial<Values>

Devoluciones

Partial<Values>

getValues<Values>(Values)

Función para obtener los valores que ha establecido en la ventana del editor de administración. Los valores no definidos o vacíos se reemplazan por valores predeterminados.

function getValues<Values>(valuesDefault: Values): Values

Parámetros

valuesDefault: Values

objeto con los valores predeterminados que se van a usar, basta con importar valoresObjeto predeterminado desde values.ts carpeta

Devoluciones

Values

getWidgetData<Values>()

Función para obtener todos los datos relacionados con el widget, incluidos los valores técnicos que no se espera que sean necesarios en la mayoría de los casos. Diseñado principalmente para uso interno, la API podría cambiar. Considere la posibilidad de usar getValues o getEditorValues en su lugar.

function getWidgetData<Values>(): EditorData<Values>

Devoluciones

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

La propia función onChange con 'origin' proporcionada como parámetro.

function onChangeWithOrigin<Values>(origin: string, instanceId: string, values: Values)

Parámetros

origin: string

origen (DIRECCIÓN URL) del contenido web del Portal de desarrollo para enviar cambios a

instanceId: string

Identificador de esta instancia concreta del widget

values: Values

valores que cambiaron

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

Clave para un objeto de mensaje de publicación, se usa para solicitar y enviar secretos - token e ID de usuario, desde DevPortal. Se usa para evitar interferencias con otras aplicaciones.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

Tipo

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

Nombre del archivo de configuración

APIM_CONFIG_FILE_NAME: "config.msapim.json"

Tipo

"config.msapim.json"

APIM_EDITOR_DATA_KEY

Clave para un parámetro de búsqueda, desde donde se cargarán los datos del editor.

APIM_EDITOR_DATA_KEY: "editorData"

Tipo

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

Clave para un objeto de mensaje de publicación, se utiliza para propagar cambios del editor al DevPortal. Se usa para evitar interferencias con otras aplicaciones.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

Tipo

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

Nombre de la carpeta de almacenamiento de blobs con configuraciones de widgets

BLOB_CONFIGS_FOLDER: "configs"

Tipo

"configs"

BLOB_DATA_FOLDER

Nombre de la carpeta de almacenamiento de blob con implementación de widgets

BLOB_DATA_FOLDER: "data"

Tipo

"data"

BLOB_ROOT

raíz de la carpeta de almacenamiento de blob

BLOB_ROOT: "custom-widgets"

Tipo

"custom-widgets"

Comentarios

¿Le ha resultado útil esta página?