Jobs - Start

Service:

Azure Container Apps

API Version:

2024-03-01

Start a Container Apps Job

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/start?api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
jobName	path	True	string pattern: ^[-\w\._\(\)]+$	Job Name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
containers	JobExecutionContainer[]	List of container definitions for the Container Apps Job.
initContainers	JobExecutionContainer[]	List of specialized containers that run before job containers.

Responses

Name	Type	Description
200 OK	JobExecutionBase	OK
202 Accepted		OK Headers Location: string
Other Status Codes	DefaultErrorResponse	Common error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Run a Container Apps Job

Sample request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0/start?api-version=2024-03-01

{
  "containers": [
    {
      "image": "repo/testcontainerappsjob0:v4",
      "name": "testcontainerappsjob0",
      "resources": {
        "cpu": 0.5,
        "memory": "1Gi"
      }
    }
  ],
  "initContainers": [
    {
      "image": "repo/testcontainerappsjob0:v4",
      "name": "testinitcontainerAppsJob0",
      "resources": {
        "cpu": 0.5,
        "memory": "1Gi"
      },
      "command": [
        "/bin/sh"
      ],
      "args": [
        "-c",
        "while true; do echo hello; sleep 10;done"
      ]
    }
  ]
}

Java

import com.azure.resourcemanager.appcontainers.models.ContainerResources;
import com.azure.resourcemanager.appcontainers.models.JobExecutionContainer;
import com.azure.resourcemanager.appcontainers.models.JobExecutionTemplate;
import java.util.Arrays;

/**
 * Samples for Jobs Start.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Job_Start.json
     */
    /**
     * Sample code: Run a Container Apps Job.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void runAContainerAppsJob(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.jobs().start("rg", "testcontainerappsjob0",
            new JobExecutionTemplate()
                .withContainers(Arrays.asList(new JobExecutionContainer().withImage("repo/testcontainerappsjob0:v4")
                    .withName("testcontainerappsjob0")
                    .withResources(new ContainerResources().withCpu(0.5D).withMemory("1Gi"))))
                .withInitContainers(Arrays.asList(new JobExecutionContainer().withImage("repo/testcontainerappsjob0:v4")
                    .withName("testinitcontainerAppsJob0").withCommand(Arrays.asList("/bin/sh"))
                    .withArgs(Arrays.asList("-c", "while true; do echo hello; sleep 10;done"))
                    .withResources(new ContainerResources().withCpu(0.5D).withMemory("1Gi")))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python job_start.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.jobs.begin_start(
        resource_group_name="rg",
        job_name="testcontainerappsjob0",
    ).result()
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Job_Start.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0/specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Job_Start.json
func ExampleJobsClient_BeginStart() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewJobsClient().BeginStart(ctx, "rg", "testcontainerappsjob0", &armappcontainers.JobsClientBeginStartOptions{Template: &armappcontainers.JobExecutionTemplate{
		Containers: []*armappcontainers.JobExecutionContainer{
			{
				Name:  to.Ptr("testcontainerappsjob0"),
				Image: to.Ptr("repo/testcontainerappsjob0:v4"),
				Resources: &armappcontainers.ContainerResources{
					CPU:    to.Ptr[float64](0.5),
					Memory: to.Ptr("1Gi"),
				},
			}},
		InitContainers: []*armappcontainers.JobExecutionContainer{
			{
				Name: to.Ptr("testinitcontainerAppsJob0"),
				Args: []*string{
					to.Ptr("-c"),
					to.Ptr("while true; do echo hello; sleep 10;done")},
				Command: []*string{
					to.Ptr("/bin/sh")},
				Image: to.Ptr("repo/testcontainerappsjob0:v4"),
				Resources: &armappcontainers.ContainerResources{
					CPU:    to.Ptr[float64](0.5),
					Memory: to.Ptr("1Gi"),
				},
			}},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.JobExecutionBase = armappcontainers.JobExecutionBase{
	// 	Name: to.Ptr("testcontainerappsjob0-pjxhsye"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Start a Container Apps Job
 *
 * @summary Start a Container Apps Job
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Job_Start.json
 */
