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

Interfacce

EditorData	Oggetto JSON con tutti i dati che si riceveranno dal portale di sviluppo
PortalData	Informazioni sull'istanza del widget ricevuta dal portale di sviluppo

Alias tipo

DeployConfig	Oggetto opzioni facoltative per la configurazione della funzione di distribuzione.
Environment	Tutti gli ambienti di runtime possibili
OnChange	Tipo della funzione onChange.
Secrets	Segreti necessari per la comunicazione con il back-end di Dev Portal e altri dati di runtime
ServiceInformation	resourceId - ID risorsa del servizio Gestione API "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint - URL con protocollo (ad esempio. `https://management.azure.com`) apiVersion: facoltativo per eseguire l'override del valore predefinito (ad esempio, "2019-01-01") tokenOverride, facoltativo, fornisce il token da usare per l'autenticazione, anziché l'approccio "az login"
TargetModule	Possibili moduli di destinazione "app" per l'applicazione principale incorporata nel portale di sviluppo "editor" per il modulo nel pannello di amministrazione
ValuesCommon	Base di un valore obj

Funzioni

askForSecrets(TargetModule)	Richiedi segreti: token & userId dalla finestra padre del portale di sviluppo.
buildBlobConfigPath(string)	Generare il percorso relativo per la configurazione dei widget nell'archivio BLOB
buildBlobDataPath(string)	Generare il percorso relativo per i dati dei widget nell'archivio BLOB
buildOnChange<Values>()	Compilare la funzione onChange, che è possibile usare, per inviare dati modificati dall'editor.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	Distribuisce tutti gli elementi dalla cartella /dist all'archivio BLOB di Gestione API DevPortals.
getEditorValues<Values>()	Funzione per ottenere i valori impostati nella finestra dell'editor di amministrazione.
getValues<Values>(Values)	Funzione per ottenere i valori impostati nella finestra dell'editor di amministrazione. I valori non definiti/vuoti vengono sostituiti con i valori predefiniti.
getWidgetData<Values>()	Funzione per ottenere tutti i dati correlati al widget, inclusi i valori tecnici non previsti, nella maggior parte dei casi. Destinato principalmente all'uso interno, l'API potrebbe cambiare. Prendere in considerazione l'uso di getValues o getEditorValues.
onChangeWithOrigin<Values>(string, string, Values)	Funzione onChange stessa con 'origin' fornita come parametro.

Variabili

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	Fondamentale per un oggetto post messaggio, viene usato per richiedere e inviare segreti - token e user id, dal DevPortal. Usata per prevenire interferenze con altre applicazioni.
APIM_CONFIG_FILE_NAME	Nome del file di configurazione
APIM_EDITOR_DATA_KEY	Chiave per un parametro di ricerca, da cui verranno caricati i dati dell'editor.
APIM_ON_CHANGE_MESSAGE_KEY	Fondamentale per un oggetto post message, viene usato per propagare le modifiche dall'editor al DevPortal. Usata per prevenire interferenze con altre applicazioni.
BLOB_CONFIGS_FOLDER	Nome della cartella di archiviazione del blob con configurazioni dei widget
BLOB_DATA_FOLDER	Nome della cartella Blob Storage con implementazione del widget
BLOB_ROOT	Radice della cartella Blob Storage

Dettagli funzione

askForSecrets(TargetModule)

Richiedi segreti: token & userId dalla finestra padre del portale di sviluppo.

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

Parametri

targetModule: TargetModule

la funzione viene richiamata dalla finestra principale "app" o dall'amministratore "editor"?

Restituisce

Promise<Secrets>

buildBlobConfigPath(string)

Generare il percorso relativo per la configurazione dei widget nell'archivio BLOB

function buildBlobConfigPath(name: string): string

Parametri

name: string

nome del widget

Restituisce

string

buildBlobDataPath(string)

Generare il percorso relativo per i dati dei widget nell'archivio BLOB

function buildBlobDataPath(name: string): string

Parametri

name: string

nome del widget

Restituisce

string

buildOnChange<Values>()

Compilare la funzione onChange, che è possibile usare, per inviare dati modificati dall'editor.

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

Restituisce

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

Distribuisce tutti gli elementi dalla cartella /dist all'archivio BLOB di Gestione API DevPortals.

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

Parametri

serviceInformation: ServiceInformation

informazioni sul servizio per la distribuzione

name: string

nome del widget da distribuire

fallbackConfigPath: string

percorso locale del file di configurazione (per impostazione predefinita "./static/config.msapim.json")

config: DeployConfig

oggetto config facoltativo

Restituisce

Promise<void>

getEditorValues<Values>()

Funzione per ottenere i valori impostati nella finestra dell'editor di amministrazione.

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

Restituisce

Partial<Values>

getValues<Values>(Values)

Funzione per ottenere i valori impostati nella finestra dell'editor di amministrazione. I valori non definiti/vuoti vengono sostituiti con i valori predefiniti.

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

Parametri

valuesDefault: Values

oggetto con i valori predefiniti da usare, è sufficiente importare valoriOggetto predefiniti da values.ts cartella

Restituisce

Values

getWidgetData<Values>()

Funzione per ottenere tutti i dati correlati al widget, inclusi i valori tecnici non previsti, nella maggior parte dei casi. Destinato principalmente all'uso interno, l'API potrebbe cambiare. Prendere in considerazione l'uso di getValues o getEditorValues.

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

Restituisce

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

Funzione onChange stessa con 'origin' fornita come parametro.

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

Parametri

origin: string

Origine del contenuto Web (URL) del portale di sviluppo per inviare modifiche a

instanceId: string

ID di questa particolare istanza del widget

values: Values

valori modificati

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

Fondamentale per un oggetto post messaggio, viene usato per richiedere e inviare segreti - token e user id, dal DevPortal. Usata per prevenire interferenze con altre applicazioni.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

Tipo

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

Nome del file di configurazione

APIM_CONFIG_FILE_NAME: "config.msapim.json"

Tipo

"config.msapim.json"

APIM_EDITOR_DATA_KEY

Chiave per un parametro di ricerca, da cui verranno caricati i dati dell'editor.

APIM_EDITOR_DATA_KEY: "editorData"

Tipo

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

Fondamentale per un oggetto post message, viene usato per propagare le modifiche dall'editor al DevPortal. Usata per prevenire interferenze con altre applicazioni.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

Tipo

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

Nome della cartella di archiviazione del blob con configurazioni dei widget

BLOB_CONFIGS_FOLDER: "configs"

Tipo

"configs"

BLOB_DATA_FOLDER

Nome della cartella Blob Storage con implementazione del widget

BLOB_DATA_FOLDER: "data"

Tipo

"data"

BLOB_ROOT

Radice della cartella Blob Storage

BLOB_ROOT: "custom-widgets"

Tipo

"custom-widgets"

Commenti e suggerimenti

Questa pagina è stata utile?