JobAgents interface
Interface representing a JobAgents.
Methods
| begin |
Creates or updates a job agent. |
| begin |
Creates or updates a job agent. |
| begin |
Deletes a job agent. |
| begin |
Deletes a job agent. |
| begin |
Updates a job agent. |
| begin |
Updates a job agent. |
| get(string, string, string, Job |
Gets a job agent. |
| list |
Gets a list of job agents in a server. |
Method Details
beginCreateOrUpdate(string, string, string, JobAgent, JobAgentsCreateOrUpdateOptionalParams)
Creates or updates a job agent.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgent, options?: JobAgentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobAgent>, JobAgent>>
beginCreateOrUpdateAndWait(string, string, string, JobAgent, JobAgentsCreateOrUpdateOptionalParams)
Creates or updates a job agent.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgent, options?: JobAgentsCreateOrUpdateOptionalParams): Promise<JobAgent>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.
The options parameters.
Returns
Promise<JobAgent>
beginDelete(string, string, string, JobAgentsDeleteOptionalParams)
Deletes a job agent.
function beginDelete(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobAgentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, 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 to be deleted.
- options
- JobAgentsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, JobAgentsDeleteOptionalParams)
Deletes a job agent.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobAgentsDeleteOptionalParams): 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 to be deleted.
- options
- JobAgentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, JobAgentUpdate, JobAgentsUpdateOptionalParams)
Updates a job agent.
function beginUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgentUpdate, options?: JobAgentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobAgent>, JobAgent>>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.
- options
- JobAgentsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobAgent>, JobAgent>>
beginUpdateAndWait(string, string, string, JobAgentUpdate, JobAgentsUpdateOptionalParams)
Updates a job agent.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, parameters: JobAgentUpdate, options?: JobAgentsUpdateOptionalParams): Promise<JobAgent>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.
- options
- JobAgentsUpdateOptionalParams
The options parameters.
Returns
Promise<JobAgent>
get(string, string, string, JobAgentsGetOptionalParams)
Gets a job agent.
function get(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobAgentsGetOptionalParams): Promise<JobAgent>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.
- options
- JobAgentsGetOptionalParams
The options parameters.
Returns
Promise<JobAgent>
listByServer(string, string, JobAgentsListByServerOptionalParams)
Gets a list of job agents in a server.
function listByServer(resourceGroupName: string, serverName: string, options?: JobAgentsListByServerOptionalParams): PagedAsyncIterableIterator<JobAgent, JobAgent[], 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.
The options parameters.