Package version:

Interface JobCredentials

Interface representing a JobCredentials.

Hierarchy

JobCredentials

Index

Methods

createOrUpdate delete get listByAgent

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, credentialName: string, parameters: JobCredential, options?: JobCredentialsCreateOrUpdateOptionalParams): Promise<JobCredential>
Creates or updates a job credential.
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.
- Optional options: JobCredentialsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<JobCredential>
- Defined in operationsInterfaces/jobCredentials.ts:63

delete

delete(resourceGroupName: string, serverName: string, jobAgentName: string, credentialName: string, options?: JobCredentialsDeleteOptionalParams): Promise<void>
Deletes a job credential.
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.
- Optional options: JobCredentialsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/jobCredentials.ts:80

get

get(resourceGroupName: string, serverName: string, jobAgentName: string, credentialName: string, options?: JobCredentialsGetOptionalParams): Promise<JobCredential>
Gets a jobs credential.
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.
- Optional options: JobCredentialsGetOptionalParams
  
  The options parameters.
Returns Promise<JobCredential>
- Defined in operationsInterfaces/jobCredentials.ts:46

listByAgent

listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobCredentialsListByAgentOptionalParams): PagedAsyncIterableIterator<JobCredential>
Gets a list of jobs credentials.
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.
- Optional options: JobCredentialsListByAgentOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<JobCredential>
- Defined in operationsInterfaces/jobCredentials.ts:31

Generated using TypeDoc