mesh_gateway

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

Overview

Name	mesh_gateway
Type	Resource
Id	azure.service_fabric_dataplane.mesh_gateway

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
description	string
destinationNetwork	object	Describes a network reference in a service.
http	array
ipAddress	string	IP address of the gateway. This is populated in the response and is ignored for incoming requests.
sourceNetwork	object	Describes a network reference in a service.
status	string	Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
statusDetails	string	Gives additional information about the current status of the gateway.
tcp	array

list

Name	Datatype	Description
ContinuationToken	string
Items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	gateway_resource_name, endpoint		Gets the Gateway resource with the given name. Gets the information about the Gateway resource with the given name. The information include the description and other properties of the Gateway.
list	select	endpoint		Lists all the gateway resources. Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
create_or_update	insert	gateway_resource_name, endpoint, name, properties		Creates or updates a Gateway resource. Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.
create_or_update	replace	gateway_resource_name, endpoint, name, properties		Creates or updates a Gateway resource. Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.
delete	delete	gateway_resource_name, endpoint		Deletes the Gateway resource. 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
endpoint	string	The service endpoint host (no scheme). (default: )
gateway_resource_name	string	The identity of the gateway.

SELECT examples

get

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

SELECT
name,
description,
destinationNetwork,
http,
ipAddress,
sourceNetwork,
status,
statusDetails,
tcp
FROM azure.service_fabric_dataplane.mesh_gateway
WHERE gateway_resource_name = '{{ gateway_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

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

SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.mesh_gateway
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Gateway resource. Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.

INSERT INTO azure.service_fabric_dataplane.mesh_gateway (
name,
properties,
gateway_resource_name,
endpoint
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ gateway_resource_name }}',
'{{ endpoint }}'
RETURNING
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: mesh_gateway
props:
  - name: gateway_resource_name
    value: "{{ gateway_resource_name }}"
    description: Required parameter for the mesh_gateway resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the mesh_gateway resource.
  - name: name
    value: "{{ name }}"
  - name: properties
    value:
      description: "{{ description }}"
      sourceNetwork:
        name: "{{ name }}"
        endpointRefs:
          - name: "{{ name }}"
      destinationNetwork:
        name: "{{ name }}"
        endpointRefs:
          - name: "{{ name }}"
      tcp:
        - name: "{{ name }}"
          port: {{ port }}
          destination:
            applicationName: "{{ applicationName }}"
            serviceName: "{{ serviceName }}"
            endpointName: "{{ endpointName }}"
      http:
        - name: "{{ name }}"
          port: {{ port }}
          hosts: "{{ hosts }}"

REPLACE examples

create_or_update

Creates or updates a Gateway resource. Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.

REPLACE azure.service_fabric_dataplane.mesh_gateway
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
gateway_resource_name = '{{ gateway_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND name = '{{ name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
name,
properties;

DELETE examples

delete

Deletes the Gateway resource. Deletes the Gateway resource identified by the name.

DELETE FROM azure.service_fabric_dataplane.mesh_gateway
WHERE gateway_resource_name = '{{ gateway_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;