Package version:

Interface JobAgents

Interface representing a JobAgents.

Hierarchy

JobAgents

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByServer

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgent, options?: JobAgentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>
Creates or updates a job agent.
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 to be created or updated.
- parameters: JobAgent
  
  The requested job agent resource state.
- Optional options: JobAgentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>
- Defined in operationsInterfaces/jobAgents.ts:62

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgent, options?: JobAgentsCreateOrUpdateOptionalParams): Promise<JobAgent>
Creates or updates a job agent.
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 to be created or updated.
- parameters: JobAgent
  
  The requested job agent resource state.
- Optional options: JobAgentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<JobAgent>
- Defined in operationsInterfaces/jobAgents.ts:83

beginDelete

beginDelete(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobAgentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a job agent.
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 to be deleted.
- Optional options: JobAgentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/jobAgents.ts:98

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobAgentsDeleteOptionalParams): Promise<void>
Deletes a job agent.
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 to be deleted.
- Optional options: JobAgentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/jobAgents.ts:112

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgentUpdate, options?: JobAgentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>
Updates a job agent.
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 to be updated.
- parameters: JobAgentUpdate
  
  The update to the job agent.
- Optional options: JobAgentsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>
- Defined in operationsInterfaces/jobAgents.ts:127

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgentUpdate, options?: JobAgentsUpdateOptionalParams): Promise<JobAgent>
Updates a job agent.
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 to be updated.
- parameters: JobAgentUpdate
  
  The update to the job agent.
- Optional options: JobAgentsUpdateOptionalParams
  
  The options parameters.
Returns Promise<JobAgent>
- Defined in operationsInterfaces/jobAgents.ts:148

get

get(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobAgentsGetOptionalParams): Promise<JobAgent>
Gets a job agent.
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 to be retrieved.
- Optional options: JobAgentsGetOptionalParams
  
  The options parameters.
Returns Promise<JobAgent>
- Defined in operationsInterfaces/jobAgents.ts:47

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: JobAgentsListByServerOptionalParams): PagedAsyncIterableIterator<JobAgent>
Gets a list of job agents in a server.
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.
- Optional options: JobAgentsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<JobAgent>
- Defined in operationsInterfaces/jobAgents.ts:34

Interface JobAgents

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

parameters: JobAgent

Optional options: JobAgentsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

parameters: JobAgent

Optional options: JobAgentsCreateOrUpdateOptionalParams

Returns Promise<JobAgent>

beginDelete

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

Optional options: JobAgentsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

Optional options: JobAgentsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

parameters: JobAgentUpdate

Optional options: JobAgentsUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

parameters: JobAgentUpdate

Optional options: JobAgentsUpdateOptionalParams

Returns Promise<JobAgent>

get

Parameters

resourceGroupName: string

serverName: string

jobAgentName: string

Optional options: JobAgentsGetOptionalParams

Returns Promise<JobAgent>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: JobAgentsListByServerOptionalParams

Returns PagedAsyncIterableIterator<JobAgent>

Settings

Member Visibility

Theme

`Optional` options: JobAgentsCreateOrUpdateOptionalParams

`Optional` options: JobAgentsCreateOrUpdateOptionalParams

`Optional` options: JobAgentsDeleteOptionalParams

`Optional` options: JobAgentsDeleteOptionalParams

`Optional` options: JobAgentsUpdateOptionalParams

`Optional` options: JobAgentsUpdateOptionalParams

`Optional` options: JobAgentsGetOptionalParams

`Optional` options: JobAgentsListByServerOptionalParams