Domains

O módulo azion/domains é a biblioteca da Azion Lib para Domains. Suas funções criam, listam, leem, atualizam e excluem os domínios da sua conta, e cada domínio aponta para uma application pelo ID dela. O módulo chama a Azion API v3, e toda função retorna um envelope de resposta.

Instale o pacote:

npm install azion

O pacote azion recebe apenas correções de bugs, e a manutenção dele termina em dezembro de 2026.

Os exemplos desta página são módulos ES em TypeScript que usam await de nível superior e rodam no Node.js. Eles importam os tipos com import type, o que os mantém carregáveis quando as anotações de tipo são removidas.

Autenticação

As funções leem o seu personal token da variável de ambiente AZION_TOKEN. Um client criado com createClient recebe o token no campo token, em vez da variável.

Variável	Descrição
`AZION_TOKEN`	O seu personal token da Azion.
`AZION_DEBUG`	Com `true`, ativa o modo de debug.

Para saber como os pacotes da Azion Lib resolvem o token e a configuração de debug, consulte Como a Azion Lib funciona.

Envelope de resposta

Toda função retorna um objeto AzionDomainsResponse, { data?, error? }. Em caso de sucesso, data contém o domínio, a lista de domínios ou o domínio excluído. Em caso de falha, error contém { message, operation }, em que operation nomeia a chamada que falhou.

Uma chamada bem-sucedida de deleteDomain também retorna data: um AzionDeletedDomain com o id do domínio excluído.

createClient

Cria um client que guarda um token e opções de requisição e expõe as cinco funções de domínio como métodos. createClient também é o export padrão do módulo.

TypeScript

01function createClient(config?: Partial<{

02 token?: string;

03 options?: AzionClientOptions;

04}>): AzionDomainsClient;

Parâmetro	Tipo	Obrigatório	Descrição
`token`	`string`	Não	O seu personal token da Azion.
`options`	`AzionClientOptions`	Não	Opções de requisição para toda chamada que o client faz.

Retorna um AzionDomainsClient. Os métodos dele recebem os mesmos argumentos que as funções correspondentes desta página.

Este exemplo cria um client e, com ele, um domínio:

TypeScript

01import { createClient } from 'azion/domains';

02import type { AzionDomain, AzionDomainsClient, AzionDomainsResponse } from 'azion/domains';

04const client: AzionDomainsClient = createClient({ token: process.env.AZION_TOKEN, options: { debug: false } });

const { data: newDomain, error }: AzionDomainsResponse<AzionDomain> = await client.createDomain({ name: 'my-client-domain', edgeApplicationId: 1234567890 });

07if (newDomain) {

08 console.log(`Domain created with ID: ${newDomain.id} (${newDomain.url})`);

09} else {

10 console.error('Failed to create domain', error);

11}

Saída:

Domain created with ID: 1234567891 (xxxxxxxxxx.map.azionedge.net)

createDomain

Cria um domínio que aponta para uma application.

function createDomain(domain: AzionCreateDomain, options?: AzionClientOptions): Promise<AzionDomainsResponse<AzionDomain>>;

Parâmetro	Tipo	Obrigatório	Descrição
`domain`	`AzionCreateDomain`	Sim	As configurações do domínio. `name` e `edgeApplicationId` são obrigatórios.
`options`	`AzionClientOptions`	Não	Opções de requisição.

Retorna data como o AzionDomain criado. O domínio traz o id que a API atribuiu, e url contém o endereço Azion do domínio.

TypeScript

01import { createDomain } from 'azion/domains';

02import type { AzionDomain, AzionDomainsResponse } from 'azion/domains';

04const { data: domain, error }: AzionDomainsResponse<AzionDomain> = await createDomain({

05 name: 'my-domain',

06 edgeApplicationId: 1234567890,

07});

08if (domain) {

09 console.log(`Domain created with ID: ${domain.id} (${domain.url})`);

10} else {

11 console.error('Failed to create domain', error);

12}

Saída:

Domain created with ID: 1234567892 (xxxxxxxxxx.map.azionedge.net)

getDomains

Lista os domínios da conta, uma página por vez.

TypeScript

01function getDomains(options?: AzionClientOptions, queryParams?: {

02 orderBy?: 'id' | 'name';

03 page?: number;

04 pageSize?: number;

05 sort?: 'asc' | 'desc';

06}): Promise<AzionDomainsResponse<AzionDomainCollection>>;

Parâmetro	Tipo	Obrigatório	Descrição
`options`	`AzionClientOptions`	Não	Opções de requisição.
`queryParams`	`{ orderBy?, page?, pageSize?, sort? }`	Não	Paginação. Dessas chaves, a função envia apenas `page` para a API, e cada página contém 10 domínios.

Retorna data como um AzionDomainCollection: results contém a página, e count contém o número de domínios da conta, não o tamanho da página.

