1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getJobAgent
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.sql.getJobAgent

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets a job agent.

Uses Azure REST API version 2023-08-01.

Other available API versions: 2017-03-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getJobAgent

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 getJobAgent(args: GetJobAgentArgs, opts?: InvokeOptions): Promise<GetJobAgentResult>
function getJobAgentOutput(args: GetJobAgentOutputArgs, opts?: InvokeOptions): Output<GetJobAgentResult>
Copy
def get_job_agent(job_agent_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  server_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetJobAgentResult
def get_job_agent_output(job_agent_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[GetJobAgentResult]
Copy
func LookupJobAgent(ctx *Context, args *LookupJobAgentArgs, opts ...InvokeOption) (*LookupJobAgentResult, error)
func LookupJobAgentOutput(ctx *Context, args *LookupJobAgentOutputArgs, opts ...InvokeOption) LookupJobAgentResultOutput
Copy

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

public static class GetJobAgent 
{
    public static Task<GetJobAgentResult> InvokeAsync(GetJobAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetJobAgentResult> Invoke(GetJobAgentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobAgentResult> getJobAgent(GetJobAgentArgs args, InvokeOptions options)
public static Output<GetJobAgentResult> getJobAgent(GetJobAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getJobAgent
  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 to be retrieved.
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 to be retrieved.
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 to be retrieved.
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 to be retrieved.
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 to be retrieved.
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 to be retrieved.
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.

getJobAgent Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DatabaseId string
Resource ID of the database to store job metadata in.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
State string
The state of the job agent.
Type string
Resource type.
Identity Pulumi.AzureNative.Sql.Outputs.JobAgentIdentityResponse
The identity of the job agent.
Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse
The name and tier of the SKU.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
DatabaseId string
Resource ID of the database to store job metadata in.
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
State string
The state of the job agent.
Type string
Resource type.
Identity JobAgentIdentityResponse
The identity of the job agent.
Sku SkuResponse
The name and tier of the SKU.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
databaseId String
Resource ID of the database to store job metadata in.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
state String
The state of the job agent.
type String
Resource type.
identity JobAgentIdentityResponse
The identity of the job agent.
sku SkuResponse
The name and tier of the SKU.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
databaseId string
Resource ID of the database to store job metadata in.
id string
Resource ID.
location string
Resource location.
name string
Resource name.
state string
The state of the job agent.
type string
Resource type.
identity JobAgentIdentityResponse
The identity of the job agent.
sku SkuResponse
The name and tier of the SKU.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
database_id str
Resource ID of the database to store job metadata in.
id str
Resource ID.
location str
Resource location.
name str
Resource name.
state str
The state of the job agent.
type str
Resource type.
identity JobAgentIdentityResponse
The identity of the job agent.
sku SkuResponse
The name and tier of the SKU.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
databaseId String
Resource ID of the database to store job metadata in.
id String
Resource ID.
location String
Resource location.
name String
Resource name.
state String
The state of the job agent.
type String
Resource type.
identity Property Map
The identity of the job agent.
sku Property Map
The name and tier of the SKU.
tags Map<String>
Resource tags.

Supporting Types

JobAgentIdentityResponse

Type This property is required. string
The job agent identity type
TenantId string
The job agent identity tenant id
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Sql.Inputs.JobAgentUserAssignedIdentityResponse>
The resource ids of the user assigned identities to use
Type This property is required. string
The job agent identity type
TenantId string
The job agent identity tenant id
UserAssignedIdentities map[string]JobAgentUserAssignedIdentityResponse
The resource ids of the user assigned identities to use
type This property is required. String
The job agent identity type
tenantId String
The job agent identity tenant id
userAssignedIdentities Map<String,JobAgentUserAssignedIdentityResponse>
The resource ids of the user assigned identities to use
type This property is required. string
The job agent identity type
tenantId string
The job agent identity tenant id
userAssignedIdentities {[key: string]: JobAgentUserAssignedIdentityResponse}
The resource ids of the user assigned identities to use
type This property is required. str
The job agent identity type
tenant_id str
The job agent identity tenant id
user_assigned_identities Mapping[str, JobAgentUserAssignedIdentityResponse]
The resource ids of the user assigned identities to use
type This property is required. String
The job agent identity type
tenantId String
The job agent identity tenant id
userAssignedIdentities Map<Property Map>
The resource ids of the user assigned identities to use

JobAgentUserAssignedIdentityResponse

ClientId This property is required. string
The Azure Active Directory client id.
PrincipalId This property is required. string
The Azure Active Directory principal id.
ClientId This property is required. string
The Azure Active Directory client id.
PrincipalId This property is required. string
The Azure Active Directory principal id.
clientId This property is required. String
The Azure Active Directory client id.
principalId This property is required. String
The Azure Active Directory principal id.
clientId This property is required. string
The Azure Active Directory client id.
principalId This property is required. string
The Azure Active Directory principal id.
client_id This property is required. str
The Azure Active Directory client id.
principal_id This property is required. str
The Azure Active Directory principal id.
clientId This property is required. String
The Azure Active Directory client id.
principalId This property is required. String
The Azure Active Directory principal id.

SkuResponse

Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
Name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int
Capacity of the particular SKU.
Family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string
Size of the particular SKU
Tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Integer
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. string
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity number
Capacity of the particular SKU.
family string
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string
Size of the particular SKU
tier string
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. str
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity int
Capacity of the particular SKU.
family str
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str
Size of the particular SKU
tier str
The tier or edition of the particular SKU, e.g. Basic, Premium.
name This property is required. String
The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Number
Capacity of the particular SKU.
family String
If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String
Size of the particular SKU
tier String
The tier or edition of the particular SKU, e.g. Basic, Premium.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi