endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.hybrid_connectivity.endpoints

Fields

vw_endpoints

Name	Datatype	Description
endpointName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceUri	text	field from the properties object
resource_id	text	field from the properties object
system_data	text	field from the properties object
type	text	field from the properties object

endpoints

Name	Datatype	Description
properties	object	Endpoint details
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	endpointName, resourceUri	Gets the endpoint to the resource.
list	SELECT	resourceUri	List of endpoints to the target resource.
list_ingress_gateway_credentials	SELECT	endpointName, resourceUri	Gets the ingress gateway endpoint credentials
create_or_update	INSERT	endpointName, resourceUri	Create or update the endpoint to the target resource.
delete	DELETE	endpointName, resourceUri	Deletes the endpoint access to the target resource.
update	UPDATE	endpointName, resourceUri	Update the endpoint to the target resource.

SELECT examples

List of endpoints to the target resource.

vw_endpoints

SELECT
endpointName,
provisioning_state,
resourceUri,
resource_id,
system_data,
type
FROM azure.hybrid_connectivity.vw_endpoints
WHERE resourceUri = '{{ resourceUri }}';

endpoints

SELECT
properties,
systemData
FROM azure.hybrid_connectivity.endpoints
WHERE resourceUri = '{{ resourceUri }}';

INSERT example

Use the following StackQL query and manifest file to create a new endpoints resource.

All Properties

/*+ create */
INSERT INTO azure.hybrid_connectivity.endpoints (
endpointName,
resourceUri,
systemData,
properties
)
SELECT 
'{{ endpointName }}',
'{{ resourceUri }}',
'{{ systemData }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: type
          value: string
        - name: resourceId
          value: string
        - name: provisioningState
          value: string

UPDATE example

Updates a endpoints resource.

/*+ update */
UPDATE azure.hybrid_connectivity.endpoints
SET 
systemData = '{{ systemData }}',
properties = '{{ properties }}'
WHERE 
endpointName = '{{ endpointName }}'
AND resourceUri = '{{ resourceUri }}';

DELETE example

Deletes the specified endpoints resource.

/*+ delete */
DELETE FROM azure.hybrid_connectivity.endpoints
WHERE endpointName = '{{ endpointName }}'
AND resourceUri = '{{ resourceUri }}';