Share via

JobTargetGroups interface

  • Reference
Package:
@azure/arm-sql

Interface representing a JobTargetGroups.

Methods

createOrUpdate(string, string, string, string, JobTargetGroup, JobTargetGroupsCreateOrUpdateOptionalParams)

Creates or updates a target group.
delete(string, string, string, string, JobTargetGroupsDeleteOptionalParams)

Deletes a target group.
get(string, string, string, string, JobTargetGroupsGetOptionalParams)

Gets a target group.
listByAgent(string, string, string, JobTargetGroupsListByAgentOptionalParams)

Gets all target groups in an agent.

Method Details

createOrUpdate(string, string, string, string, JobTargetGroup, JobTargetGroupsCreateOrUpdateOptionalParams)

Creates or updates a target group.

function createOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, targetGroupName: string, parameters: JobTargetGroup, options?: JobTargetGroupsCreateOrUpdateOptionalParams): Promise<JobTargetGroup>

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.

targetGroupName

string

The name of the target group.

parameters
JobTargetGroup

The requested state of the target group.

options
JobTargetGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<JobTargetGroup>

delete(string, string, string, string, JobTargetGroupsDeleteOptionalParams)

Deletes a target group.

function delete(resourceGroupName: string, serverName: string, jobAgentName: string, targetGroupName: string, options?: JobTargetGroupsDeleteOptionalParams): 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.

targetGroupName

string

The name of the target group.

options
JobTargetGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, JobTargetGroupsGetOptionalParams)

Gets a target group.

function get(resourceGroupName: string, serverName: string, jobAgentName: string, targetGroupName: string, options?: JobTargetGroupsGetOptionalParams): Promise<JobTargetGroup>

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.

targetGroupName

string

The name of the target group.

options
JobTargetGroupsGetOptionalParams

The options parameters.

Returns

Promise<JobTargetGroup>

listByAgent(string, string, string, JobTargetGroupsListByAgentOptionalParams)

Gets all target groups in an agent.

function listByAgent(resourceGroupName: string, serverName: string, jobAgentName: string, options?: JobTargetGroupsListByAgentOptionalParams): PagedAsyncIterableIterator<JobTargetGroup, JobTargetGroup[], 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
JobTargetGroupsListByAgentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobTargetGroup, JobTargetGroup[], PageSettings>