Share via

JobCredentials interface

  • Reference
Package:
@azure/arm-sql

Interface representing a JobCredentials.

Methods

createOrUpdate(string, string, string, string, JobCredential, JobCredentialsCreateOrUpdateOptionalParams)

Creates or updates a job credential.
delete(string, string, string, string, JobCredentialsDeleteOptionalParams)

Deletes a job credential.
get(string, string, string, string, JobCredentialsGetOptionalParams)

Gets a jobs credential.
listByAgent(string, string, string, JobCredentialsListByAgentOptionalParams)

Gets a list of jobs credentials.

Method Details

createOrUpdate(string, string, string, string, JobCredential, JobCredentialsCreateOrUpdateOptionalParams)

Creates or updates a job credential.

function createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, credentialName: string, parameters: JobCredential, options?: JobCredentialsCreateOrUpdateOptionalParams): Promise<JobCredential>

Parameters

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.

credentialName

string

The name of the credential.

parameters
JobCredential

The requested job credential state.

options
JobCredentialsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<JobCredential>

delete(string, string, string, string, JobCredentialsDeleteOptionalParams)

Deletes a job credential.

function delete(resourceGroupName: string, serverName: string, jobAgentName: string, credentialName: string, options?: JobCredentialsDeleteOptionalParams): Promise<void>

Parameters

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.

credentialName

string

The name of the credential.

options
JobCredentialsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, JobCredentialsGetOptionalParams)

Gets a jobs credential.

function get(resourceGroupName: string, serverName: string, jobAgentName: string, credentialName: string, options?: JobCredentialsGetOptionalParams): Promise<JobCredential>

Parameters

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.

credentialName

string

The name of the credential.

options
JobCredentialsGetOptionalParams

The options parameters.

Returns

Promise<JobCredential>

listByAgent(string, string, string, JobCredentialsListByAgentOptionalParams)

Gets a list of jobs credentials.

function listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobCredentialsListByAgentOptionalParams): PagedAsyncIterableIterator<JobCredential, JobCredential[], PageSettings>

Parameters

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.

options
JobCredentialsListByAgentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobCredential, JobCredential[], PageSettings>