JobPrivateEndpoints interface

Package:

@azure/arm-sql

Interface representing a JobPrivateEndpoints.

Methods

beginCreateOrUpdate(string, string, string, string, JobPrivateEndpoint, JobPrivateEndpointsCreateOrUpdateOptionalParams)	Creates or updates a private endpoint.
beginCreateOrUpdateAndWait(string, string, string, string, JobPrivateEndpoint, JobPrivateEndpointsCreateOrUpdateOptionalParams)	Creates or updates a private endpoint.
beginDelete(string, string, string, string, JobPrivateEndpointsDeleteOptionalParams)	Deletes a private endpoint.
beginDeleteAndWait(string, string, string, string, JobPrivateEndpointsDeleteOptionalParams)	Deletes a private endpoint.
get(string, string, string, string, JobPrivateEndpointsGetOptionalParams)	Gets a private endpoint.
listByAgent(string, string, string, JobPrivateEndpointsListByAgentOptionalParams)	Gets a list of job agent private endpoints.

Method Details

beginCreateOrUpdate(string, string, string, string, JobPrivateEndpoint, JobPrivateEndpointsCreateOrUpdateOptionalParams)

Creates or updates a private endpoint.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, jobAgentName: string, privateEndpointName: string, parameters: JobPrivateEndpoint, options?: JobPrivateEndpointsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobPrivateEndpoint>, JobPrivateEndpoint>>

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.

privateEndpointName

string

The name of the private endpoint.

parameters

JobPrivateEndpoint

The requested private endpoint state.

options

JobPrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<JobPrivateEndpoint>, JobPrivateEndpoint>>

beginCreateOrUpdateAndWait(string, string, string, string, JobPrivateEndpoint, JobPrivateEndpointsCreateOrUpdateOptionalParams)

Creates or updates a private endpoint.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, privateEndpointName: string, parameters: JobPrivateEndpoint, options?: JobPrivateEndpointsCreateOrUpdateOptionalParams): Promise<JobPrivateEndpoint>

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.

privateEndpointName

string

The name of the private endpoint.

parameters

JobPrivateEndpoint

The requested private endpoint state.

options

JobPrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<JobPrivateEndpoint>

beginDelete(string, string, string, string, JobPrivateEndpointsDeleteOptionalParams)

Deletes a private endpoint.

function beginDelete(resourceGroupName: string, serverName: string, jobAgentName: string, privateEndpointName: string, options?: JobPrivateEndpointsDeleteOptionalParams): 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.

privateEndpointName

string

The name of the private endpoint to delete.

options

JobPrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, JobPrivateEndpointsDeleteOptionalParams)

Deletes a private endpoint.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, jobAgentName: string, privateEndpointName: string, options?: JobPrivateEndpointsDeleteOptionalParams): 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.

privateEndpointName

string

The name of the private endpoint to delete.

options

JobPrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, JobPrivateEndpointsGetOptionalParams)

Gets a private endpoint.

function get(resourceGroupName: string, serverName: string, jobAgentName: string, privateEndpointName: string, options?: JobPrivateEndpointsGetOptionalParams): Promise<JobPrivateEndpoint>

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.

privateEndpointName

string

The name of the private endpoint to get.

options

JobPrivateEndpointsGetOptionalParams

The options parameters.

Returns

Promise<JobPrivateEndpoint>

listByAgent(string, string, string, JobPrivateEndpointsListByAgentOptionalParams)

Gets a list of job agent private endpoints.

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

JobPrivateEndpointsListByAgentOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<JobPrivateEndpoint, JobPrivateEndpoint[], PageSettings>