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

비밀 요청 - 개발자 포털 부모 창에서 토큰 & userId입니다.

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

매개 변수

반환

Blob Storage에서 위젯 구성에 대한 상대 경로 생성

function buildBlobConfigPath(name: string): string

매개 변수

반환

Blob Storage에서 위젯 데이터에 대한 상대 경로 생성

function buildBlobDataPath(name: string): string

매개 변수

반환

편집기에서 변경된 데이터를 보내는 데 사용할 수 있는 onChange 함수를 빌드합니다.

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

반환

/dist 폴더에서 API Management DevPortals의 Blob Storage에 모든 항목을 배포합니다.

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_CONFIGS_FOLDER: "configs"

형식

위젯 구현이 포함된 블롭 스토리지 폴더 이름

BLOB_DATA_FOLDER: "data"

형식

블롭 스토리지 폴더의 루트

BLOB_ROOT: "custom-widgets"

형식