TypeScript

01import { getDomains } from 'azion/domains';

02import type { AzionDomainCollection, AzionDomainsResponse } from 'azion/domains';

04const { data: domains, error }: AzionDomainsResponse<AzionDomainCollection> = await getDomains();

06if (domains) {

07 console.log(`Found ${domains.count} domains; this page has ${domains.results.length}`);

08} else {

09 console.error('Failed to list domains', error);

10}

Saída:

Found 20 domains; this page has 10

getDomain

Retorna um domínio pelo ID.

function getDomain(domainId: number, options?: AzionClientOptions): Promise<AzionDomainsResponse<AzionDomain>>;

Parâmetro	Tipo	Obrigatório	Descrição
`domainId`	`number`	Sim	O ID do domínio.
`options`	`AzionClientOptions`	Não	Opções de requisição.

Retorna data como um AzionDomain.

TypeScript

01import { getDomain } from 'azion/domains';

02import type { AzionDomain, AzionDomainsResponse } from 'azion/domains';

04const domainId = 1234567892;

05const { data: domain, error }: AzionDomainsResponse<AzionDomain> = await getDomain(domainId);

07if (domain) {

08 console.log(`Found domain with name: ${domain.name}`);

09} else {

10 console.error('Failed to get domain', error);

11}

Saída:

Found domain with name: my-domain

updateDomain

Atualiza um domínio pelo ID. A função envia uma requisição PUT, e toda chamada leva name e edgeApplicationId.

function updateDomain(domainId: number, domain: AzionUpdateDomain, options?: AzionClientOptions): Promise<AzionDomainsResponse<AzionDomain>>;

Parâmetro	Tipo	Obrigatório	Descrição
`domainId`	`number`	Sim	O ID do domínio a atualizar.
`domain`	`AzionUpdateDomain`	Sim	As configurações do domínio. `name` e `edgeApplicationId` são obrigatórios.
`options`	`AzionClientOptions`	Não	Opções de requisição.

Retorna data como o AzionDomain atualizado.

TypeScript

01import { updateDomain } from 'azion/domains';

02import type { AzionDomain, AzionDomainsResponse } from 'azion/domains';

04const domainId = 1234567892;

05const { data: domain, error }: AzionDomainsResponse<AzionDomain> = await updateDomain(domainId, {

06 name: 'my-domain-updated',

07 edgeApplicationId: 1234567890,

08});

10if (domain) {

11 console.log(`Updated domain with name: ${domain.name}`);

12} else {

13 console.error('Failed to update domain', error);

14}

Saída:

Updated domain with name: my-domain-updated

deleteDomain

Exclui um domínio pelo ID.

function deleteDomain(domainId: number, options?: AzionClientOptions): Promise<AzionDomainsResponse<AzionDeletedDomain>>;

Parâmetro	Tipo	Obrigatório	Descrição
`domainId`	`number`	Sim	O ID do domínio a excluir.
`options`	`AzionClientOptions`	Não	Opções de requisição.

Retorna data como um AzionDeletedDomain com o id do domínio excluído.

TypeScript

01import { deleteDomain } from 'azion/domains';

02import type { AzionDeletedDomain, AzionDomainsResponse } from 'azion/domains';

04const domainId = 1234567891;

05const { data: deletedDomain, error }: AzionDomainsResponse<AzionDeletedDomain> = await deleteDomain(domainId);

07if (deletedDomain) {

08 console.log(`Deleted domain with ID: ${deletedDomain.id}`);

09} else {

10 console.error('Failed to delete domain', error);

11}

Saída:

Deleted domain with ID: 1234567891

Tipos

O módulo azion/domains exporta estes tipos. Importe-os com import type.

AzionDomainsClient

O client que createClient retorna.

Método	Argumentos	Retorno
`createDomain`	`domain: AzionCreateDomain, options?: AzionClientOptions`	`Promise<AzionDomainsResponse<AzionDomain>>`
`getDomains`	`options?: AzionClientOptions, queryParams?`	`Promise<AzionDomainsResponse<AzionDomainCollection>>`
`getDomain`	`domainId: number, options?: AzionClientOptions`	`Promise<AzionDomainsResponse<AzionDomain>>`
`updateDomain`	`domainId: number, domain: AzionUpdateDomain, options?: AzionClientOptions`	`Promise<AzionDomainsResponse<AzionDomain>>`
`deleteDomain`	`domainId: number, options?: AzionClientOptions`	`Promise<AzionDomainsResponse<AzionDeletedDomain>>`

AzionDomainsCreateClient

O tipo de createClient.

TypeScript

01type AzionDomainsCreateClient = (config?: Partial<{

02 token?: string;

03 options?: AzionClientOptions;

04}>) => AzionDomainsClient;

AzionClientOptions

