gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.programmableconnectivity.gateways

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

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

list_by_resource_group

Azure operation completed successfully.

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

list_by_subscription

Azure operation completed successfully.

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

Methods

The following methods are available for this resource:

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

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
gatewayName	string	Azure Programmable Connectivity Gateway Name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a Gateway resource by name.

SELECT
location,
properties,
tags
FROM azure.programmableconnectivity.gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND gatewayName = '{{ gatewayName }}' -- required
;

list_by_resource_group

List Gateway resources by resource group.

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

list_by_subscription

List Gateway resources by subscription ID.

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

INSERT examples

create_or_update

Create or update an APC Gateway.

INSERT INTO azure.programmableconnectivity.gateways (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
gatewayName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ gatewayName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: gateways
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateways resource.
    - name: gatewayName
      value: string
      description: Required parameter for the gateways resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update Gateway tags.

UPDATE azure.programmableconnectivity.gateways
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a Gateway.

DELETE FROM azure.programmableconnectivity.gateways
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
;