Azure Container Apps のジョブ

Azure CLI を使って手動ジョブを作成するには、az containerapp job create コマンドを使います。 次の例では、my-resource-group というリソース グループと my-environment という Container Apps 環境内に my-job という手動ジョブを作成します。

az containerapp job create \
    --name "my-job" --resource-group "my-resource-group"  --environment "my-environment" \
    --trigger-type "Manual" \
    --replica-timeout 1800 \
    --image "mcr.microsoft.com/k8se/quickstart-jobs:latest" \
    --cpu "0.25" --memory "0.5Gi"

次の例の Azure Resource Manager テンプレートでは、my-resource-group というリソース グループと my-environment という Container Apps 環境内に my-job という手動ジョブを作成します。

{
    "location": "North Central US",
    "name": "my-job",
    "properties": {
        "configuration": {
            "manualTriggerConfig": {
                "parallelism": 1,
                "replicaCompletionCount": 1
            },
            "replicaRetryLimit": 0,
            "replicaTimeout": 1800,
            "triggerType": "Manual"
        },
        "environmentId": "/subscriptions/<subscription_id>/resourceGroups/my-resource-group/providers/Microsoft.App/managedEnvironments/my-environment",
        "template": {
            "containers": [
                {
                    "image": "mcr.microsoft.com/k8se/quickstart-jobs:latest",
                    "name": "main",
                    "resources": {
                        "cpu": 0.25,
                        "memory": "0.5Gi"
                    }
                }
            ]
        }
    }
}

Azure portal を使用して手動ジョブを作成するには、Azure portal で Container App Jobs を検索し、[作成]を選択します。 トリガーの種類として[マニュアル] を指定します。

サンプル コンテナー イメージを使用するには、[コンテナー] タブに次の値を入力します。

Azure CLI を使ってスケジュール ジョブを作成するには、az containerapp job create コマンドを使います。 次の例では、my-resource-group というリソース グループと my-environment という Container Apps 環境内に my-job というスケジュール ジョブを作成します。

az containerapp job create \
    --name "my-job" --resource-group "my-resource-group"  --environment "my-environment" \
    --trigger-type "Schedule" \
    --replica-timeout 1800 \
    --image "mcr.microsoft.com/k8se/quickstart-jobs:latest" \
    --cpu "0.25" --memory "0.5Gi" \
    --cron-expression "*/1 * * * *"

次の例の Azure Resource Manager テンプレートでは、my-resource-group というリソース グループと my-environment という Container Apps 環境内に my-job という手動ジョブを作成します。

{
    "location": "North Central US",
    "name": "my-job",
    "properties": {
        "configuration": {
            "scheduleTriggerConfig": {
                "cronExpression": "*/1 * * * *",
                "parallelism": 1,
                "replicaCompletionCount": 1
            },
            "replicaRetryLimit": 0,
            "replicaTimeout": 1800,
            "triggerType": "Schedule"
        },
        "environmentId": "/subscriptions/<subscription_id>/resourceGroups/my-resource-group/providers/Microsoft.App/managedEnvironments/my-environment",
        "template": {
            "containers": [
                {
                    "image": "mcr.microsoft.com/k8se/quickstart-jobs:latest",
                    "name": "main",
                    "resources": {
                        "cpu": 0.25,
                        "memory": "0.5Gi"
                    }
                }
            ]
        }
    }
}

Azure portal を使用してスケジュール ジョブを作成するには、Azure portal で Container App Jobs を検索し、[作成]を選択します。 トリガーの種類として [スケジュール] を指定し、毎分実行する */1 * * * * など、cron 式を使用してスケジュールを定義します。

サンプル コンテナー イメージを使用するには、[コンテナー] タブに次の値を入力します。

Azure CLI を使ってイベントドリブン ジョブを作成するには、az containerapp job create コマンドを使います。 次の例では、my-resource-group というリソース グループと my-environment という Container Apps 環境内に my-job というイベントドリブン ジョブを作成します。

az containerapp job create \
    --name "my-job" --resource-group "my-resource-group"  --environment "my-environment" \
    --trigger-type "Event" \
    --replica-timeout 1800 \
    --image "docker.io/myuser/my-event-driven-job:latest" \
    --cpu "0.25" --memory "0.5Gi" \
    --min-executions "0" \
    --max-executions "10" \
    --scale-rule-name "queue" \
    --scale-rule-type "azure-queue" \
    --scale-rule-metadata "accountName=mystorage" "queueName=myqueue" "queueLength=1" \
    --scale-rule-auth "connection=connection-string-secret" \
    --secrets "connection-string-secret=<QUEUE_CONNECTION_STRING>"

