endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.hybrid_connectivity.endpoints

Fields

The following fields are returned by SELECT queries:

get

Endpoint details

Name	Datatype	Description
properties	object	The endpoint properties.
systemData	object	System data of endpoint resource

list_ingress_gateway_credentials

Ingress gateway access

Name	Datatype	Description
ingress	object	Ingress gateway profile
relay	object	Azure relay hybrid connection access properties

list

List of endpoints.

Name	Datatype	Description
properties	object	The endpoint properties.
systemData	object	System data of endpoint resource

Methods

The following methods are available for this resource:

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

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
endpointName	string	The endpoint name.
resourceUri	string	The fully qualified Azure Resource manager identifier of the resource to be connected.
expiresin	integer (int64)	The is how long the endpoint access token is valid (in seconds).

SELECT examples

get

Gets the endpoint to the resource.

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

list_ingress_gateway_credentials

Gets the ingress gateway endpoint credentials

SELECT
ingress,
relay
FROM azure.hybrid_connectivity.endpoints
WHERE resourceUri = '{{ resourceUri }}' -- required
AND endpointName = '{{ endpointName }}' -- required
AND expiresin = '{{ expiresin }}'
;

list

List of endpoints to the target resource.

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

INSERT examples

create_or_update

Create or update the endpoint to the target resource.

INSERT INTO azure.hybrid_connectivity.endpoints (
data__properties,
resourceUri,
endpointName
)
SELECT 
'{{ properties }}',
'{{ resourceUri }}',
'{{ endpointName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the endpoints resource.
    - name: properties
      value: object
      description: |
        The endpoint properties.

UPDATE examples

update

Update the endpoint to the target resource.

UPDATE azure.hybrid_connectivity.endpoints
SET 
data__properties = '{{ properties }}'
WHERE 
resourceUri = '{{ resourceUri }}' --required
AND endpointName = '{{ endpointName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes the endpoint access to the target resource.

DELETE FROM azure.hybrid_connectivity.endpoints
WHERE resourceUri = '{{ resourceUri }}' --required
AND endpointName = '{{ endpointName }}' --required
;