async function runAContainerAppsJob() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPCONTAINERS_RESOURCE_GROUP"] || "rg";
  const jobName = "testcontainerappsjob0";
  const template = {
    containers: [
      {
        name: "testcontainerappsjob0",
        image: "repo/testcontainerappsjob0:v4",
        resources: { cpu: 0.5, memory: "1Gi" },
      },
    ],
    initContainers: [
      {
        name: "testinitcontainerAppsJob0",
        args: ["-c", "while true; do echo hello; sleep 10;done"],
        command: ["/bin/sh"],
        image: "repo/testcontainerappsjob0:v4",
        resources: { cpu: 0.5, memory: "1Gi" },
      },
    ],
  };
  const options = { template };
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.jobs.beginStartAndWait(resourceGroupName, jobName, options);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/Job_Start.json
// this example is just showing the usage of "Jobs_Start" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppJobResource created on azure
// for more information of creating ContainerAppJobResource, please refer to the document of ContainerAppJobResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string jobName = "testcontainerappsjob0";
ResourceIdentifier containerAppJobResourceId = ContainerAppJobResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, jobName);
ContainerAppJobResource containerAppJob = client.GetContainerAppJobResource(containerAppJobResourceId);

// invoke the operation
ContainerAppJobExecutionTemplate template = new ContainerAppJobExecutionTemplate()
{
    Containers =
    {
    new JobExecutionContainer()
    {
    Image = "repo/testcontainerappsjob0:v4",
    Name = "testcontainerappsjob0",
    Resources = new AppContainerResources()
    {
    Cpu = 0.5,
    Memory = "1Gi",
    },
    }
    },
    InitContainers =
    {
    new JobExecutionContainer()
    {
    Image = "repo/testcontainerappsjob0:v4",
    Name = "testinitcontainerAppsJob0",
    Command =
    {
    "/bin/sh"
    },
    Args =
    {
    "-c","while true; do echo hello; sleep 10;done"
    },
    Resources = new AppContainerResources()
    {
    Cpu = 0.5,
    Memory = "1Gi",
    },
    }
    },
};
ArmOperation<ContainerAppJobExecutionBase> lro = await containerAppJob.StartAsync(WaitUntil.Completed, template: template);
ContainerAppJobExecutionBase result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "testcontainerappsjob0-pjxhsye",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}"
}

Status code:

202

Location: location

Definitions

Name	Description
ContainerResources	Container App container resource requirements.
DefaultErrorResponse	App Service error response.
Details	Details or the error
EnvironmentVar	Container App container environment variable.
Error	Error model.
JobExecutionBase	Container App's Job execution name.
JobExecutionContainer	Container Apps Jobs execution container definition.
JobExecutionTemplate	Job's execution template, containing container configuration for a job's execution

ContainerResources

Object

Container App container resource requirements.

Name	Type	Description
cpu	number (double)	Required CPU in cores, e.g. 0.5
ephemeralStorage	string	Ephemeral Storage, e.g. "1Gi"
memory	string	Required memory, e.g. "250Mb"

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Object

Details or the error

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

EnvironmentVar

Object

Container App container environment variable.

Name	Type	Description
name	string	Environment variable name.
secretRef	string	Name of the Container App secret from which to pull the environment variable value.
value	string	Non-secret environment variable value.

Error

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Details or the error
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

JobExecutionBase

Object

Container App's Job execution name.

Name	Type	Description
id	string	Job execution Id.
name	string	Job execution name.

JobExecutionContainer

Object

Container Apps Jobs execution container definition.

Name	Type	Description
args	string[]	Container start command arguments.
command	string[]	Container start command.
env	EnvironmentVar[]	Container environment variables.
image	string	Container image tag.
name	string	Custom container name.
resources	ContainerResources	Container resource requirements.

JobExecutionTemplate

Object

Job's execution template, containing container configuration for a job's execution

Name	Type	Description
containers	JobExecutionContainer[]	List of container definitions for the Container Apps Job.
initContainers	JobExecutionContainer[]	List of specialized containers that run before job containers.