この例では、Azure Storage キュー スケール ルールを構成します。

次の例の Azure Resource Manager テンプレートでは、my-resource-group というリソース グループと my-environment という Container Apps 環境内に my-job というイベントドリブン ジョブを作成します。

{
    "location": "North Central US",
    "name": "my-job",
    "properties": {
        "configuration": {
            "eventTriggerConfig": {
                "scale": {
                    "maxExecutions": 10,
                    "minExecutions": 0,
                    "pollingInterval": 15,
                    "rules": [
                        {
                            "auth": [
                                {
                                    "triggerParameter": "connection",
                                    "secretRef": "connection-string-secret"
                                }
                            ],
                            "metadata": {
                                "accountName": "mystorage",
                                "queueLength": 1,
                                "queueName": "myqueue"
                            },
                            "name": "queue",
                            "type": "azure-queue"
                        }
                    ]
                }
            },
            "replicaRetryLimit": 0,
            "replicaTimeout": 1800,
            "triggerType": "Event",
            "secrets": [
                {
                    "name": "connection-string-secret",
                    "value": "<QUEUE_CONNECTION_STRING>"
                }
            ]
        },
        "environmentId": "/subscriptions/<subscription_id>/resourceGroups/my-resource-group/providers/Microsoft.App/managedEnvironments/my-environment",
        "template": {
            "containers": [
                {
                    "image": "docker.io/myuser/my-event-driven-job:latest",
                    "name": "main",
                    "resources": {
                        "cpu": 0.25,
                        "memory": "0.5Gi"
                    }
                }
            ]
        }
    }
}

この例では、Azure Storage キュー スケール ルールを構成します。

Azure portal を使用してイベント ドリブン ジョブを作成するには、Azure portal で Container App Jobs を検索し、[作成]を選択します。 トリガーの種類として[イベント] を指定し、スケーリング ルールを構成します。

Azure CLI を使ってジョブの実行を開始するには、az containerapp job start コマンドを使います。 次の例では、my-resource-group というリソース グループの my-job というジョブの実行を開始します。

az containerapp job start --name "my-job" --resource-group "my-resource-group"

Azure Resource Manager REST API を使ってジョブの実行を開始するには、ジョブの start 操作に対して POST 要求を行います。

次の例では、my-resource-group というリソース グループの my-job というジョブの実行を開始します。

POST https://management.azure.com/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/my-resource-group/providers/Microsoft.App/jobs/my-job/start?api-version=2023-05-01
Authorization: Bearer <TOKEN>

<SUBSCRIPTION_ID> は、サブスクリプション ID で置き換えてください。

要求を認証するには、Authorization ヘッダーの <TOKEN> を有効なベアラー トークンに置き換えます。 トークンの生成に使用される ID には、Container Apps ジョブ リソースに対する Contributor アクセス許可が必要です。 詳細については、「Azure REST API リファレンス」を参照してください。

Azure portal でジョブ実行を開始するには、ジョブの概要ページで [今すぐ実行] を選択します。

実行の開始時にジョブの構成をオーバーライドするには、 az containerapp job start コマンドを使用し、実行に使用するテンプレートを含む YAML ファイルを渡します。 次の例では、my-resource-group というリソース グループの my-job というジョブの実行を開始します。

az containerapp job show コマンドを使用して現在のジョブの構成を取得し、テンプレートを my-job-template.yaml という名前のファイルに保存します。

az containerapp job show --name "my-job" --resource-group "my-resource-group" --query "properties.template" --output yaml > my-job-template.yaml

--query "properties.template" オプションによって、ジョブのテンプレート構成のみが返されます。

my-job-template.yaml ファイルを編集して、ジョブの構成をオーバーライドします。 たとえば、環境変数をオーバーライドするには、 env セクションを変更します。

containers:
- name: print-hello
  image: ubuntu
  resources:
    cpu: 1
    memory: 2Gi
  env:
  - name: MY_NAME
    value: Azure Container Apps jobs
  args:
  - /bin/bash
  - -c
  - echo "Hello, $MY_NAME!"

次のテンプレートを使用してジョブを開始します。

az containerapp job start --name "my-job" --resource-group "my-resource-group" \
    --yaml my-job-template.yaml

ジョブの構成をオーバーライドするには、要求本文にテンプレートを含めます。 次の例では、スタートアップ コマンドをオーバーライドして別のコマンドを実行します。

