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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
privateEndpointId	string	Private endpoint id of the private endpoint.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetServerAzureResourceId	string	ARM resource id of the server the private endpoint will target. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_agent

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
privateEndpointId	string	Private endpoint id of the private endpoint.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetServerAzureResourceId	string	ARM resource id of the server the private endpoint will target. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, job_agent_name, private_endpoint_name, subscription_id		Gets a private endpoint.
list_by_agent	select	resource_group_name, server_name, job_agent_name, subscription_id		Gets a list of job agent private endpoints.
create_or_update	insert	resource_group_name, server_name, job_agent_name, private_endpoint_name, subscription_id		Creates or updates a private endpoint.
create_or_update	replace	resource_group_name, server_name, job_agent_name, private_endpoint_name, subscription_id		Creates or updates a private endpoint.
delete	delete	resource_group_name, server_name, job_agent_name, private_endpoint_name, subscription_id		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
job_agent_name	string	The name of the job agent to be retrieved. Required.
private_endpoint_name	string	The name of the private endpoint to get. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a private endpoint.

SELECT
id,
name,
privateEndpointId,
systemData,
targetServerAzureResourceId,
type
FROM azure.sql.job_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND private_endpoint_name = '{{ private_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_agent

Gets a list of job agent private endpoints.

SELECT
id,
name,
privateEndpointId,
systemData,
targetServerAzureResourceId,
type
FROM azure.sql.job_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a private endpoint.

INSERT INTO azure.sql.job_private_endpoints (
properties,
resource_group_name,
server_name,
job_agent_name,
private_endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ job_agent_name }}',
'{{ private_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: job_private_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the job_private_endpoints resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the job_private_endpoints resource.
  - name: job_agent_name
    value: "{{ job_agent_name }}"
    description: Required parameter for the job_private_endpoints resource.
  - name: private_endpoint_name
    value: "{{ private_endpoint_name }}"
    description: Required parameter for the job_private_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the job_private_endpoints resource.
  - name: properties
    description: |
      Resource properties.
    value:
      targetServerAzureResourceId: "{{ targetServerAzureResourceId }}"
      privateEndpointId: "{{ privateEndpointId }}"

REPLACE examples

create_or_update

Creates or updates a private endpoint.

REPLACE azure.sql.job_private_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND job_agent_name = '{{ job_agent_name }}' --required
AND private_endpoint_name = '{{ private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a private endpoint.

DELETE FROM azure.sql.job_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND job_agent_name = '{{ job_agent_name }}' --required
AND private_endpoint_name = '{{ private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;