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

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.
createdDate	string	The date when this private endpoint was created.
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.
manualPrivateLinkServiceConnections	array	A list of connections to the remote resource. Immutable after it is set.
type	string	The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

list_by_cluster

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.
createdDate	string	The date when this private endpoint was created.
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.
manualPrivateLinkServiceConnections	array	A list of connections to the remote resource. Immutable after it is set.
type	string	The type of the resource. Ex- 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, cluster_name, private_endpoint_name, subscription_id		Gets information about the specified Private Endpoint.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Lists the private endpoints in the cluster.
create_or_update	insert	resource_group_name, cluster_name, private_endpoint_name, subscription_id	If-Match, If-None-Match	Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
create_or_update	replace	resource_group_name, cluster_name, private_endpoint_name, subscription_id	If-Match, If-None-Match	Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.
delete	delete	resource_group_name, cluster_name, private_endpoint_name, subscription_id		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
cluster_name	string	The name of the cluster. Required.
private_endpoint_name	string	The name of the private endpoint. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
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. Default value is None.
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. Default value is None.

SELECT examples

get

Gets information about the specified Private Endpoint.

SELECT
id,
name,
createdDate,
etag,
manualPrivateLinkServiceConnections,
type
FROM azure.stream_analytics.private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND private_endpoint_name = '{{ private_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Lists the private endpoints in the cluster.

SELECT
id,
name,
createdDate,
etag,
manualPrivateLinkServiceConnections,
type
FROM azure.stream_analytics.private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
cluster_name,
private_endpoint_name,
subscription_id,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ private_endpoint_name }}',
'{{ subscription_id }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoints resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the private_endpoints resource.
  - name: private_endpoint_name
    value: "{{ private_endpoint_name }}"
    description: Required parameter for the private_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoints resource.
  - name: properties
    description: |
      The properties associated with a private endpoint.
    value:
      createdDate: "{{ createdDate }}"
      manualPrivateLinkServiceConnections:
        - properties:
            privateLinkServiceId: "{{ privateLinkServiceId }}"
            groupIds:
              - "{{ groupIds }}"
            requestMessage: "{{ requestMessage }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
  - name: If-Match
    value: "{{ If-Match }}"
    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. Default value is None.
    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. Default value is None.
  - name: If-None-Match
    value: "{{ If-None-Match }}"
    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. Default value is None.
    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. Default value is None.

REPLACE examples

create_or_update

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

REPLACE azure.stream_analytics.private_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND private_endpoint_name = '{{ private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
AND If-None-Match = '{{ If-None-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Delete the specified private endpoint.

DELETE FROM azure.stream_analytics.private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND private_endpoint_name = '{{ private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;