Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getJobCredential
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getJobCredential

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a jobs credential.

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 getJobCredential

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 getJobCredential(args: GetJobCredentialArgs, opts?: InvokeOptions): Promise<GetJobCredentialResult>
function getJobCredentialOutput(args: GetJobCredentialOutputArgs, opts?: InvokeOptions): Output<GetJobCredentialResult>
Copy
def get_job_credential(credential_name: Optional[str] = None,
                       job_agent_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       server_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetJobCredentialResult
def get_job_credential_output(credential_name: Optional[pulumi.Input[str]] = None,
                       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[GetJobCredentialResult]
Copy
func LookupJobCredential(ctx *Context, args *LookupJobCredentialArgs, opts ...InvokeOption) (*LookupJobCredentialResult, error)
func LookupJobCredentialOutput(ctx *Context, args *LookupJobCredentialOutputArgs, opts ...InvokeOption) LookupJobCredentialResultOutput
Copy

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

public static class GetJobCredential 
{
    public static Task<GetJobCredentialResult> InvokeAsync(GetJobCredentialArgs args, InvokeOptions? opts = null)
    public static Output<GetJobCredentialResult> Invoke(GetJobCredentialInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobCredentialResult> getJobCredential(GetJobCredentialArgs args, InvokeOptions options)
public static Output<GetJobCredentialResult> getJobCredential(GetJobCredentialArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getJobCredential
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CredentialName
This property is required.
Changes to this property will trigger replacement.
string
The name of the credential.
JobAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job agent.
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.
CredentialName
This property is required.
Changes to this property will trigger replacement.
string
The name of the credential.
JobAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job agent.
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.
credentialName
This property is required.
Changes to this property will trigger replacement.
String
The name of the credential.
jobAgentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the job agent.
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.
credentialName
This property is required.
Changes to this property will trigger replacement.
string
The name of the credential.
jobAgentName
This property is required.
Changes to this property will trigger replacement.
string
The name of the job agent.
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.
credential_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the credential.
job_agent_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the job agent.
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.
credentialName
This property is required.
Changes to this property will trigger replacement.
String
The name of the credential.
jobAgentName
This property is required.
Changes to this property will trigger replacement.
String
The name of the job agent.
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.

getJobCredential Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
Name string
Resource name.
Type string
Resource type.
Username string
The credential user name.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
Name string
Resource name.
Type string
Resource type.
Username string
The credential user name.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
name String
Resource name.
type String
Resource type.
username String
The credential user name.
azureApiVersion string
The Azure API version of the resource.
id string
Resource ID.
name string
Resource name.
type string
Resource type.
username string
The credential user name.
azure_api_version str
The Azure API version of the resource.
id str
Resource ID.
name str
Resource name.
type str
Resource type.
username str
The credential user name.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
name String
Resource name.
type String
Resource type.
username String
The credential user name.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native