gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.service_fabric_mesh.gateways

Fields

The following fields are returned by SELECT queries:

get

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.

list_by_resource_group

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.

list_by_subscription

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, gatewayResourceName	api-version	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	subscriptionId, resourceGroupName	api-version	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	api-version	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	subscriptionId, resourceGroupName, gatewayResourceName, data__properties	api-version	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	subscriptionId, resourceGroupName, gatewayResourceName	api-version	Deletes the gateway resource identified by the name.

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
gatewayResourceName	string	The identity of the gateway.
resourceGroupName	string	Azure resource group name
subscriptionId	string	The customer subscription identifier
api-version	string	The version of the API. This parameter is required and its value must be 2018-09-01-preview.

SELECT examples

get

Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.

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

list_by_resource_group

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

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

list_by_subscription

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

SELECT
location,
properties,
tags
FROM azure.service_fabric_mesh.gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

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.

INSERT INTO azure.service_fabric_mesh.gateways (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
gatewayResourceName,
api-version
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ gatewayResourceName }}',
'{{ api-version }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: gateways
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateways resource.
    - name: gatewayResourceName
      value: string
      description: Required parameter for the gateways resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        This type describes properties of a gateway resource.
    - name: api-version
      value: string
      description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`.

DELETE examples

delete

Deletes the gateway resource identified by the name.

DELETE FROM azure.service_fabric_mesh.gateways
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND gatewayResourceName = '{{ gatewayResourceName }}' --required
AND api-version = '{{ api-version }}'
;