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
- vw_private_endpoints
- private_endpoints
Name | Datatype | Description |
---|---|---|
clusterName | text | field from the properties object |
created_date | text | field from the properties object |
etag | text | 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. |
manual_private_link_service_connections | text | field from the properties object |
privateEndpointName | text | field from the properties object |
resourceGroupName | text | field from the properties object |
subscriptionId | text | field from the properties object |
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
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | clusterName, privateEndpointName, resourceGroupName, subscriptionId | Gets information about the specified Private Endpoint. |
list_by_cluster | SELECT | clusterName, resourceGroupName, subscriptionId | Lists the private endpoints in the cluster. |
create_or_update | INSERT | clusterName, privateEndpointName, resourceGroupName, subscriptionId | Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint. |
delete | DELETE | clusterName, privateEndpointName, resourceGroupName, subscriptionId | Delete the specified private endpoint. |
SELECT
examples
Lists the private endpoints in the cluster.
- vw_private_endpoints
- private_endpoints
SELECT
clusterName,
created_date,
etag,
manual_private_link_service_connections,
privateEndpointName,
resourceGroupName,
subscriptionId
FROM azure.stream_analytics.vw_private_endpoints
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
etag,
properties
FROM azure.stream_analytics.private_endpoints
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new private_endpoints
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.stream_analytics.private_endpoints (
clusterName,
privateEndpointName,
resourceGroupName,
subscriptionId,
properties
)
SELECT
'{{ clusterName }}',
'{{ privateEndpointName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: createdDate
value: string
- name: manualPrivateLinkServiceConnections
value:
- - name: properties
value:
- name: privateLinkServiceId
value: string
- name: groupIds
value:
- string
- name: requestMessage
value: string
- name: privateLinkServiceConnectionState
value:
- name: status
value: string
- name: description
value: string
- name: actionsRequired
value: string
- name: etag
value: string
DELETE
example
Deletes the specified private_endpoints
resource.
/*+ delete */
DELETE FROM azure.stream_analytics.private_endpoints
WHERE clusterName = '{{ clusterName }}'
AND privateEndpointName = '{{ privateEndpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';