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

Arabirimler

EditorData	Geliştirme Portalı'ndan alacağınız tüm verileri içeren JSON nesnesi
PortalData	Geliştirme Portalı'ndan alınan pencere öğesi örneği hakkında bilgi

Tür Diğer Adları

DeployConfig	Dağıtım işlevini yapılandırmak için isteğe bağlı seçenekler nesnesi.
Environment	Tüm olası çalışma zamanı ortamları
OnChange	onChange işlevinin türü.
Secrets	Dev Portal arka ucu ve diğer çalışma zamanı verileriyle iletişim için gereken gizli diziler
ServiceInformation	resourceId - API Management hizmetinin kaynak kimliği "subscriptions/[subscription-id]/resourceGroups/[resource-group-name]/providers/Microsoft.ApiManagement/service/[service-name]" managementApiEndpoint - Protokollü URL (örn. `https://management.azure.com`) apiVersion - varsayılanı geçersiz kılmak için isteğe bağlı (ör. "2019-01-01") tokenOverride - isteğe bağlı, 'az login' yaklaşımı yerine kimlik doğrulaması için kullanılacak belirteç sağlar
TargetModule	Yönetici panelinde form için Geliştirme Portalı "düzenleyicisi"ne eklenmiş ana uygulama için olası hedef modüller "uygulama".
ValuesCommon	Değerlerin tabanı obj

İşlevler

askForSecrets(TargetModule)	Gizli dizileri isteme - Geliştirme portalı üst penceresinden userId & belirteci.
buildBlobConfigPath(string)	Blob depolamada pencere öğelerinin yapılandırması için göreli yol oluşturma
buildBlobDataPath(string)	Blob depolamada pencere öğelerinin verileri için göreli yol oluşturma
buildOnChange<Values>()	Değiştirilen verileri düzenleyiciden göndermek için kullanabileceğiniz onChange işlevini oluşturun.
deployNodeJS(ServiceInformation, string, string, DeployConfig)	/dist klasöründeki her şeyi API Management DevPortals blob depolama alanına dağıtır.
getEditorValues<Values>()	Yönetici düzenleyicisi penceresinde ayarladığınız değerleri alma işlevi.
getValues<Values>(Values)	Yönetici düzenleyicisi penceresinde ayarladığınız değerleri alma işlevi. Tanımlanmamış/boş değerler varsayılan değerlerle değiştirilir.
getWidgetData<Values>()	Çoğu durumda gerekli olması beklenmeyen teknik değerler de dahil olmak üzere pencere öğesiyle ilgili tüm verileri alma işlevi. Çoğunlukla iç kullanıma yönelik olan API değişebilir. Bunun yerine getValues veya getEditorValues kullanmayı göz önünde bulundurun.
onChangeWithOrigin<Values>(string, string, Values)	parametre olarak sağlanan 'origin' ile onChange işlevinin kendisi.

Değişkenler

APIM_ASK_FOR_SECRETS_MESSAGE_KEY	Mesaj gönderme nesnesi için anahtar, DevPortal'dan token ve kullanıcı kimliği gibi sırlar istemek ve göndermek için kullanılır. Diğer uygulamalarla paraziti önlemek için kullanılır.
APIM_CONFIG_FILE_NAME	yapılandırma dosyasının adı
APIM_EDITOR_DATA_KEY	Düzenleyici verilerinin yükleneceği bir arama parametresi için anahtar.
APIM_ON_CHANGE_MESSAGE_KEY	Mesaj gönderme nesnesi için anahtar olan bu cihaz, editörün DevPortal'ına değişiklikleri yaymak için kullanılır. Diğer uygulamalarla paraziti önlemek için kullanılır.
BLOB_CONFIGS_FOLDER	Widget yapılandırmalarıyla birlikte blob depolama klasörünün adı
BLOB_DATA_FOLDER	Widget uygulamasıyla blob depolama klasörünün adı
BLOB_ROOT	Blob depolama klasörünün kökü

İşlev Ayrıntıları

askForSecrets(TargetModule)

Gizli dizileri isteme - Geliştirme portalı üst penceresinden userId & belirteci.

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

Parametreler

targetModule: TargetModule

İşlev ana "uygulama" penceresinden mi yoksa yönetici "düzenleyiciden" mi çağrılır?

Döndürülenler

Promise<Secrets>

buildBlobConfigPath(string)