POST https://management.azure.com/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/my-resource-group/providers/Microsoft.App/jobs/my-job/start?api-version=2023-05-01
Content-Type: application/json
Authorization: Bearer <TOKEN>

{
    "template": {
        "containers": [
            {
                "image": "mcr.microsoft.com/k8se/quickstart-jobs:latest",
                "name": "main",
                "resources": {
                    "cpu": 0.25,
                    "memory": "0.5Gi"
                },
                "command": [
                    "echo",
                    "Hello, Azure Container Apps jobs!"
                ]
            }
        ]
    }
}

<SUBSCRIPTION_ID> を自分のサブスクリプション ID に、Authorization ヘッダーの <TOKEN> を有効なベアラー トークンに置き換えます。 トークンの生成に使用される ID には、Container Apps ジョブ リソースに対する Contributor アクセス許可が必要です。 詳細については、「Azure REST API リファレンス」を参照してください。

オーバーライドされた構成でジョブ実行を開始することは、Azure portal ではサポートされていません。

Azure CLI を使ってジョブの実行状態を取得するには、az containerapp job execution list コマンドを使います。 次の例は、my-resource-group というリソース グループ内の my-job というジョブの直近の実行状態を返します。

az containerapp job execution list --name "my-job" --resource-group "my-resource-group"

Azure Resource Manager REST API を使ってジョブの状態を取得するには、ジョブの executions 操作に対して GET 要求を行います。 次の例は、my-resource-group というリソース グループ内の my-job というジョブの直近の実行状態を返します。

GET https://management.azure.com/subscriptions/<SUBSCRIPTION_ID>/resourceGroups/my-resource-group/providers/Microsoft.App/jobs/my-job/executions?api-version=2023-05-01

<SUBSCRIPTION_ID> は、サブスクリプション ID で置き換えてください。

要求を認証するには、有効なベアラー トークンを指定した Authorization ヘッダーを使います。 詳細については、「Azure REST API リファレンス」を参照してください。

Azure portal を使用してジョブ実行の状態を表示するには、Azure portal で Container App Jobs を検索し、該当するジョブを選択します。 [実行履歴] タブには、直近の実行の状態が表示されます。

次の例では、高度な構成オプションを指定したジョブを作成します。

az containerapp job create \
    --name "my-job" --resource-group "my-resource-group"  --environment "my-environment" \
    --trigger-type "Schedule" \
    --replica-timeout 1800 --replica-retry-limit 3 --replica-completion-count 5 --parallelism 5 \
    --image "myregistry.azurecr.io/quickstart-jobs:latest" \
    --cpu "0.25" --memory "0.5Gi" \
    --command "/startup.sh" \
    --env-vars "MY_ENV_VAR=my-value" \
    --cron-expression "0 0 * * *"  \
    --registry-server "myregistry.azurecr.io" \
    --registry-username "myregistry" \
    --registry-password "myregistrypassword"

次の例の Azure Resource Manager テンプレートを使うと、高度な構成オプションを指定したジョブを作成できます。

{
    "location": "North Central US",
    "name": "my-job",
    "properties": {
        "configuration": {
            "scheduleTriggerConfig": {
                "cronExpression": "0 0 * * *",
                "parallelism": 5,
                "replicaCompletionCount": 5
            },
            "replicaRetryLimit": 3,
            "replicaTimeout": 1800,
            "triggerType": "Schedule",
            "secrets": [
                {
                    "name": "registry-password",
                    "value": "myregistrypassword"
                }
            ]
            "registries": [
                {
                    "server": "myregistry.azurecr.io",
                    "username": "myregistry",
                    "passwordSecretRef": "registry-password"
                }
            ]
        },
        "environmentId": "/subscriptions/<subscription_id>/resourceGroups/my-resource-group/providers/Microsoft.App/managedEnvironments/my-environment",
        "template": {
            "containers": [
                {
                    "command": [
                        "/startup.sh"
                    ],
                    "cpu": 0.25,
                    "envVars": [
                        {
                            "name": "MY_ENV_VAR",
                            "value": "my-value"
                        }
                    ],
                    "image": "myregistry.azurecr.io/quickstart-jobs:latest",
                    "memory": "0.5Gi",
                    "name": "main",
                    "resources": {
                        "cpu": 0.25,
                        "memory": "0.5Gi"
                    }
                }
            ]
        }
    }
}

Azure portal を使用して詳細設定を構成するには、Azure portal で Container App Jobs を検索し、[作成] を選択します。 設定を構成するには、[構成] を選びます。