Tipos de application

Os tipos que o módulo azion/applications exporta, com os payloads que cada função recebe e os parâmetros de lista que cada coleção aceita.

Última atualização

Ver como Markdown Configurar agente

O módulo azion/applications exporta estes tipos, exceto onde um tipo diz o contrário. Importe-os com import type.

AzionApplicationsClient

O client que createAzionApplicationClient retorna. Cada método recebe um único objeto.

MétodoArgumentoRetorno
createApplication{ data: ApiCreateApplicationPayload; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
getApplication{ applicationId: number; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
getApplications{ params?: AzionApplicationCollectionOptions; options?: AzionClientOptions }Promise<AzionApplicationCollectionResponse<AzionApplication>>
putApplication{ applicationId: number; data: ApiUpdateApplicationPayload; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
patchApplication{ applicationId: number; data: Partial<ApiUpdateApplicationPayload>; options?: AzionClientOptions }Promise<AzionApplicationResponse<AzionApplication>>
deleteApplication{ applicationId: number; options?: AzionClientOptions }Promise<AzionApplicationResponse<void>>

CreateAzionApplicationClient

O tipo de createAzionApplicationClient.

TypeScript
01type CreateAzionApplicationClient = (config?: Partial<{
02 token: string;
03 options?: AzionClientOptions;
04}>) => AzionApplicationsClient;

AzionClientOptions

Opções de requisição que toda função recebe em options.

PropriedadeTipoObrigatórioDescrição
debugbooleanNãoAtiva o modo de debug.
forcebooleanNãoDeclarado pelo tipo. Nenhum exemplo desta página o usa.

AzionApplicationResponse

O envelope que toda função retorna, exceto as funções de lista. Para saber como lê-lo, consulte Envelope de resposta.

PropriedadeTipoObrigatórioDescrição
dataTNãoO resultado da chamada.
error{ message: string; operation: string }NãoA mensagem de erro e a operação que falhou. Uma exclusão bem-sucedida também o preenche.

AzionApplicationCollectionResponse

O envelope que as funções de lista retornam.

PropriedadeTipoObrigatórioDescrição
data{ count; total_pages; schema_version; links; results }NãoA página de resultados.
data.countnumberSimO número de objetos da lista inteira, não da página.
data.total_pagesnumberSimO número de páginas.
data.schema_versionnumberSimA versão do schema da resposta da API.
data.links{ previous: string | null; next: string | null }SimAs páginas anterior e seguinte.
data.resultsT[]SimOs objetos da página.
error{ message: string; operation: string }NãoA mensagem de erro e a operação que falhou.

AzionApplication

Uma application: os campos de ApiBaseApplicationPayload, mais o ID e os métodos da application. AzionApplicationSettings tem o mesmo formato, sem os métodos.

PropriedadeTipoObrigatórioDescrição
idnumberSimO ID da application.
originsOriginOperationsSimOs métodos de origem.
cacheCacheOperationsSimOs métodos de cache setting.
devicesDeviceGroupOperationsSimOs métodos de device group.
functionsFunctionOperationsSimOs métodos de instância de function.
rules{ request: RuleOperations; response: RuleOperations }SimOs métodos de regra, um conjunto por fase.

ApiBaseApplicationPayload

As configurações de uma application. name é obrigatório, e todos os outros campos são opcionais. ApiCreateApplicationPayload, que o módulo não exporta, tem o mesmo formato, e ApiUpdateApplicationPayload torna todos os campos opcionais. A API v3 recusa application_acceleration em uma requisição de criação.

TypeScript
01interface ApiBaseApplicationPayload {
02 name: string;
03 delivery_protocol?: DeliveryProtocol;
04 http3?: boolean;
05 http_port?: HttpPort[];
06 https_port?: HttpsPort[];
07 minimum_tls_version?: TlsVersion;
08 active?: boolean;
09 debug_rules?: boolean;
10 application_acceleration?: boolean;
11 caching?: boolean;
12 device_detection?: boolean;
13 edge_firewall?: boolean;
14 edge_functions?: boolean;
15 image_optimization?: boolean;
16 l2_caching?: boolean;
17 load_balancer?: boolean;
18 raw_logs?: boolean;
19 web_application_firewall?: boolean;
20 supported_ciphers?: SupportedCiphers;
21}

Os enums das configurações da application, que o módulo exporta:

TypeScript
01enum DeliveryProtocol {
02 HTTP = "http",
03 HTTPS = "https",
04 HTTP_HTTPS = "http,https"
05}
06enum HttpPort {
07 PORT_80 = 80,
08 PORT_8008 = 8008,
09 PORT_8080 = 8080
10}
11enum HttpsPort {
12 PORT_443 = 443,
13 PORT_8443 = 8443,
14 PORT_9440 = 9440,
15 PORT_9441 = 9441,
16 PORT_9442 = 9442,
17 PORT_9443 = 9443
18}
19enum TlsVersion {
20 TLS_1_0 = "tls_1_0",
21 TLS_1_1 = "tls_1_1",
22 TLS_1_2 = "tls_1_2",
23 TLS_1_3 = "tls_1_3"
24}
25enum SupportedCiphers {
26 ALL = "all",
27 TLSv1_2_2018 = "TLSv1.2_2018",
28 TLSv1_2_2019 = "TLSv1.2_2019",
29 TLSv1_2_2021 = "TLSv1.2_2021",
30 TLSv1_3_2022 = "TLSv1.3_2022"
31}

ApiListApplicationsParams

Paginação e ordenação para getApplications. AzionApplicationCollectionOptions, que o método do client recebe, tem as mesmas chaves.

PropriedadeTipoObrigatórioDescrição
pagenumberNãoO número da página.
page_sizenumberNãoO número de applications por página.
sort'name' | 'id'NãoDeclarado pelo tipo. Nenhum exemplo desta página o usa.
order_bystringNãoDeclarado pelo tipo. Nenhum exemplo desta página o usa.

AzionOrigin

Uma origem, com a origin_key dela. ApiCreateOriginPayload recebe todos os campos abaixo, exceto id e method, todos obrigatórios, além dos campos opcionais origin_path, hmac_authentication, hmac_region_name, hmac_access_key, hmac_secret_key, connection_timeout e timeout_between_bytes. ApiUpdateOriginRequest torna todos os campos opcionais e exige id.

TypeScript
01interface AzionOrigin {
02 id: number;
03 origin_key: string;
04 name: string;
05 origin_type: OriginType;
06 addresses: Address[];
07 origin_protocol_policy: OriginProtocolPolicy;
08 is_origin_redirection_enabled: boolean;
09 host_header: string;
10 method: string;
11 origin_path: string;
12 connection_timeout: number;
13 timeout_between_bytes: number;
14 hmac_authentication: boolean;
15 hmac_region_name: string;
16 hmac_access_key: string;
17 hmac_secret_key: string;
18}
19interface Address {
20 address: string;
21 weight?: number | null;
22 server_role?: ServerRole;
23 is_active?: boolean;
24}

Os enums de uma origem, que o módulo não exporta:

TypeScript
01enum OriginType {
02 SINGLE_ORIGIN = "single_origin",
03 LOAD_BALANCER = "load_balancer"
04}
05enum OriginProtocolPolicy {
06 PRESERVE = "preserve",
07 HTTP = "http",
08 HTTPS = "https"
09}
10enum ServerRole {
11 PRIMARY = "primary",
12 BACKUP = "backup"
13}

AzionCacheSetting

Um cache setting: os campos de ApiBaseCacheSettingPayload, mais o id dele (number).

ApiBaseCacheSettingPayload

As configurações de um cache setting. name é obrigatório, e todos os outros campos são opcionais. ApiUpdateCacheSettingPayload torna todos os campos opcionais.

TypeScript
01interface ApiBaseCacheSettingPayload {
02 name: string;
03 browser_cache_settings?: BrowserCacheSettings;
04 browser_cache_settings_maximum_ttl?: number;
05 cdn_cache_settings?: CdnCacheSettings;
06 cdn_cache_settings_maximum_ttl?: number;
07 cache_by_query_string?: CacheByQueryString;
08 query_string_fields?: string[];
09 enable_query_string_sort?: boolean;
10 cache_by_cookies?: CacheByCookies;
11 cookie_names?: string[];
12 adaptive_delivery_action?: AdaptiveDeliveryAction;
13 device_group?: string[];
14 enable_caching_for_post?: boolean;
15 l2_caching_enabled?: boolean;
16 is_slice_configuration_enabled?: boolean;
17 is_slice_edge_caching_enabled?: boolean;
18 is_slice_l2_caching_enabled?: boolean;
19 slice_configuration_range?: number;
20 enable_caching_for_options?: boolean;
21 enable_stale_cache?: boolean;
22 l2_region?: string | null;
23}

Os enums de um cache setting, que o módulo não exporta:

TypeScript
01enum BrowserCacheSettings {
02 HONOR = "honor",
03 OVERRIDE = "override",
04 IGNORE = "ignore"
05}
06enum CdnCacheSettings {
07 HONOR = "honor",
08 OVERRIDE = "override"
09}
10enum CacheByQueryString {
11 IGNORE = "ignore",
12 WHITELIST = "whitelist",
13 BLACKLIST = "blacklist",
14 ALL = "all"
15}
16enum CacheByCookies {
17 IGNORE = "ignore",
18 WHITELIST = "whitelist",
19 BLACKLIST = "blacklist",
20 ALL = "all"
21}
22enum AdaptiveDeliveryAction {
23 IGNORE = "ignore",
24 OPTIMIZE = "optimize"
25}

AzionDeviceGroup

Um device group. ApiCreateDeviceGroupPayload e ApiUpdateDeviceGroupPayload, que o módulo não exporta, recebem name e user_agent, ambos obrigatórios na criação e opcionais na atualização.

PropriedadeTipoObrigatórioDescrição
idnumberSimO ID do device group.
namestringSimO nome do grupo, sem espaços e sem hífens.
user_agentstringSimA expressão regular comparada com o header de requisição User-Agent.

AzionFunctionInstance

Uma instância de function. A API retorna os quatro campos abaixo, como os exemplos mostram.

PropriedadeTipoDescrição
idnumberO ID da instância de function.
edge_function_idnumberO ID da function que a instância executa.
namestringO nome da instância de function.
argsRecord<string, unknown>Os argumentos que a function recebe.

O tipo declara outros campos: id, mais os campos de ApiBaseFunctionInstancePayload, que são name, code, language ('JavaScript'), initiator_type ('edge_application' \| 'edge_firewall'), active e json_args. ApiUpdateFunctionInstancePayload torna esses campos opcionais.

ApiCreateFunctionInstancePayload

O payload de createFunctionInstance. O módulo não exporta este tipo.

PropriedadeTipoObrigatórioDescrição
namestringSimO nome da instância de function.
edge_function_idnumberSimO ID da function que a instância executa.
argsRecord<string, unknown>SimOs argumentos que a function recebe.
activebooleanNãoDeclarado pelo tipo. Nenhum exemplo desta página o usa.

AzionRule

Uma regra: os campos de ApiCreateRulePayload, mais id (number). AzionRule declara is_active e order como obrigatórios, e toda regra dos exemplos traz os dois.

ApiCreateRulePayload

O payload de createRule. ApiUpdateRulePayload torna todos os campos opcionais.

PropriedadeTipoObrigatórioDescrição
namestringSimO nome da regra.
phase'request' | 'response'SimA fase da regra.
criteriaCriterion[][]SimOs grupos de condições. Cada Criterion contém variable (string), operator (string), conditional ('if' | 'and' | 'or') e input_value (string).
behaviorsBehavior[]SimAs ações. Cada Behavior contém name (string) e um target opcional: uma string, null ou { captured_array: string; subject: string; regex: string }.
is_activebooleanNãoIndica se a regra está ativa. Uma regra criada sem ele fica ativa.
ordernumberNãoA posição da regra na fase dela.
descriptionstringNãoA descrição da regra.

Parâmetros de lista

O objeto params de cada função de lista de sub-recurso declara estas chaves. Os exemplos enviam apenas page e page_size. ApiListDeviceGroupsParams não é exportado.

TipoChaves declaradas
ApiListOriginsParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc'), filter
ApiListCacheSettingsParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc')
ApiListDeviceGroupsParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc')
ApiListFunctionInstancesParamspage, page_size, sort ('name' | 'id'), order ('asc' | 'desc'), order_by, filter
ApiListRulesParamspage, page_size, sort (string), order ('asc' | 'desc'), filter

Recursos relacionados

Azion Lib

Os módulos da Azion Lib e o pacote npm em que cada um é distribuído.

Applications

A autenticação do módulo, o envelope de resposta dele e os erros que as funções reportam.

Funções de application

As funções que criam, leem e atualizam a application que estes tipos descrevem.

Client

O client que expõe Applications ao lado de Storage, SQL, Purge, Domains e AI.