Blob depolamada pencere öğelerinin yapılandırması için göreli yol oluşturma

function buildBlobConfigPath(name: string): string

Parametreler

name: string

pencere öğesinin adı

Döndürülenler

string

buildBlobDataPath(string)

Blob depolamada pencere öğelerinin verileri için göreli yol oluşturma

function buildBlobDataPath(name: string): string

Parametreler

name: string

pencere öğesinin adı

Döndürülenler

string

buildOnChange<Values>()

Değiştirilen verileri düzenleyiciden göndermek için kullanabileceğiniz onChange işlevini oluşturun.

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

Döndürülenler

OnChange<Values>

deployNodeJS(ServiceInformation, string, string, DeployConfig)

/dist klasöründeki her şeyi API Management DevPortals blob depolama alanına dağıtır.

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

Parametreler

serviceInformation: ServiceInformation

dağıtım için hizmet bilgileri

name: string

dağıtılacak pencere öğesinin adı

fallbackConfigPath: string

yapılandırma dosyasının yerel yolu (varsayılan olarak "./static/config.msapim.json")

config: DeployConfig

isteğe bağlı yapılandırma nesnesi

Döndürülenler

Promise<void>

getEditorValues<Values>()

Yönetici düzenleyicisi penceresinde ayarladığınız değerleri alma işlevi.

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

Döndürülenler

Partial<Values>

getValues<Values>(Values)

Yönetici düzenleyicisi penceresinde ayarladığınız değerleri alma işlevi. Tanımlanmamış/boş değerler varsayılan değerlerle değiştirilir.

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

Parametreler

valuesDefault: Values

kullanılacak varsayılan değerlerinizle nesne, yalnızca valuesDefault nesnesini values.ts klasöründen içeri aktar

Döndürülenler

Values

getWidgetData<Values>()

Çoğu durumda gerekli olması beklenmeyen teknik değerler de dahil olmak üzere pencere öğesiyle ilgili tüm verileri alma işlevi. Çoğunlukla iç kullanıma yönelik olan API değişebilir. Bunun yerine getValues veya getEditorValues kullanmayı göz önünde bulundurun.

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

Döndürülenler

EditorData<Values>

onChangeWithOrigin<Values>(string, string, Values)

parametre olarak sağlanan 'origin' ile onChange işlevinin kendisi.

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

Parametreler

origin: string

Değişiklik göndermek için Web içeriğinin Geliştirici Portalınızın kaynağı (URL)

instanceId: string

Pencere öğesinin bu özel örneğinin kimliği

values: Values

değişen değerler

Variable Details

APIM_ASK_FOR_SECRETS_MESSAGE_KEY

Mesaj gönderme nesnesi için anahtar, DevPortal'dan token ve kullanıcı kimliği gibi sırlar istemek ve göndermek için kullanılır. Diğer uygulamalarla paraziti önlemek için kullanılır.

APIM_ASK_FOR_SECRETS_MESSAGE_KEY: "askForSecretsMSAPIM"

Tür

"askForSecretsMSAPIM"

APIM_CONFIG_FILE_NAME

yapılandırma dosyasının adı

APIM_CONFIG_FILE_NAME: "config.msapim.json"

Tür

"config.msapim.json"

APIM_EDITOR_DATA_KEY

Düzenleyici verilerinin yükleneceği bir arama parametresi için anahtar.

APIM_EDITOR_DATA_KEY: "editorData"

Tür

"editorData"

APIM_ON_CHANGE_MESSAGE_KEY

Mesaj gönderme nesnesi için anahtar olan bu cihaz, editörün DevPortal'ına değişiklikleri yaymak için kullanılır. Diğer uygulamalarla paraziti önlemek için kullanılır.

APIM_ON_CHANGE_MESSAGE_KEY: "customInputValueChangedMSAPIM"

Tür

"customInputValueChangedMSAPIM"

BLOB_CONFIGS_FOLDER

Widget yapılandırmalarıyla birlikte blob depolama klasörünün adı

BLOB_CONFIGS_FOLDER: "configs"

Tür

"configs"

BLOB_DATA_FOLDER

Widget uygulamasıyla blob depolama klasörünün adı

BLOB_DATA_FOLDER: "data"

Tür

"data"

BLOB_ROOT

Blob depolama klasörünün kökü

BLOB_ROOT: "custom-widgets"

Tür

"custom-widgets"

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?