Opções de requisição que toda função recebe em options, e que createClient recebe para todas as chamadas dele.

Propriedade	Tipo	Obrigatório	Descrição
`debug`	`boolean`	Não	Ativa o modo de debug.
`force`	`boolean`	Não	Declarado pelo tipo. Nenhum exemplo desta página o usa.

AzionDomainsResponse

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

Propriedade	Tipo	Obrigatório	Descrição
`data`	`T`	Não	O resultado da chamada.
`error`	`{ message: string; operation: string }`	Não	A mensagem de erro e a operação que falhou.

AzionDomain

Um domínio.

Propriedade	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	O nome do domínio.
`state`	`ResponseState`	Não	O estado da requisição.
`id`	`number`	Não	O ID do domínio.
`url`	`string`	Não	O endereço Azion do domínio.
`environment`	`string`	Não	O ambiente do domínio, como `production`.
`active`	`boolean`	Não	Indica se o domínio está ativo.
`edgeApplicationId`	`number`	Não	O ID da application para a qual o domínio aponta.
`cnameAccessOnly`	`boolean`	Não	Com `true`, bloqueia o acesso pelo endereço Azion do domínio, de modo que apenas os CNAMEs dele chegam à application.
`cnames`	`string[]`	Não	Os CNAMEs do domínio.
`edgeFirewallId`	`number`	Não	O ID do firewall do domínio. A API retorna `null` quando o domínio não tem um.
`digitalCertificateId`	`string \| number \| null`	Não	O ID do certificado digital do domínio.
`mtls`	`{ verification; trustedCaCertificateId; crlList? }`	Não	As configurações de TLS mútuo do domínio.
`mtls.verification`	`'enforce' \| 'permissive'`	Sim	O modo de verificação do TLS mútuo.
`mtls.trustedCaCertificateId`	`number`	Sim	O ID do certificado de CA confiável.
`mtls.crlList`	`number[]`	Não	Os IDs das listas de revogação de certificados.

AzionCreateDomain

As configurações que createDomain recebe: as propriedades de AzionDomain sem id, environment, active, url e state.

Propriedade	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	O nome do domínio.
`edgeApplicationId`	`number`	Sim	O ID da application para a qual o domínio aponta.
`cnameAccessOnly`	`boolean`	Não	Com `true`, bloqueia o acesso pelo endereço Azion do domínio, de modo que apenas os CNAMEs dele chegam à application.
`cnames`	`string[]`	Não	Os CNAMEs do domínio.
`edgeFirewallId`	`number`	Não	O ID do firewall do domínio.
`digitalCertificateId`	`string \| number \| null`	Não	O ID do certificado digital do domínio.
`mtls`	`{ verification; trustedCaCertificateId; crlList? }`	Não	As configurações de TLS mútuo do domínio.

AzionUpdateDomain

As configurações que updateDomain recebe: as propriedades de AzionDomain sem id, environment, url e state. Ao contrário de AzionCreateDomain, ele recebe active.

Propriedade	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	O nome do domínio.
`edgeApplicationId`	`number`	Sim	O ID da application para a qual o domínio aponta.
`active`	`boolean`	Não	Indica se o domínio está ativo.
`cnameAccessOnly`	`boolean`	Não	Com `true`, bloqueia o acesso pelo endereço Azion do domínio, de modo que apenas os CNAMEs dele chegam à application.
`cnames`	`string[]`	Não	Os CNAMEs do domínio.
`edgeFirewallId`	`number`	Não	O ID do firewall do domínio.
`digitalCertificateId`	`string \| number \| null`	Não	O ID do certificado digital do domínio.
`mtls`	`{ verification; trustedCaCertificateId; crlList? }`	Não	As configurações de TLS mútuo do domínio.

AzionDomainCollection

Uma página de domínios.

Propriedade	Tipo	Obrigatório	Descrição
`state`	`ResponseState`	Sim	O estado da requisição.
`count`	`number`	Sim	O número de domínios da conta.
`pages`	`number`	Sim	O número de páginas.
`results`	`AzionDomain[]`	Sim	Os domínios da página.

AzionDeletedDomain

O resultado de deleteDomain.

Propriedade	Tipo	Obrigatório	Descrição
`id`	`number`	Não	O ID do domínio excluído.
`state`	`ResponseState`	Não	O estado da exclusão.

ResponseState

O estado de uma requisição.

type ResponseState = 'pending' | 'executed' | 'failed';

Recursos relacionados

Azion Lib

As bibliotecas que a Azion Lib oferece e o pacote que contém cada uma.

Client

Um client para Storage, SQL, Purge, Domains, Applications e AI.

Applications

As funções da Azion Lib que criam a application para a qual um domínio aponta.

Domains

Endereços Azion, domínios personalizados, CNAMEs, certificados digitais e mTLS em um domínio.