你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

接口

EditorData	JSON 对象，其中包含从开发门户接收的所有数据
PortalData	有关从开发门户收到的小组件实例的信息

类型别名

DeployConfig	用于配置部署函数的可选选项对象。
Environment	所有可能的运行时环境
OnChange	onChange 函数的类型。
Secrets	与开发人员门户后端和其他运行时数据通信所需的机密
ServiceInformation	resourceId - API 管理服务的资源 ID“subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]” managementApiEndpoint - 具有协议的 URL（例如。 `https://management.azure.com`） apiVersion - 可选替代默认值（例如“2019-01-01”） tokenOverride - 可选，提供用于身份验证的令牌，而不是“az login”方法
TargetModule	主应用程序的可能目标模块“app”，该模块嵌入在管理面板中的表单的开发人员门户“编辑器” 中
ValuesCommon	值基数 obj

函数

askForSecrets(TargetModule)	从开发人员门户父窗口请求机密 - 令牌 & userId。
buildBlobConfigPath(string)	为 blob 存储上的小组件配置生成相对路径
buildBlobDataPath(string)	为 blob 存储上的小组件数据生成相对路径
buildOnChange<Values>()	Build onChange 函数，可以使用该函数从编辑器发送更改的数据。
deployNodeJS(ServiceInformation, string, string, DeployConfig)	将 /dist 文件夹中的所有内容部署到 API Management DevPortals 的 Blob 存储。
getEditorValues<Values>()	用于获取在管理员编辑器窗口中设置的值的函数。
getValues<Values>(Values)	用于获取在管理员编辑器窗口中设置的值的函数。未定义/空值将替换为默认值。
getWidgetData<Values>()	用于获取与小组件相关的所有数据的函数，包括在大多数情况下不需要的技术值。 API 主要用于内部使用，API 可能会更改。请考虑改用 getValues 或 getEditorValues。
onChangeWithOrigin<Values>(string, string, Values)	onChange 函数本身，其“origin”作为参数提供。

变量

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	作为帖子消息对象的密钥，它用于请求和发送密钥——从DevPortal获取令牌和用户ID。用于防止干扰其他应用。
APIM_CONFIG_FILE_NAME	配置文件名称
APIM_EDITOR_DATA_KEY	用于搜索参数的Key，编辑器数据将从中加载。
APIM_ON_CHANGE_MESSAGE_KEY	作为帖子消息对象的关键，它用于将编辑者之间的更改传播到开发门户。用于防止干扰其他应用。
BLOB_CONFIGS_FOLDER	带有小部件配置的 BLOB 存储文件夹名称
BLOB_DATA_FOLDER	带有控件实现的 BLOB 存储文件夹名称
BLOB_ROOT	blob 存储文件夹的根节点

函数详细信息

askForSecrets(TargetModule)

从开发人员门户父窗口请求机密 - 令牌 & userId。

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

参数

targetModule: TargetModule

函数是从主“应用”窗口还是管理员“编辑器”调用？

Promise<Secrets>

buildBlobConfigPath(string)

为 blob 存储上的小组件配置生成相对路径

function buildBlobConfigPath(name: string): string

参数

name: string

小组件的名称

string

buildBlobDataPath(string)

为 blob 存储上的小组件数据生成相对路径

function buildBlobDataPath(name: string): string

参数

name: string

小组件的名称

string

buildOnChange<Values>()

Build onChange 函数，可以使用该函数从编辑器发送更改的数据。

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

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

将 /dist 文件夹中的所有内容部署到 API Management DevPortals 的 Blob 存储。

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

参数

serviceInformation: ServiceInformation

部署的服务信息

name: string

要部署的小组件的名称

fallbackConfigPath: string

配置文件的本地路径（默认情况下为“./static/config.msapim.json”）

config: DeployConfig

可选配置对象

Promise<void>

getEditorValues<Values>()

用于获取在管理员编辑器窗口中设置的值的函数。

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

Partial<Values>

getValues<Values>(Values)

用于获取在管理员编辑器窗口中设置的值的函数。未定义/空值将替换为默认值。

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

参数

valuesDefault: Values

具有要使用的默认值的对象，只需从 values.ts 文件夹中导入 valuesDefault 对象

Values

getWidgetData<Values>()

用于获取与小组件相关的所有数据的函数，包括在大多数情况下不需要的技术值。 API 主要用于内部使用，API 可能会更改。请考虑改用 getValues 或 getEditorValues。

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

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

onChange 函数本身，其“origin”作为参数提供。

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

参数

origin: string

要向其发送更改的开发人员门户的 Web 内容的源（URL）

instanceId: string

小组件的此特定实例的 ID

values: Values

已更改的值

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

作为帖子消息对象的密钥，它用于请求和发送密钥——从DevPortal获取令牌和用户ID。用于防止干扰其他应用。

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

类型

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

配置文件名称

APIM_CONFIG_FILE_NAME: "config.msapim.json"

类型

"config.msapim.json"

APIM_EDITOR_DATA_KEY

用于搜索参数的Key，编辑器数据将从中加载。

APIM_EDITOR_DATA_KEY: "editorData"

类型

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

作为帖子消息对象的关键，它用于将编辑者之间的更改传播到开发门户。用于防止干扰其他应用。

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

类型

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

带有小部件配置的 BLOB 存储文件夹名称

BLOB_CONFIGS_FOLDER: "configs"

类型

"configs"

BLOB_DATA_FOLDER

带有控件实现的 BLOB 存储文件夹名称

BLOB_DATA_FOLDER: "data"

类型

"data"

BLOB_ROOT

blob 存储文件夹的根节点

BLOB_ROOT: "custom-widgets"

类型

"custom-widgets"

反馈

此页面是否有帮助？