---
title: "Gets the Gateway resource with the given name."
method: GET
path: "/Resources/Gateways/{gatewayResourceName}"
tags: ["MeshGateways"]
---

# Gets the Gateway resource with the given name.

`GET /Resources/Gateways/{gatewayResourceName}`

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

## Path parameters

- `gatewayResourceName` string, required

## Query parameters

- `api-version` '6.4-preview', required

## Response `200`

OK

- GatewayResourceDescription — This type describes a gateway resource.
  - `name` string, required — Name of the Gateway resource.
  - `properties` GatewayProperties, required — Describes properties of a gateway resource.
    - `description` string — User readable description of the gateway.
    - `sourceNetwork` NetworkRef, required — Describes a network reference in a service.
      - `name` string — Name of the network
      - `endpointRefs` EndpointRef[] — A list of endpoints that are exposed on this network.
        - `name` string — Name of the endpoint.
    - `destinationNetwork` NetworkRef, required — Describes a network reference in a service.
      - `name` string — Name of the network
      - `endpointRefs` EndpointRef[] — A list of endpoints that are exposed on this network.
        - `name` string — Name of the endpoint.
    - `tcp` TcpConfig[] — Configuration for tcp connectivity for this gateway.
      - `name` string, required — tcp gateway config name.
      - `port` integer, required — Specifies the port at which the service endpoint below needs to be exposed.
      - `destination` GatewayDestination, required — Describes destination endpoint for routing traffic.
        - `applicationName` string, required — Name of the service fabric Mesh application.
        - `serviceName` string, required — service that contains the endpoint.
        - `endpointName` string, required — name of the endpoint in the service.
    - `http` HttpConfig[] — Configuration for http connectivity for this gateway.
      - `name` string, required — http gateway config name.
      - `port` integer, required — Specifies the port at which the service endpoint below needs to be exposed.
      - `hosts` HttpHostConfig[], required — description for routing.
        - `name` string, required — http hostname config name.
        - `routes` HttpRouteConfig[], required — Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.
          - `name` string, required — http route name.
          - `match` HttpRouteMatchRule, required — Describes a rule for http route matching.
            - `path` HttpRouteMatchPath, required — Path to match for routing.
              - …
            - `headers` HttpRouteMatchHeader[] — headers and their values to match in request.
              - …
          - `destination` GatewayDestination, required — Describes destination endpoint for routing traffic.
            - `applicationName` string, required — Name of the service fabric Mesh application.
            - `serviceName` string, required — service that contains the endpoint.
            - `endpointName` string, required — name of the endpoint in the service.
    - `status` 'Unknown' | 'Ready' | 'Upgrading' | 'Creating' | 'Deleting' | 'Failed' — Status of the resource.
    - `statusDetails` string — Gives additional information about the current status of the gateway.
    - `ipAddress` string — IP address of the gateway. This is populated in the response and is ignored for incoming requests.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/azure/apis/service-fabric-client-apis.md) · [All operations](https://skmtc.net/azure/apis/service-fabric-client-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/service-fabric-client-apis/versions/6df9f2f4d542/schema)