Job Credentials - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a jobs credential.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
credentialName	path	True	string	The name of the credential.
jobAgentName	path	True	string	The name of the job agent.
resourceGroupName	path	True	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	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	JobCredential	Successfully retrieved the job credential.
Other Status Codes		*** Error Responses: *** 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

Get a credential

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1?api-version=2021-11-01

Java

/**
 * Samples for JobCredentials Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetJobCredential.json
     */
    /**
     * Sample code: Get a credential.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getACredential(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobCredentials().getWithResponse("group1", "server1", "agent1",
            "cred1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
  "name": "cred1",
  "type": "Microsoft.Sql/servers/jobAccounts/credentials",
  "properties": {
    "username": "myuser"
  }
}

Definitions

JobCredential

A stored credential that can be used by a job to connect to target databases.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.password	string	The credential password.
properties.username	string	The credential user name.
type	string	Resource type.