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:

list_managed_proxy_details

Name	Datatype	Description
expiresOn	integer	The expiration time of short lived proxy name in unix epoch. Required.
proxy	string	The short lived proxy name. Required.

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.
provisioningState	string	The resource provisioning state.
resourceId	string	The resource Id of the connectivity endpoint (optional).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
provisioningState	string	The resource provisioning state.
resourceId	string	The resource Id of the connectivity endpoint (optional).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_managed_proxy_details	select	resource_uri, endpoint_name		Fetches the managed proxy details.
get	select	resource_uri, endpoint_name		Gets the endpoint to the resource.
list	select	resource_uri		List of endpoints to the target resource.
create_or_update	insert	resource_uri, endpoint_name		Create or update the endpoint to the target resource.
update	update	resource_uri, endpoint_name		Update the endpoint to the target resource.
create_or_update	replace	resource_uri, endpoint_name		Create or update the endpoint to the target resource.
delete	delete	resource_uri, endpoint_name		Deletes the endpoint access to the target resource.
list_credentials	exec	resource_uri, endpoint_name	expiresin	Gets the endpoint access credentials to the resource.
list_ingress_gateway_credentials	exec	resource_uri, endpoint_name	expiresin	Gets the ingress gateway endpoint credentials.

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
endpoint_name	string	The endpoint name. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
expiresin	integer	The is how long the endpoint access token is valid (in seconds). Default value is None.

SELECT examples

list_managed_proxy_details

Fetches the managed proxy details.

SELECT
expiresOn,
proxy
FROM azure.hybrid_connectivity.endpoints
WHERE resource_uri = '{{ resource_uri }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
;

get

Gets the endpoint to the resource.

SELECT
id,
name,
provisioningState,
resourceId,
systemData,
type
FROM azure.hybrid_connectivity.endpoints
WHERE resource_uri = '{{ resource_uri }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
;

list

List of endpoints to the target resource.

SELECT
id,
name,
provisioningState,
resourceId,
systemData,
type
FROM azure.hybrid_connectivity.endpoints
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create_or_update

Create or update the endpoint to the target resource.

INSERT INTO azure.hybrid_connectivity.endpoints (
properties,
resource_uri,
endpoint_name
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}',
'{{ endpoint_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the endpoints resource.
  - name: endpoint_name
    value: "{{ endpoint_name }}"
    description: Required parameter for the endpoints resource.
  - name: properties
    description: |
      The endpoint properties.
    value:
      type: "{{ type }}"
      resourceId: "{{ resourceId }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update the endpoint to the target resource.

UPDATE azure.hybrid_connectivity.endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update the endpoint to the target resource.

REPLACE azure.hybrid_connectivity.endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the endpoint access to the target resource.

DELETE FROM azure.hybrid_connectivity.endpoints
WHERE resource_uri = '{{ resource_uri }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
;

Lifecycle Methods

list_credentials

Gets the endpoint access credentials to the resource.

EXEC azure.hybrid_connectivity.endpoints.list_credentials 
@resource_uri='{{ resource_uri }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@expiresin='{{ expiresin }}' 
@@json=
'{
"serviceName": "{{ serviceName }}"
}'
;

list_ingress_gateway_credentials

Gets the ingress gateway endpoint credentials.

EXEC azure.hybrid_connectivity.endpoints.list_ingress_gateway_credentials 
@resource_uri='{{ resource_uri }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@expiresin='{{ expiresin }}' 
@@json=
'{
"serviceName": "{{ serviceName }}"
}'
;