private_endpoints

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

Overview

Name	private_endpoints
Type	Resource
Id	azure.stream_analytics.private_endpoints

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified private endpoint.

Name	Datatype	Description
etag	string	Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
properties	object	The properties associated with a private endpoint.

list_by_cluster

Successfully listed the private endpoints under the specified cluster.

Name	Datatype	Description
etag	string	Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.
properties	object	The properties associated with a private endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, privateEndpointName		Gets information about the specified Private Endpoint.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Lists the private endpoints in the cluster.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, privateEndpointName	If-Match, If-None-Match	Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
delete	delete	subscriptionId, resourceGroupName, clusterName, privateEndpointName		Delete the specified 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
clusterName	string	The name of the cluster.
privateEndpointName	string	The name of the private endpoint.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
If-Match	string	The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
If-None-Match	string	Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

SELECT examples

get

Gets information about the specified Private Endpoint.

SELECT
etag,
properties
FROM azure.stream_analytics.private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND privateEndpointName = '{{ privateEndpointName }}' -- required
;

list_by_cluster

Lists the private endpoints in the cluster.

SELECT
etag,
properties
FROM azure.stream_analytics.private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create_or_update

Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.

INSERT INTO azure.stream_analytics.private_endpoints (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
privateEndpointName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ privateEndpointName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoints resource.
    - name: clusterName
      value: string
      description: Required parameter for the private_endpoints resource.
    - name: privateEndpointName
      value: string
      description: Required parameter for the private_endpoints resource.
    - name: properties
      value: object
      description: |
        The properties associated with a private endpoint.
    - name: If-Match
      value: string
      description: The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.

DELETE examples

delete

Delete the specified private endpoint.

DELETE FROM azure.stream_analytics.private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND privateEndpointName = '{{ privateEndpointName }}' --required
;