Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. mssql
  5. Job

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.mssql.Job

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages an Elastic Job.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resource-group",
    location: "East US",
});
const exampleServer = new azure.mssql.Server("example", {
    name: "example-server",
    resourceGroupName: example.name,
    location: example.location,
    version: "12.0",
    administratorLogin: "4dm1n157r470r",
    administratorLoginPassword: "4-v3ry-53cr37-p455w0rd",
});
const exampleDatabase = new azure.mssql.Database("example", {
    name: "example-db",
    serverId: exampleServer.id,
    collation: "SQL_Latin1_General_CP1_CI_AS",
    skuName: "S1",
});
const exampleJobAgent = new azure.mssql.JobAgent("example", {
    name: "example-job-agent",
    location: example.location,
    databaseId: exampleDatabase.id,
});
const exampleJobCredential = new azure.mssql.JobCredential("example", {
    name: "example-job-credential",
    jobAgentId: exampleJobAgent.id,
    username: "my-username",
    password: "MyP4ssw0rd!!!",
});
const exampleJob = new azure.mssql.Job("example", {
    name: "example-job",
    jobAgentId: exampleJobAgent.id,
    description: "example description",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resource-group",
    location="East US")
example_server = azure.mssql.Server("example",
    name="example-server",
    resource_group_name=example.name,
    location=example.location,
    version="12.0",
    administrator_login="4dm1n157r470r",
    administrator_login_password="4-v3ry-53cr37-p455w0rd")
example_database = azure.mssql.Database("example",
    name="example-db",
    server_id=example_server.id,
    collation="SQL_Latin1_General_CP1_CI_AS",
    sku_name="S1")
example_job_agent = azure.mssql.JobAgent("example",
    name="example-job-agent",
    location=example.location,
    database_id=example_database.id)
example_job_credential = azure.mssql.JobCredential("example",
    name="example-job-credential",
    job_agent_id=example_job_agent.id,
    username="my-username",
    password="MyP4ssw0rd!!!")
example_job = azure.mssql.Job("example",
    name="example-job",
    job_agent_id=example_job_agent.id,
    description="example description")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/mssql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resource-group"),
			Location: pulumi.String("East US"),
		})
		if err != nil {
			return err
		}
		exampleServer, err := mssql.NewServer(ctx, "example", &mssql.ServerArgs{
			Name:                       pulumi.String("example-server"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			Version:                    pulumi.String("12.0"),
			AdministratorLogin:         pulumi.String("4dm1n157r470r"),
			AdministratorLoginPassword: pulumi.String("4-v3ry-53cr37-p455w0rd"),
		})
		if err != nil {
			return err
		}
		exampleDatabase, err := mssql.NewDatabase(ctx, "example", &mssql.DatabaseArgs{
			Name:      pulumi.String("example-db"),
			ServerId:  exampleServer.ID(),
			Collation: pulumi.String("SQL_Latin1_General_CP1_CI_AS"),
			SkuName:   pulumi.String("S1"),
		})
		if err != nil {
			return err
		}
		exampleJobAgent, err := mssql.NewJobAgent(ctx, "example", &mssql.JobAgentArgs{
			Name:       pulumi.String("example-job-agent"),
			Location:   example.Location,
			DatabaseId: exampleDatabase.ID(),
		})
		if err != nil {
			return err
		}
		_, err = mssql.NewJobCredential(ctx, "example", &mssql.JobCredentialArgs{
			Name:       pulumi.String("example-job-credential"),
			JobAgentId: exampleJobAgent.ID(),
			Username:   pulumi.String("my-username"),
			Password:   pulumi.String("MyP4ssw0rd!!!"),
		})
		if err != nil {
			return err
		}
		_, err = mssql.NewJob(ctx, "example", &mssql.JobArgs{
			Name:        pulumi.String("example-job"),
			JobAgentId:  exampleJobAgent.ID(),
			Description: pulumi.String("example description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resource-group",
        Location = "East US",
    });

    var exampleServer = new Azure.MSSql.Server("example", new()
    {
        Name = "example-server",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Version = "12.0",
        AdministratorLogin = "4dm1n157r470r",
        AdministratorLoginPassword = "4-v3ry-53cr37-p455w0rd",
    });

    var exampleDatabase = new Azure.MSSql.Database("example", new()
    {
        Name = "example-db",
        ServerId = exampleServer.Id,
        Collation = "SQL_Latin1_General_CP1_CI_AS",
        SkuName = "S1",
    });

    var exampleJobAgent = new Azure.MSSql.JobAgent("example", new()
    {
        Name = "example-job-agent",
        Location = example.Location,
        DatabaseId = exampleDatabase.Id,
    });

    var exampleJobCredential = new Azure.MSSql.JobCredential("example", new()
    {
        Name = "example-job-credential",
        JobAgentId = exampleJobAgent.Id,
        Username = "my-username",
        Password = "MyP4ssw0rd!!!",
    });

    var exampleJob = new Azure.MSSql.Job("example", new()
    {
        Name = "example-job",
        JobAgentId = exampleJobAgent.Id,
        Description = "example description",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.mssql.Server;
import com.pulumi.azure.mssql.ServerArgs;
import com.pulumi.azure.mssql.Database;
import com.pulumi.azure.mssql.DatabaseArgs;
import com.pulumi.azure.mssql.JobAgent;
import com.pulumi.azure.mssql.JobAgentArgs;
import com.pulumi.azure.mssql.JobCredential;
import com.pulumi.azure.mssql.JobCredentialArgs;
import com.pulumi.azure.mssql.Job;
import com.pulumi.azure.mssql.JobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resource-group")
            .location("East US")
            .build());

        var exampleServer = new Server("exampleServer", ServerArgs.builder()
            .name("example-server")
            .resourceGroupName(example.name())
            .location(example.location())
            .version("12.0")
            .administratorLogin("4dm1n157r470r")
            .administratorLoginPassword("4-v3ry-53cr37-p455w0rd")
            .build());

        var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
            .name("example-db")
            .serverId(exampleServer.id())
            .collation("SQL_Latin1_General_CP1_CI_AS")
            .skuName("S1")
            .build());

        var exampleJobAgent = new JobAgent("exampleJobAgent", JobAgentArgs.builder()
            .name("example-job-agent")
            .location(example.location())
            .databaseId(exampleDatabase.id())
            .build());

        var exampleJobCredential = new JobCredential("exampleJobCredential", JobCredentialArgs.builder()
            .name("example-job-credential")
            .jobAgentId(exampleJobAgent.id())
            .username("my-username")
            .password("MyP4ssw0rd!!!")
            .build());

        var exampleJob = new Job("exampleJob", JobArgs.builder()
            .name("example-job")
            .jobAgentId(exampleJobAgent.id())
            .description("example description")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resource-group
      location: East US
  exampleServer:
    type: azure:mssql:Server
    name: example
    properties:
      name: example-server
      resourceGroupName: ${example.name}
      location: ${example.location}
      version: '12.0'
      administratorLogin: 4dm1n157r470r
      administratorLoginPassword: 4-v3ry-53cr37-p455w0rd
  exampleDatabase:
    type: azure:mssql:Database
    name: example
    properties:
      name: example-db
      serverId: ${exampleServer.id}
      collation: SQL_Latin1_General_CP1_CI_AS
      skuName: S1
  exampleJobAgent:
    type: azure:mssql:JobAgent
    name: example
    properties:
      name: example-job-agent
      location: ${example.location}
      databaseId: ${exampleDatabase.id}
  exampleJobCredential:
    type: azure:mssql:JobCredential
    name: example
    properties:
      name: example-job-credential
      jobAgentId: ${exampleJobAgent.id}
      username: my-username
      password: MyP4ssw0rd!!!
  exampleJob:
    type: azure:mssql:Job
    name: example
    properties:
      name: example-job
      jobAgentId: ${exampleJobAgent.id}
      description: example description

    Create Job Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Job(name: string, args: JobArgs, opts?: CustomResourceOptions);
    @overload
def Job(resource_name: str,
        args: JobArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Job(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        job_agent_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None)
    func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)
    public Job(string name, JobArgs args, CustomResourceOptions? opts = null)
    public Job(String name, JobArgs args)
public Job(String name, JobArgs args, CustomResourceOptions options)

    type: azure:mssql:Job
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var examplejobResourceResourceFromMssqljob = new Azure.MSSql.Job("examplejobResourceResourceFromMssqljob", new()
{
    JobAgentId = "string",
    Description = "string",
    Name = "string",
});

    example, err := mssql.NewJob(ctx, "examplejobResourceResourceFromMssqljob", &mssql.JobArgs{
	JobAgentId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var examplejobResourceResourceFromMssqljob = new Job("examplejobResourceResourceFromMssqljob", JobArgs.builder()
    .jobAgentId("string")
    .description("string")
    .name("string")
    .build());

    examplejob_resource_resource_from_mssqljob = azure.mssql.Job("examplejobResourceResourceFromMssqljob",
    job_agent_id="string",
    description="string",
    name="string")

    const examplejobResourceResourceFromMssqljob = new azure.mssql.Job("examplejobResourceResourceFromMssqljob", {
    jobAgentId: "string",
    description: "string",
    name: "string",
});

    type: azure:mssql:Job
properties:
    description: string
    jobAgentId: string
    name: string

    Job Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Job resource accepts the following input properties:

    JobAgentId string
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    Description string
    The description of the Elastic Job.
    Name string
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    JobAgentId string
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    Description string
    The description of the Elastic Job.
    Name string
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    jobAgentId String
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    description String
    The description of the Elastic Job.
    name String
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    jobAgentId string
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    description string
    The description of the Elastic Job.
    name string
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    job_agent_id str
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    description str
    The description of the Elastic Job.
    name str
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    jobAgentId String
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    description String
    The description of the Elastic Job.
    name String
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Job Resource

    Get an existing Job resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: JobState, opts?: CustomResourceOptions): Job
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        job_agent_id: Optional[str] = None,
        name: Optional[str] = None) -> Job
    func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)
    public static Job Get(string name, Input<string> id, JobState? state, CustomResourceOptions? opts = null)
    public static Job get(String name, Output<String> id, JobState state, CustomResourceOptions options)
    resources:  _:    type: azure:mssql:Job    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the Elastic Job.
    JobAgentId string
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    Name string
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    Description string
    The description of the Elastic Job.
    JobAgentId string
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    Name string
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    description String
    The description of the Elastic Job.
    jobAgentId String
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    name String
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    description string
    The description of the Elastic Job.
    jobAgentId string
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    name string
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    description str
    The description of the Elastic Job.
    job_agent_id str
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    name str
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.
    description String
    The description of the Elastic Job.
    jobAgentId String
    The ID of the Elastic Job Agent. Changing this forces a new Elastic Job to be created.
    name String
    The name which should be used for this Elastic Job. Changing this forces a new Elastic Job to be created.

    Import

    Elastic Jobs can be imported using the resource id, e.g.

    $ pulumi import azure:mssql/job:Job example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Sql/servers/myserver1/jobAgents/myjobagent1/jobs/myjob1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure