JobPrivateEndpointsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:job_private_endpoints> attribute.

Constructor

JobPrivateEndpointsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a private endpoint.
begin_delete	Deletes a private endpoint.
get	Gets a private endpoint.
list_by_agent	Gets a list of job agent private endpoints.

begin_create_or_update

Creates or updates a private endpoint.

async begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, private_endpoint_name: str, parameters: _models.JobPrivateEndpoint, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.JobPrivateEndpoint]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
private_endpoint_name Required	str The name of the private endpoint. Required.
parameters Required	JobPrivateEndpoint or IO[bytes] The requested private endpoint state. Is either a JobPrivateEndpoint type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[JobPrivateEndpoint]	An instance of AsyncLROPoller that returns either JobPrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a private endpoint.

async begin_delete(resource_group_name: str, server_name: str, job_agent_name: str, private_endpoint_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
private_endpoint_name Required	str The name of the private endpoint to delete. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a private endpoint.

async get(resource_group_name: str, server_name: str, job_agent_name: str, private_endpoint_name: str, **kwargs: Any) -> JobPrivateEndpoint

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.
private_endpoint_name Required	str The name of the private endpoint to get. Required.

Returns

Type	Description
JobPrivateEndpoint	JobPrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_agent

Gets a list of job agent private endpoints.

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) -> AsyncItemPaged[JobPrivateEndpoint]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
job_agent_name Required	str The name of the job agent. Required.

Returns

Type	Description
AsyncItemPaged[JobPrivateEndpoint]	An iterator like instance of either JobPrivateEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>