job_private_endpoints

Creates, updates, deletes, gets or lists a job_private_endpoints resource.

Overview

Name	job_private_endpoints
Type	Resource
Id	azure.sql.job_private_endpoints

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the private endpoint.

Name	Datatype	Description
properties	object	Resource properties.

list_by_agent

Successfully retrieved the list of private endpoints.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, jobAgentName, privateEndpointName, subscriptionId		Gets a private endpoint.
list_by_agent	select	resourceGroupName, serverName, jobAgentName, subscriptionId		Gets a list of job agent private endpoints.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, privateEndpointName, subscriptionId		Creates or updates a private endpoint.
delete	delete	resourceGroupName, serverName, jobAgentName, privateEndpointName, subscriptionId		Deletes a private endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
jobAgentName	string	The name of the job agent.
privateEndpointName	string	The name of the private endpoint to delete.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a private endpoint.

SELECT
properties
FROM azure.sql.job_private_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND privateEndpointName = '{{ privateEndpointName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_agent

Gets a list of job agent private endpoints.

SELECT
properties
FROM azure.sql.job_private_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a private endpoint.

INSERT INTO azure.sql.job_private_endpoints (
data__properties,
resourceGroupName,
serverName,
jobAgentName,
privateEndpointName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ jobAgentName }}',
'{{ privateEndpointName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: job_private_endpoints
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_private_endpoints resource.
    - name: serverName
      value: string
      description: Required parameter for the job_private_endpoints resource.
    - name: jobAgentName
      value: string
      description: Required parameter for the job_private_endpoints resource.
    - name: privateEndpointName
      value: string
      description: Required parameter for the job_private_endpoints resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the job_private_endpoints resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a private endpoint.

DELETE FROM azure.sql.job_private_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND jobAgentName = '{{ jobAgentName }}' --required
AND privateEndpointName = '{{ privateEndpointName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;