Docs Home
We recommend using Azure Native.
Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
azure.mssql.JobAgent
Explore with Pulumi AI
Manages an Elastic Job Agent.
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,
});
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)
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
}
_, err = mssql.NewJobAgent(ctx, "example", &mssql.JobAgentArgs{
Name: pulumi.String("example-job-agent"),
Location: example.Location,
DatabaseId: exampleDatabase.ID(),
})
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",
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,
});
});
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 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());
}
}
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}
Create JobAgent Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new JobAgent(name: string, args: JobAgentArgs, opts?: CustomResourceOptions);@overload
def JobAgent(resource_name: str,
args: JobAgentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def JobAgent(resource_name: str,
opts: Optional[ResourceOptions] = None,
database_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)func NewJobAgent(ctx *Context, name string, args JobAgentArgs, opts ...ResourceOption) (*JobAgent, error)public JobAgent(string name, JobAgentArgs args, CustomResourceOptions? opts = null)
public JobAgent(String name, JobAgentArgs args)
public JobAgent(String name, JobAgentArgs args, CustomResourceOptions options)
type: azure:mssql:JobAgent
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 JobAgentArgs
- 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 JobAgentArgs
- 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 JobAgentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobAgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobAgentArgs
- 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 jobAgentResource = new Azure.MSSql.JobAgent("jobAgentResource", new()
{
DatabaseId = "string",
Location = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := mssql.NewJobAgent(ctx, "jobAgentResource", &mssql.JobAgentArgs{
DatabaseId: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var jobAgentResource = new JobAgent("jobAgentResource", JobAgentArgs.builder()
.databaseId("string")
.location("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
job_agent_resource = azure.mssql.JobAgent("jobAgentResource",
database_id="string",
location="string",
name="string",
tags={
"string": "string",
})
const jobAgentResource = new azure.mssql.JobAgent("jobAgentResource", {
databaseId: "string",
location: "string",
name: "string",
tags: {
string: "string",
},
});
type: azure:mssql:JobAgent
properties:
databaseId: string
location: string
name: string
tags:
string: string
JobAgent 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 JobAgent resource accepts the following input properties:
- Database
Id string - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Location string
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- Name string
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Database.
- Database
Id string - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Location string
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- Name string
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- map[string]string
- A mapping of tags which should be assigned to the Database.
- database
Id String - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location String
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name String
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Map<String,String>
- A mapping of tags which should be assigned to the Database.
- database
Id string - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location string
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name string
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Database.
- database_
id str - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location str
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name str
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Mapping[str, str]
- A mapping of tags which should be assigned to the Database.
- database
Id String - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location String
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name String
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Map<String>
- A mapping of tags which should be assigned to the Database.
Outputs
All input properties are implicitly available as output properties. Additionally, the JobAgent 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 JobAgent Resource
Get an existing JobAgent 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?: JobAgentState, opts?: CustomResourceOptions): JobAgent@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
database_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> JobAgentfunc GetJobAgent(ctx *Context, name string, id IDInput, state *JobAgentState, opts ...ResourceOption) (*JobAgent, error)public static JobAgent Get(string name, Input<string> id, JobAgentState? state, CustomResourceOptions? opts = null)public static JobAgent get(String name, Output<String> id, JobAgentState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Database
Id string - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Location string
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- Name string
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Database.
- Database
Id string - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Location string
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- Name string
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- map[string]string
- A mapping of tags which should be assigned to the Database.
- database
Id String - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location String
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name String
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Map<String,String>
- A mapping of tags which should be assigned to the Database.
- database
Id string - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location string
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name string
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Database.
- database_
id str - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location str
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name str
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Mapping[str, str]
- A mapping of tags which should be assigned to the Database.
- database
Id String - The ID of the database to store metadata for the Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- location String
- The Azure Region where the Elastic Job Agent should exist. Changing this forces a new Elastic Job Agent to be created.
- name String
- The name which should be used for this Elastic Job Agent. Changing this forces a new Elastic Job Agent to be created.
- Map<String>
- A mapping of tags which should be assigned to the Database.
Import
Elastic Job Agents can be imported using the id, e.g.
$ pulumi import azure:mssql/jobAgent:JobAgent example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Sql/servers/myserver1/jobAgents/myjobagent1
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
azurermTerraform Provider.