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

Dev portal の親ウィンドウからシークレットを要求する - userId & トークン。

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

パラメーター

戻り値

BLOB ストレージ上のウィジェットの構成の相対パスを生成する

function buildBlobConfigPath(name: string): string

パラメーター

戻り値

BLOB ストレージ上のウィジェットのデータの相対パスを生成する

function buildBlobDataPath(name: string): string

パラメーター

戻り値

エディターから変更されたデータを送信するために使用できる onChange 関数をビルドします。

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

戻り値

/dist フォルダーから API Management DevPortals の BLOB ストレージにすべてをデプロイします。

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

パラメーター

戻り値

管理エディター ウィンドウで設定した値を取得する関数。

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

戻り値

管理エディター ウィンドウで設定した値を取得する関数。 未定義/空の値は既定値に置き換えられます。

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

パラメーター

戻り値

ほとんどの場合、必要とされない技術的な値を含む、ウィジェットに関連するすべてのデータを取得する関数。 主に内部使用を目的としているため、API が変更される可能性があります。 代わりに getValues または getEditorValues を使用することを検討してください。

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

戻り値

パラメーターとして指定された 'origin' を持つ onChange 関数自体。

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

パラメーター

投稿メッセージオブジェクトのキーで、DevPortalからトークンやユーザーIDなどの秘密を要求・送信します。 他のアプリケーションとの干渉を防ぐために使用されます。

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

型

設定ファイル名

APIM_CONFIG_FILE_NAME: "config.msapim.json"

型

検索パラメータのキーで、そこからエディターデータが読み込まれます。

APIM_EDITOR_DATA_KEY: "editorData"

型

投稿メッセージオブジェクトの鍵として、編集者からDevPortalへの変更伝播に使われます。 他のアプリケーションとの干渉を防ぐために使用されます。

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

型

ウィジェット設定を含むBLOBストレージフォルダの名前

BLOB_CONFIGS_FOLDER: "configs"

型

ウィジェット実装を含むBLOBストレージフォルダの名前

BLOB_DATA_FOLDER: "data"

型

BLOBストレージフォルダのルート

BLOB_ROOT: "custom-widgets"

型