gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.service_fabric_mesh.gateways

Fields

vw_gateways

Name	Datatype	Description
description	text	field from the properties object
destination_network	text	field from the properties object
gatewayResourceName	text	field from the properties object
http	text	field from the properties object
ip_address	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
source_network	text	field from the properties object
status	text	field from the properties object
status_details	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
tcp	text	field from the properties object

gateways

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	This type describes properties of a gateway resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	gatewayResourceName, resourceGroupName, subscriptionId	Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
list_by_subscription	SELECT	subscriptionId	Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.
create	INSERT	gatewayResourceName, resourceGroupName, subscriptionId, data__properties	Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.
delete	DELETE	gatewayResourceName, resourceGroupName, subscriptionId	Deletes the gateway resource identified by the name.

SELECT examples

Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.

vw_gateways

SELECT
description,
destination_network,
gatewayResourceName,
http,
ip_address,
location,
provisioning_state,
resourceGroupName,
source_network,
status,
status_details,
subscriptionId,
tags,
tcp
FROM azure.service_fabric_mesh.vw_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

gateways

SELECT
location,
properties,
tags
FROM azure.service_fabric_mesh.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.service_fabric_mesh.gateways (
gatewayResourceName,
resourceGroupName,
subscriptionId,
data__properties,
tags,
location,
properties
)
SELECT 
'{{ gatewayResourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: description
          value: string
        - name: sourceNetwork
          value:
            - name: name
              value: string
            - name: endpointRefs
              value:
                - - name: name
                    value: string
        - name: tcp
          value:
            - - name: name
                value: string
              - name: port
                value: integer
              - name: destination
                value:
                  - name: applicationName
                    value: string
                  - name: serviceName
                    value: string
                  - name: endpointName
                    value: string
        - name: http
          value:
            - - name: name
                value: string
              - name: port
                value: integer
              - name: hosts
                value:
                  - - name: name
                      value: string
                    - name: routes
                      value:
                        - - name: name
                            value: string
                          - name: match
                            value:
                              - name: path
                                value:
                                  - name: value
                                    value: string
                                  - name: rewrite
                                    value: string
                                  - name: type
                                    value: string
                              - name: headers
                                value:
                                  - - name: name
                                      value: string
                                    - name: value
                                      value: string
                                    - name: type
                                      value: string
        - name: status
          value: []
        - name: statusDetails
          value: string
        - name: ipAddress
          value: string

DELETE example

Deletes the specified gateways resource.

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