AzCLI

Execute one or more az commands from a Command Line Interface. We recommend using a Service Principal and a Client Secret for authentication. To create a Service Principal and Client Secret, you can use the following documentation. Then, use the generated appId as the username and the generated password as the password in the Kestra task configuration. Finally, pass the returned tenantId to the tenant field in the Kestra task configuration and set servicePrincipal to true.

yaml
type: "io.kestra.plugin.azure.cli.AzCLI"

List Azure Active Directory users for the currently authenticated tenant.

yaml
id: azure_cli
namespace: company.team

tasks:
  - id: az_cli
    type: io.kestra.plugin.azure.cli.AzCLI
    username: "azure_app_id"
    password: "{{ secret('AZURE_SERVICE_PRINCIPAL_PASSWORD') }}"
    tenant: "{{ secret('AZURE_TENANT_ID') }}"
    commands:
      - az ad user list

List all successfully provisioned VMs using a Service Principal authentication.

yaml
id: azure_cli
namespace: company.team

tasks:
  - id: az_cli
    type: io.kestra.plugin.azure.cli.AzCLI
    username: "azure_app_id"
    password: "{{ secret('AZURE_SERVICE_PRINCIPAL_PASSWORD') }}"
    tenant: "{{ secret('AZURE_TENANT_ID') }}"
    servicePrincipal: true
    commands:
      - az vm list --query "[?provisioningState=='Succeeded']"

Command without authentication.

yaml
id: azure_cli
namespace: company.team

tasks:
  - id: az_cli
    type: io.kestra.plugin.azure.cli.AzCLI
    commands:
      - az --help

List supported regions for the current Azure subscription.

yaml
id: azure_cli
namespace: company.team

tasks:
  - id: list_locations
    type: io.kestra.plugin.azure.cli.AzCLI
    tenant: "{{ secret('AZURE_TENANT_ID') }}"
    username: "{{ secret('AZURE_SERVICE_PRINCIPAL_CLIENT_ID') }}"
    password: "{{ secret('AZURE_SERVICE_PRINCIPAL_PASSWORD') }}"
    servicePrincipal: true
    commands:
      - az account list-locations --query "[].{Region:name}" -o table

SubType string

Dynamic YES

The commands to run.

Dynamic YES

Default mcr.microsoft.com/azure-cli

The task runner container image, only used if the task runner is container-based.

Dynamic NO

Deprecated, use 'taskRunner' instead

SubType string

Dynamic YES

Additional environment variables for the current process.

Dynamic YES

The files to create on the local filesystem. It can be a map or a JSON object.

Dynamic NO

Inject namespace files.

Inject namespace files to this task. When enabled, it will, by default, load all namespace files into the working directory. However, you can use the include or exclude properties to limit which namespace files will be injected.

SubType string

Dynamic YES

The files from the local filesystem to send to Kestra's internal storage.

Must be a list of glob expressions relative to the current working directory, some examples: my-dir/**, my-dir/*/** or my-dir/my-file.txt.

Dynamic YES

Account password.

Dynamic YES

Dynamic NO

Default

{
  "type": "io.kestra.plugin.scripts.runner.docker.Docker"
}

The task runner to use.

Task runners are provided by plugins, each have their own properties.

Dynamic YES

Tenant ID to use.

Dynamic YES

Account username. If set, it will use az login before running the commands.

Default 0

The exit code of the entire flow execution.

SubType string

The output files' URIs in Kestra's internal storage.

The value extracted from the output of the executed commands.

Dynamic YES

Default true

SubType string

Dynamic YES

A list of filters to exclude matching glob patterns. This allows you to exclude a subset of the Namespace Files from being downloaded at runtime. You can combine this property together with include to only inject a subset of files that you need into the task's working directory.

SubType string

Dynamic YES

A list of filters to include only matching glob patterns. This allows you to only load a subset of the Namespace Files into the working directory.

Dynamic YES

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4MB. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See the kernel-memory docs for more details.

Dynamic YES

The maximum amount of memory resources the container can use.

Make sure to use the format number + unit (regardless of the case) without any spaces. The unit can be KB (kilobytes), MB (megabytes), GB (gigabytes), etc.

Given that it's case-insensitive, the following values are equivalent:

"512MB"
"512Mb"
"512mb"
"512000KB"
"0.5GB"

It is recommended that you allocate at least 6MB.

Dynamic YES

Allows you to specify a soft limit smaller than memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

Dynamic YES

The total amount of memory and swap that can be used by a container.

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap includes both the physical memory and swap space, while memory is only the amount of physical memory that can be used.

Dynamic YES

A setting which controls the likelihood of the kernel to swap memory pages.

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100 to tune this percentage.

Dynamic YES

Min length 1

Docker image to use.

Dynamic YES

Docker configuration file.

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.

Dynamic NO

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

Dynamic YES

SubType

Dynamic NO

A list of device requests to be sent to device drivers.

SubType string

Dynamic YES

Docker entrypoint to use.

SubType string

Dynamic YES

Extra hostname mappings to the container network interface configuration.

Dynamic YES

Docker API URI.

Dynamic NO

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

Dynamic YES

Docker network mode to use e.g. host, none, etc.

Dynamic YES

Default ALWAYS

Possible Values

IF_NOT_PRESENTALWAYSNEVER

The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.

Dynamic YES

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted, the system uses 64MB.

Dynamic YES

User in the Docker container.

SubType string

Dynamic YES

List of volumes to mount.

Must be a valid mount expression as string, example : /home/user:/app.

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true.

Dynamic YES

The registry authentication.

The auth field is a base64-encoded authentication string of username: password or a token.

Dynamic YES

The identity token.

Dynamic YES

The registry password.

Dynamic YES

The registry URL.

If not defined, the registry will be extracted from the image name.

Dynamic YES

The registry token.

Dynamic YES

The registry username.

SubType array

Dynamic YES

A list of capabilities; an OR list of AND lists of capabilities.

Dynamic YES

SubType string

Dynamic YES

SubType string

Dynamic YES

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

​Az​C​L​I

AzCLI