gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.programmableconnectivity.gateways

Fields

vw_gateways

Name	Datatype	Description
gatewayName	text	field from the properties object
gateway_base_url	text	field from the properties object
location	text	The geo-location where the resource lives
operator_api_connections	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

gateways

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Gateway resource properties
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	gatewayName, resourceGroupName, subscriptionId	Get a Gateway resource by name.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List Gateway resources by resource group.
list_by_subscription	SELECT	subscriptionId	List Gateway resources by subscription ID.
create_or_update	INSERT	gatewayName, resourceGroupName, subscriptionId	Create or update an APC Gateway.
delete	DELETE	gatewayName, resourceGroupName, subscriptionId	Delete a Gateway.
update	UPDATE	gatewayName, resourceGroupName, subscriptionId	Update Gateway tags.

SELECT examples

List Gateway resources by subscription ID.

vw_gateways

SELECT
gatewayName,
gateway_base_url,
location,
operator_api_connections,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.programmableconnectivity.vw_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

gateways

SELECT
location,
properties,
tags
FROM azure.programmableconnectivity.gateways
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.programmableconnectivity.gateways (
gatewayName,
resourceGroupName,
subscriptionId,
properties,
tags,
location
)
SELECT 
'{{ gatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: operatorApiConnections
          value:
            - string
        - name: gatewayBaseUrl
          value: string
        - name: provisioningState
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a gateways resource.

/*+ update */
UPDATE azure.programmableconnectivity.gateways
SET 
tags = '{{ tags }}'
WHERE 
gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified gateways resource.

/*+ delete */
DELETE FROM azure.programmableconnectivity.gateways
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';