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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.mssql.JobCredential

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Elastic Job Credential.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example",
    location: "northeurope",
});
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-credential",
    jobAgentId: exampleJobAgent.id,
    username: "my-username",
    password: "MyP4ssw0rd!!!",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example",
    location="northeurope")
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-credential",
    job_agent_id=example_job_agent.id,
    username="my-username",
    password="MyP4ssw0rd!!!")
Copy
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"),
			Location: pulumi.String("northeurope"),
		})
		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-credential"),
			JobAgentId: exampleJobAgent.ID(),
			Username:   pulumi.String("my-username"),
			Password:   pulumi.String("MyP4ssw0rd!!!"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
        Location = "northeurope",
    });

    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-credential",
        JobAgentId = exampleJobAgent.Id,
        Username = "my-username",
        Password = "MyP4ssw0rd!!!",
    });

});
Copy
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 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")
            .location("northeurope")
            .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-credential")
            .jobAgentId(exampleJobAgent.id())
            .username("my-username")
            .password("MyP4ssw0rd!!!")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example
      location: northeurope
  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-credential
      jobAgentId: ${exampleJobAgent.id}
      username: my-username
      password: MyP4ssw0rd!!!
Copy

Create JobCredential Resource

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

Constructor syntax

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

@overload
def JobCredential(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  job_agent_id: Optional[str] = None,
                  username: Optional[str] = None,
                  name: Optional[str] = None,
                  password: Optional[str] = None,
                  password_wo_version: Optional[int] = None)
func NewJobCredential(ctx *Context, name string, args JobCredentialArgs, opts ...ResourceOption) (*JobCredential, error)
public JobCredential(string name, JobCredentialArgs args, CustomResourceOptions? opts = null)
public JobCredential(String name, JobCredentialArgs args)
public JobCredential(String name, JobCredentialArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. JobCredentialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. JobCredentialArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. JobCredentialArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. JobCredentialArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. JobCredentialArgs
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 jobCredentialResource = new Azure.MSSql.JobCredential("jobCredentialResource", new()
{
    JobAgentId = "string",
    Username = "string",
    Name = "string",
    Password = "string",
    PasswordWoVersion = 0,
});
Copy
example, err := mssql.NewJobCredential(ctx, "jobCredentialResource", &mssql.JobCredentialArgs{
	JobAgentId:        pulumi.String("string"),
	Username:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Password:          pulumi.String("string"),
	PasswordWoVersion: pulumi.Int(0),
})
Copy
var jobCredentialResource = new JobCredential("jobCredentialResource", JobCredentialArgs.builder()
    .jobAgentId("string")
    .username("string")
    .name("string")
    .password("string")
    .passwordWoVersion(0)
    .build());
Copy
job_credential_resource = azure.mssql.JobCredential("jobCredentialResource",
    job_agent_id="string",
    username="string",
    name="string",
    password="string",
    password_wo_version=0)
Copy
const jobCredentialResource = new azure.mssql.JobCredential("jobCredentialResource", {
    jobAgentId: "string",
    username: "string",
    name: "string",
    password: "string",
    passwordWoVersion: 0,
});
Copy
type: azure:mssql:JobCredential
properties:
    jobAgentId: string
    name: string
    password: string
    passwordWoVersion: 0
    username: string
Copy

JobCredential 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 JobCredential resource accepts the following input properties:

JobAgentId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
Username This property is required. string
The username to use for this Elastic Job credential.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
Password string
The password to use for this Elastic Job credential.
PasswordWoVersion int
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
JobAgentId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
Username This property is required. string
The username to use for this Elastic Job credential.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
Password string
The password to use for this Elastic Job credential.
PasswordWoVersion int
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
jobAgentId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
username This property is required. String
The username to use for this Elastic Job credential.
name Changes to this property will trigger replacement. String
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password String
The password to use for this Elastic Job credential.
passwordWoVersion Integer
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
jobAgentId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
username This property is required. string
The username to use for this Elastic Job credential.
name Changes to this property will trigger replacement. string
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password string
The password to use for this Elastic Job credential.
passwordWoVersion number
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
job_agent_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
username This property is required. str
The username to use for this Elastic Job credential.
name Changes to this property will trigger replacement. str
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password str
The password to use for this Elastic Job credential.
password_wo_version int
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
jobAgentId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
username This property is required. String
The username to use for this Elastic Job credential.
name Changes to this property will trigger replacement. String
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password String
The password to use for this Elastic Job credential.
passwordWoVersion Number
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.

Outputs

All input properties are implicitly available as output properties. Additionally, the JobCredential 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 JobCredential Resource

Get an existing JobCredential 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?: JobCredentialState, opts?: CustomResourceOptions): JobCredential
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        job_agent_id: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_wo_version: Optional[int] = None,
        username: Optional[str] = None) -> JobCredential
func GetJobCredential(ctx *Context, name string, id IDInput, state *JobCredentialState, opts ...ResourceOption) (*JobCredential, error)
public static JobCredential Get(string name, Input<string> id, JobCredentialState? state, CustomResourceOptions? opts = null)
public static JobCredential get(String name, Output<String> id, JobCredentialState state, CustomResourceOptions options)
resources:  _:    type: azure:mssql:JobCredential    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
JobAgentId Changes to this property will trigger replacement. string
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
Password string
The password to use for this Elastic Job credential.
PasswordWoVersion int
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
Username string
The username to use for this Elastic Job credential.
JobAgentId Changes to this property will trigger replacement. string
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
Password string
The password to use for this Elastic Job credential.
PasswordWoVersion int
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
Username string
The username to use for this Elastic Job credential.
jobAgentId Changes to this property will trigger replacement. String
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password String
The password to use for this Elastic Job credential.
passwordWoVersion Integer
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
username String
The username to use for this Elastic Job credential.
jobAgentId Changes to this property will trigger replacement. string
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password string
The password to use for this Elastic Job credential.
passwordWoVersion number
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
username string
The username to use for this Elastic Job credential.
job_agent_id Changes to this property will trigger replacement. str
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password str
The password to use for this Elastic Job credential.
password_wo_version int
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
username str
The username to use for this Elastic Job credential.
jobAgentId Changes to this property will trigger replacement. String
The ID of the Elastic Job Agent. Changing this forces a new Elastic Job Credential to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Elastic Job Credential. Changing this forces a new Elastic Job Credential to be created.
password String
The password to use for this Elastic Job credential.
passwordWoVersion Number
An integer value used to trigger an update for password_wo. This property should be incremented when updating password_wo.
username String
The username to use for this Elastic Job credential.

Import

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

$ pulumi import azure:mssql/jobCredential:JobCredential example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Sql/servers/myserver1/jobAgents/myjobagent1/credentials/credential1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure