Microsoft Azure
Microsoft Azure MeshGateways API

The MeshGateways API from Microsoft Azure — 2 operation(s) for meshgateways.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MeshGateways API
schemes:
- https
tags:
- name: MeshGateways
paths:
  /Resources/Gateways/{gatewayResourceName}:
    put:
      operationId: microsoftAzureMeshgatewayCreateorupdate
      x-ms-examples:
        CreateOrUpdateMeshGateway:
          $ref: ./examples/Resources/Gateways/create_update.json
      summary: Microsoft Azure Creates Or Updates A Gateway Resource
      description: 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.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam'
      - $ref: '#/parameters/GatewayResourceNameRequiredPathParam'
      - $ref: '#/parameters/GatewayResourceDescriptionRequiredBodyParam'
      tags:
      - MeshGateways
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GatewayResourceDescription'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/GatewayResourceDescription'
        '202':
          description: Accepted
        default:
          description: Error
          schema:
            $ref: '#/definitions/FabricError'
    get:
      operationId: microsoftAzureMeshgatewayGet
      x-ms-examples:
        GetGatewayResource:
          $ref: ./examples/Resources/Gateways/get.json
      summary: Microsoft Azure Gets The Gateway Resource With The Given Name
      description: Gets the information about the Gateway resource with the given name. The information include the description and other properties of the Gateway.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam'
      - $ref: '#/parameters/GatewayResourceNameRequiredPathParam'
      tags:
      - MeshGateways
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GatewayResourceDescription'
        default:
          description: Error
          schema:
            $ref: '#/definitions/FabricError'
    delete:
      operationId: microsoftAzureMeshgatewayDelete
      x-ms-examples:
        DeleteGatewayResource:
          $ref: ./examples/Resources/Gateways/delete.json
      summary: Microsoft Azure Deletes The Gateway Resource
      description: Deletes the Gateway resource identified by the name.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam'
      - $ref: '#/parameters/GatewayResourceNameRequiredPathParam'
      tags:
      - MeshGateways
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: No Content - the specified gateway was not found.
        default:
          description: Error
          schema:
            $ref: '#/definitions/FabricError'
  /Resources/Gateways:
    get:
      operationId: microsoftAzureMeshgatewayList
      x-ms-examples:
        ListMeshGateways:
          $ref: ./examples/Resources/Gateways/list.json
      summary: Microsoft Azure Lists All The Gateway Resources
      description: Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam'
      tags:
      - MeshGateways
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PagedGatewayResourceDescriptionList'
        default:
          description: Error
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  FabricErrorError:
    description: Error object containing error code and error message.
    properties:
      Code:
        $ref: '#/definitions/FabricErrorCodes'
        description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
      Message:
        type: string
        description: Error message.
    required:
    - Code
  NetworkRef:
    description: Describes a network reference in a service.
    properties:
      name:
        type: string
        description: Name of the network
      endpointRefs:
        description: A list of endpoints that are exposed on this network.
        type: array
        items:
          $ref: '#/definitions/EndpointRef'
  HttpRouteConfig:
    description: Describes the hostname properties for http routing.
    type: object
    properties:
      name:
        type: string
        description: http route name.
      match:
        $ref: '#/definitions/HttpRouteMatchRule'
        description: Describes a rule for http route matching.
      destination:
        $ref: '#/definitions/GatewayDestination'
        description: Describes destination endpoint for routing traffic.
    required:
    - destination
    - match
    - name
  EndpointRef:
    description: Describes a reference to a service endpoint.
    properties:
      name:
        type: string
        description: Name of the endpoint.
  GatewayResourceDescription:
    description: This type describes a gateway resource.
    properties:
      name:
        $ref: '#/definitions/GatewayResourceName'
        description: Name of the Gateway resource.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/GatewayProperties'
        description: Describes properties of a gateway resource.
    required:
    - name
    - properties
  HttpConfig:
    description: Describes the http configuration for external connectivity for this network.
    type: object
    properties:
      name:
        type: string
        description: http gateway config name.
      port:
        type: integer
        description: Specifies the port at which the service endpoint below needs to be exposed.
      hosts:
        type: array
        description: description for routing.
        items:
          $ref: '#/definitions/HttpHostConfig'
    required:
    - hosts
    - name
    - port
  ResourceStatus:
    description: Status of the resource.
    type: string
    enum:
    - Unknown
    - Ready
    - Upgrading
    - Creating
    - Deleting
    - Failed
    x-ms-enum:
      name: ResourceStatus
      modelAsString: true
      values:
      - value: Unknown
        description: Indicates the resource status is unknown. The value is zero.
      - value: Ready
        description: Indicates the resource is ready. The value is 1.
      - value: Upgrading
        description: Indicates the resource is upgrading. The value is 2.
      - value: Creating
        description: Indicates the resource is being created. The value is 3.
      - value: Deleting
        description: Indicates the resource is being deleted. The value is 4.
      - value: Failed
        description: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5.
  GatewayProperties:
    description: Describes properties of a gateway resource.
    properties:
      description:
        description: User readable description of the gateway.
        type: string
      sourceNetwork:
        $ref: '#/definitions/NetworkRef'
        description: Network the gateway should listen on for requests.
      destinationNetwork:
        $ref: '#/definitions/NetworkRef'
        description: Network that the Application is using.
      tcp:
        description: Configuration for tcp connectivity for this gateway.
        type: array
        items:
          $ref: '#/definitions/TcpConfig'
      http:
        description: Configuration for http connectivity for this gateway.
        type: array
        items:
          $ref: '#/definitions/HttpConfig'
      status:
        readOnly: true
        $ref: '#/definitions/ResourceStatus'
        description: Status of the resource.
      statusDetails:
        readOnly: true
        type: string
        description: Gives additional information about the current status of the gateway.
      ipAddress:
        readOnly: true
        type: string
        description: IP address of the gateway. This is populated in the response and is ignored for incoming requests.
    required:
    - destinationNetwork
    - sourceNetwork
  FabricErrorCodes:
    type: string
    description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
    enum:
    - FABRIC_E_INVALID_PARTITION_KEY
    - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
    - FABRIC_E_INVALID_ADDRESS
    - FABRIC_E_APPLICATION_NOT_UPGRADING
    - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
    - FABRIC_E_FABRIC_NOT_UPGRADING
    - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
    - FABRIC_E_INVALID_CONFIGURATION
    - FABRIC_E_INVALID_NAME_URI
    - FABRIC_E_PATH_TOO_LONG
    - FABRIC_E_KEY_TOO_LARGE
    - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
    - FABRIC_E_INVALID_ATOMIC_GROUP
    - FABRIC_E_VALUE_EMPTY
    - FABRIC_E_NODE_NOT_FOUND
    - FABRIC_E_APPLICATION_TYPE_NOT_FOUND
    - FABRIC_E_APPLICATION_NOT_FOUND
    - FABRIC_E_SERVICE_TYPE_NOT_FOUND
    - FABRIC_E_SERVICE_DOES_NOT_EXIST
    - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
    - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
    - FABRIC_E_PARTITION_NOT_FOUND
    - FABRIC_E_REPLICA_DOES_NOT_EXIST
    - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
    - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
    - FABRIC_E_DIRECTORY_NOT_FOUND
    - FABRIC_E_FABRIC_VERSION_NOT_FOUND
    - FABRIC_E_FILE_NOT_FOUND
    - FABRIC_E_NAME_DOES_NOT_EXIST
    - FABRIC_E_PROPERTY_DOES_NOT_EXIST
    - FABRIC_E_ENUMERATION_COMPLETED
    - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
    - FABRIC_E_KEY_NOT_FOUND
    - FABRIC_E_HEALTH_ENTITY_NOT_FOUND
    - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
    - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
    - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
    - FABRIC_E_SERVICE_ALREADY_EXISTS
    - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_TYPE_IN_USE
    - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
    - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
    - FABRIC_E_FABRIC_VERSION_IN_USE
    - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
    - FABRIC_E_NAME_ALREADY_EXISTS
    - FABRIC_E_NAME_NOT_EMPTY
    - FABRIC_E_PROPERTY_CHECK_FAILED
    - FABRIC_E_SERVICE_METADATA_MISMATCH
    - FABRIC_E_SERVICE_TYPE_MISMATCH
    - FABRIC_E_HEALTH_STALE_REPORT
    - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
    - FABRIC_E_NODE_HAS_NOT_STOPPED_YET
    - FABRIC_E_INSTANCE_ID_MISMATCH
    - FABRIC_E_VALUE_TOO_LARGE
    - FABRIC_E_NO_WRITE_QUORUM
    - FABRIC_E_NOT_PRIMARY
    - FABRIC_E_NOT_READY
    - FABRIC_E_RECONFIGURATION_PENDING
    - FABRIC_E_SERVICE_OFFLINE
    - E_ABORT
    - FABRIC_E_COMMUNICATION_ERROR
    - FABRIC_E_OPERATION_NOT_COMPLETE
    - FABRIC_E_TIMEOUT
    - FABRIC_E_NODE_IS_UP
    - E_FAIL
    - FABRIC_E_BACKUP_IS_ENABLED
    - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
    - FABRIC_E_INVALID_FOR_STATELESS_SERVICES
    - FABRIC_E_BACKUP_NOT_ENABLED
    - FABRIC_E_BACKUP_POLICY_NOT_EXISTING
    - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
    - FABRIC_E_BACKUP_IN_PROGRESS
    - FABRIC_E_RESTORE_IN_PROGRESS
    - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
    - FABRIC_E_INVALID_SERVICE_SCALING_POLICY
    - E_INVALIDARG
    - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
    - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
    - FABRIC_E_VOLUME_ALREADY_EXISTS
    - FABRIC_E_VOLUME_NOT_FOUND
    - SerializationError
    - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
    x-ms-enum:
      name: FabricErrorCodes
      modelAsString: true
      values:
      - value: FABRIC_E_INVALID_PARTITION_KEY
      - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
      - value: FABRIC_E_INVALID_ADDRESS
      - value: FABRIC_E_APPLICATION_NOT_UPGRADING
      - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
      - value: FABRIC_E_FABRIC_NOT_UPGRADING
      - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
      - value: FABRIC_E_INVALID_CONFIGURATION
      - value: FABRIC_E_INVALID_NAME_URI
      - value: FABRIC_E_PATH_TOO_LONG
      - value: FABRIC_E_KEY_TOO_LARGE
      - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
      - value: FABRIC_E_INVALID_ATOMIC_GROUP
      - value: FABRIC_E_VALUE_EMPTY
      - value: FABRIC_E_NODE_NOT_FOUND
      - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
      - value: FABRIC_E_APPLICATION_NOT_FOUND
      - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
      - value: FABRIC_E_SERVICE_DOES_NOT_EXIST
      - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
      - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
      - value: FABRIC_E_PARTITION_NOT_FOUND
      - value: FABRIC_E_REPLICA_DOES_NOT_EXIST
      - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
      - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
      - value: FABRIC_E_DIRECTORY_NOT_FOUND
      - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
      - value: FABRIC_E_FILE_NOT_FOUND
      - value: FABRIC_E_NAME_DOES_NOT_EXIST
      - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
      - value: FABRIC_E_ENUMERATION_COMPLETED
      - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
      - value: FABRIC_E_KEY_NOT_FOUND
      - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
      - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
      - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
      - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
      - value: FABRIC_E_SERVICE_ALREADY_EXISTS
      - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_TYPE_IN_USE
      - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
      - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
      - value: FABRIC_E_FABRIC_VERSION_IN_USE
      - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
      - value: FABRIC_E_NAME_ALREADY_EXISTS
      - value: FABRIC_E_NAME_NOT_EMPTY
      - value: FABRIC_E_PROPERTY_CHECK_FAILED
      - value: FABRIC_E_SERVICE_METADATA_MISMATCH
      - value: FABRIC_E_SERVICE_TYPE_MISMATCH
      - value: FABRIC_E_HEALTH_STALE_REPORT
      - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
      - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
      - value: FABRIC_E_INSTANCE_ID_MISMATCH
      - value: FABRIC_E_VALUE_TOO_LARGE
      - value: FABRIC_E_NO_WRITE_QUORUM
      - value: FABRIC_E_NOT_PRIMARY
      - value: FABRIC_E_NOT_READY
      - value: FABRIC_E_RECONFIGURATION_PENDING
      - value: FABRIC_E_SERVICE_OFFLINE
      - value: E_ABORT
      - value: FABRIC_E_COMMUNICATION_ERROR
      - value: FABRIC_E_OPERATION_NOT_COMPLETE
      - value: FABRIC_E_TIMEOUT
      - value: FABRIC_E_NODE_IS_UP
      - value: E_FAIL
      - value: FABRIC_E_BACKUP_IS_ENABLED
      - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
      - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
      - value: FABRIC_E_BACKUP_NOT_ENABLED
      - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
      - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
      - value: FABRIC_E_BACKUP_IN_PROGRESS
      - value: FABRIC_E_RESTORE_IN_PROGRESS
      - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
      - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
      - value: E_INVALIDARG
      - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
      - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
      - value: FABRIC_E_VOLUME_ALREADY_EXISTS
      - value: FABRIC_E_VOLUME_NOT_FOUND
      - value: SerializationError
      - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
  ContinuationToken:
    type: string
    description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
  HttpRouteMatchPath:
    description: Path to match for routing.
    type: object
    properties:
      value:
        type: string
        description: Uri path to match for request.
      rewrite:
        type: string
        description: replacement string for matched part of the Uri.
      type:
        type: string
        description: how to match value in the Uri
        enum:
        - prefix
        x-ms-enum:
          name: PathMatchType
          modelAsString: true
    required:
    - type
    - value
  GatewayDestination:
    description: Describes destination endpoint for routing traffic.
    type: object
    properties:
      applicationName:
        type: string
        description: Name of the service fabric Mesh application.
      serviceName:
        type: string
        description: service that contains the endpoint.
      endpointName:
        type: string
        description: name of the endpoint in the service.
    required:
    - applicationName
    - endpointName
    - serviceName
  FabricError:
    description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
    properties:
      Error:
        $ref: '#/definitions/FabricErrorError'
        description: Error object containing error code and error message.
    required:
    - Error
  TcpConfig:
    description: Describes the tcp configuration for external connectivity for this network.
    type: object
    properties:
      name:
        type: string
        description: tcp gateway config name.
      port:
        type: integer
        description: Specifies the port at which the service endpoint below needs to be exposed.
      destination:
        $ref: '#/definitions/GatewayDestination'
        description: Describes destination endpoint for routing traffic.
    required:
    - destination
    - name
    - port
  HttpRouteMatchRule:
    description: Describes a rule for http route matching.
    type: object
    properties:
      path:
        $ref: '#/definitions/HttpRouteMatchPath'
        description: Path to match for routing.
      headers:
        type: array
        description: headers and their values to match in request.
        items:
          $ref: '#/definitions/HttpRouteMatchHeader'
    required:
    - path
  PagedGatewayResourceDescriptionList:
    type: object
    description: The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
    properties:
      ContinuationToken:
        $ref: '#/definitions/ContinuationToken'
        description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
      Items:
        type: array
        description: One page of the list.
        items:
          $ref: '#/definitions/GatewayResourceDescription'
  HttpRouteMatchHeader:
    description: Describes header information for http route matching.
    type: object
    properties:
      name:
        type: string
        description: Name of header to match in request.
      value:
        type: string
        description: Value of header to match in request.
      type:
        type: string
        description: how to match header value
        enum:
        - exact
        x-ms-enum:
          name: HeaderMatchType
          modelAsString: true
    required:
    - name
  HttpHostConfig:
    description: Describes the hostname properties for http routing.
    type: object
    properties:
      name:
        type: string
        description: http hostname config name.
      routes:
        type: array
        description: 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.
        items:
          $ref: '#/definitions/HttpRouteConfig'
    required:
    - name
    - routes
  GatewayResourceName:
    type: string
    description: Name of the Gateway resource.
parameters:
  ApiVersion_6-4-Preview_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - 6.4-preview
    required: true
    default: 6.4-preview
    description: The version of the API. This parameter is required and its value must be '6.4-preview'.
    x-ms-enum:
      name: ApiVersion_6-4-Preview_RequiredQueryParam
      modelAsString: true
      values:
      - value: 6.4-preview
        description: The version number for the preview functionality of 6.4 runtime
  GatewayResourceNameRequiredPathParam:
    name: gatewayResourceName
    in: path
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    required: true
    description: The identity of the gateway.
  GatewayResourceDescriptionRequiredBodyParam:
    name: gatewayResourceDescription
    in: body
    description: Description for creating a Gateway resource.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/GatewayResourceDescription'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'
Microsoft Azure MeshGateways API

Documentation

Specifications

Other Resources

OpenAPI Specification
