Skip to main content

AzureArmDeployerParameters

@webda/azure

Class: AzureArmDeployerParameters

Defined in: azure/src/deployers/arm.service.ts:13

Shared ARM and OCI parameters used by Azure deployment units.

Extends​

  • ContainerDeployerParameters

Extended by​

Implements​

Constructors​

Constructor​

new AzureArmDeployerParameters(): AzureArmDeployerParameters

Returns​

AzureArmDeployerParameters

Inherited from​

ContainerDeployerParameters.constructor

Properties​

baseImage​

baseImage: string

Defined in: oci/lib/container.service.d.ts:17

Base image, scratch for none

Default​

"node:22-slim"

Inherited from​

ContainerDeployerParameters.baseImage

clientId?​

optional clientId?: string

Defined in: azure/src/deployers/arm.service.ts:21

Client ID

Implementation of​

AzureServiceParameters.clientId

clientSecret?​

optional clientSecret?: string | SecretString

Defined in: azure/src/deployers/arm.service.ts:25

Client secret

Implementation of​

AzureServiceParameters.clientSecret

cmd​

cmd: string[]

Defined in: oci/lib/container.service.d.ts:50

Command of the image, the arguments of the entrypoint

Default​

["serve", "--bind", "0.0.0.0"]

Inherited from​

ContainerDeployerParameters.cmd

createResourceGroup​

createResourceGroup: boolean = false

Defined in: azure/src/deployers/arm.service.ts:45

Create resource group

credentials​

credentials: Record<string, RegistryCredentials>

Defined in: oci/lib/container.service.d.ts:105

Credentials per registry host, they take precedence over ~/.docker/config.json

Default​

Use templates to read them from the environment: { "ghcr.io": { "username": "${env.GHCR_USER}", "password": "${env.GHCR_TOKEN}" } }

password, identityToken and token can be encrypted with webda config encrypt

Inherited from​

ContainerDeployerParameters.credentials

customResources​

customResources: Record<string, any>[] | Record<string, Record<string, any>> = []

Defined in: azure/src/deployers/arm.service.ts:57

Custom resources

deploymentName?​

optional deploymentName?: string

Defined in: azure/src/deployers/arm.service.ts:49

Deployment name

endpoint?​

optional endpoint?: string

Defined in: azure/src/deployers/arm.service.ts:33

Endpoint

Implementation of​

AzureServiceParameters.endpoint

entrypoint​

entrypoint: string[]

Defined in: oci/lib/container.service.d.ts:44

Entrypoint of the image

Default​

["node", "<workdir>/node_modules/@webda/core/lib/bin/cli.js"]

Inherited from​

ContainerDeployerParameters.entrypoint

env​

env: Record<string, string>

Defined in: oci/lib/container.service.d.ts:56

Environment variables

Default​

{ "NODE_ENV": "production" }

Inherited from​

ContainerDeployerParameters.env

exposedPorts​

exposedPorts: string[]

Defined in: oci/lib/container.service.d.ts:71

Exposed ports

Default​

["18080/tcp"]

Inherited from​

ContainerDeployerParameters.exposedPorts

image?​

optional image?: string

Defined in: oci/lib/container.service.d.ts:23

Repository to push to, without tag: ghcr.io/my-org/my-app

Required to push.

Inherited from​

ContainerDeployerParameters.image

insecureRegistries​

insecureRegistries: string[]

Defined in: oci/lib/container.service.d.ts:110

Registries reached over plain http, localhost and 127.0.0.1 always are

Default​

[]

Inherited from​

ContainerDeployerParameters.insecureRegistries

labels​

labels: Record<string, string>

Defined in: oci/lib/container.service.d.ts:61

Labels, added to the default OCI ones (version, revision, source, title)

Default​

{}

Inherited from​

ContainerDeployerParameters.labels

location​

location: string = "westeurope"

Defined in: azure/src/deployers/arm.service.ts:41

Location

mtime?​

optional mtime?: number

Defined in: oci/lib/container.service.d.ts:96

Modification time of the files and creation time of the image, in seconds

Default​

the SOURCE_DATE_EPOCH environment variable, or 0

Inherited from​

ContainerDeployerParameters.mtime

output​

output: string

Defined in: oci/lib/container.service.d.ts:85

Output of container build: an OCI layout folder, or a tar archive when ending with .tar

Relative to the application folder. The folder keeps the downloaded base layers between builds.

Default​

".webda/oci/${deployer.name}"

Inherited from​

ContainerDeployerParameters.output

package​

package: PackageOptions

Defined in: oci/lib/container.service.d.ts:90

Options of the application packaging

Default​

{}

Inherited from​

ContainerDeployerParameters.package

platforms​

platforms: string[]

Defined in: oci/lib/container.service.d.ts:77

Platforms to build, several platforms produce a multi-platform index

Default​

["linux/amd64"]

Inherited from​

ContainerDeployerParameters.platforms

resourceGroup​

resourceGroup: string

Defined in: azure/src/deployers/arm.service.ts:37

Resource group

resourceTags​

resourceTags: Record<string, string>

Defined in: azure/src/deployers/arm.service.ts:53

Resource tags

subscriptionId​

subscriptionId: string

Defined in: azure/src/deployers/arm.service.ts:29

Subscription ID

Implementation of​

AzureServiceParameters.subscriptionId

tags​

tags: string[]

Defined in: oci/lib/container.service.d.ts:32

Tags of the image

Invalid characters are replaced by -, so the snapshot version 1.2.4+20261004120000 becomes 1.2.4-20261004120000.

Default​

["${git.version}"]

Inherited from​

ContainerDeployerParameters.tags

templateOutput?​

optional templateOutput?: string

Defined in: azure/src/deployers/arm.service.ts:61

Template output

tenantId?​

optional tenantId?: string

Defined in: azure/src/deployers/arm.service.ts:17

Tenant ID

Implementation of​

AzureServiceParameters.tenantId

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ContainerDeployerParameters.type

user?​

optional user?: string

Defined in: oci/lib/container.service.d.ts:65

User the container runs as, the base image one by default

Inherited from​

ContainerDeployerParameters.user

workdir​

workdir: string

Defined in: oci/lib/container.service.d.ts:38

Folder of the application in the image

Default​

"/app"

Inherited from​

ContainerDeployerParameters.workdir

Methods​

load()​

load(params?): this

Defined in: azure/src/deployers/arm.service.ts:67

Perform load.

Parameters​

params?​

any = {}

Returns​

this

Overrides​

ContainerDeployerParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ContainerDeployerParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ContainerDeployerParameters.with