1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. getJob
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.sql.getJob

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets a job. Azure REST API version: 2021-11-01.

Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
Copy
def get_job(job_agent_name: Optional[str] = None,
            job_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            server_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_agent_name: Optional[pulumi.Input[str]] = None,
            job_name: Optional[pulumi.Input[str]] = None,
            resource_group_name: Optional[pulumi.Input[str]] = None,
            server_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
Copy
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
Copy

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
public static Output<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

JobAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job agent.
JobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job to get.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
JobAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job agent.
JobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job to get.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
jobAgentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the job agent.
jobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the job to get.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
jobAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job agent.
jobName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job to get.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
job_agent_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the job agent.
job_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the job to get.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
jobAgentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the job agent.
jobName
This property is required.
Changes to this property will trigger replacement.
String
The name of the job to get.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getJob Result

The following output properties are available:

Id string
Resource ID.
Name string
Resource name.
Type string
Resource type.
Version int
The job version number.
Description string
User-defined description of the job.
Schedule Pulumi.AzureNative.Sql.Outputs.JobScheduleResponse
Schedule properties of the job.
Id string
Resource ID.
Name string
Resource name.
Type string
Resource type.
Version int
The job version number.
Description string
User-defined description of the job.
Schedule JobScheduleResponse
Schedule properties of the job.
id String
Resource ID.
name String
Resource name.
type String
Resource type.
version Integer
The job version number.
description String
User-defined description of the job.
schedule JobScheduleResponse
Schedule properties of the job.
id string
Resource ID.
name string
Resource name.
type string
Resource type.
version number
The job version number.
description string
User-defined description of the job.
schedule JobScheduleResponse
Schedule properties of the job.
id str
Resource ID.
name str
Resource name.
type str
Resource type.
version int
The job version number.
description str
User-defined description of the job.
schedule JobScheduleResponse
Schedule properties of the job.
id String
Resource ID.
name String
Resource name.
type String
Resource type.
version Number
The job version number.
description String
User-defined description of the job.
schedule Property Map
Schedule properties of the job.

Supporting Types

JobScheduleResponse

Enabled bool
Whether or not the schedule is enabled.
EndTime string
Schedule end time.
Interval string
Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
StartTime string
Schedule start time.
Type string
Schedule interval type
Enabled bool
Whether or not the schedule is enabled.
EndTime string
Schedule end time.
Interval string
Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
StartTime string
Schedule start time.
Type string
Schedule interval type
enabled Boolean
Whether or not the schedule is enabled.
endTime String
Schedule end time.
interval String
Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
startTime String
Schedule start time.
type String
Schedule interval type
enabled boolean
Whether or not the schedule is enabled.
endTime string
Schedule end time.
interval string
Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
startTime string
Schedule start time.
type string
Schedule interval type
enabled bool
Whether or not the schedule is enabled.
end_time str
Schedule end time.
interval str
Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
start_time str
Schedule start time.
type str
Schedule interval type
enabled Boolean
Whether or not the schedule is enabled.
endTime String
Schedule end time.
interval String
Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format.
startTime String
Schedule start time.
type String
Schedule interval type

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi