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

azure-native.sql.getJobAgent

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Gets a job agent. 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.

    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>
    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]
    func LookupJobAgent(ctx *Context, args *LookupJobAgentArgs, opts ...InvokeOption) (*LookupJobAgentResult, error)
    func LookupJobAgentOutput(ctx *Context, args *LookupJobAgentOutputArgs, opts ...InvokeOption) LookupJobAgentResultOutput

    > 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)
    }
    public static CompletableFuture<GetJobAgentResult> getJobAgent(GetJobAgentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:sql:getJobAgent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    JobAgentName string
    The name of the job agent to be retrieved.
    ResourceGroupName 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 string
    The name of the server.
    JobAgentName string
    The name of the job agent to be retrieved.
    ResourceGroupName 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 string
    The name of the server.
    jobAgentName String
    The name of the job agent to be retrieved.
    resourceGroupName 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 String
    The name of the server.
    jobAgentName string
    The name of the job agent to be retrieved.
    resourceGroupName 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 string
    The name of the server.
    job_agent_name str
    The name of the job agent to be retrieved.
    resource_group_name 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 str
    The name of the server.
    jobAgentName String
    The name of the job agent to be retrieved.
    resourceGroupName 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 String
    The name of the server.

    getJobAgent Result

    The following output properties are available:

    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.
    Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse
    The name and tier of the SKU.
    Tags Dictionary<string, string>
    Resource tags.
    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.
    Sku SkuResponse
    The name and tier of the SKU.
    Tags map[string]string
    Resource tags.
    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.
    sku SkuResponse
    The name and tier of the SKU.
    tags Map<String,String>
    Resource tags.
    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.
    sku SkuResponse
    The name and tier of the SKU.
    tags {[key: string]: string}
    Resource tags.
    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.
    sku SkuResponse
    The name and tier of the SKU.
    tags Mapping[str, str]
    Resource tags.
    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.
    sku Property Map
    The name and tier of the SKU.
    tags Map<String>
    Resource tags.

    Supporting Types

    SkuResponse

    Name 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 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 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 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 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 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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi