Microsoft Azure Connection Gateways API

openapi: 3.2.0
info:
  title: Microsoft Azure LogicAppsManagementClient Connection…
  version: '2016-06-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Connection Gateways
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/connectionGateways:
    get:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Lists All Of The Connection Gateways
      operationId: microsoftAzureConnectiongatewaysList
      description: Gets a list of gateways under a subscription
      x-ms-examples:
        List all connection gateways:
          $ref: ./examples/connectionGatewaysList.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayDefinitionCollection'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways:
    get:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Lists All Of The Connection Gateways
      operationId: microsoftAzureConnectiongatewaysListbyresourcegroup
      description: Gets a list of gateways under a subscription and in a specific resource group
      x-ms-examples:
        List all connection gateways:
          $ref: ./examples/connectionGatewaysListByResourceGroup.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayDefinitionCollection'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways/{connectionGatewayName}
  : get:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Gets A Specific Gateway
      operationId: microsoftAzureConnectiongatewaysGet
      description: Gets a specific gateway under a subscription and in a specific resource group
      x-ms-examples:
        Get the connection gateway definition:
          $ref: ./examples/connectionGatewaysGet.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/connectionGatewayNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayDefinition'
    put:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Replaces A Specific Gateway
      operationId: microsoftAzureConnectiongatewaysCreateorupdate
      description: Creates or updates a specific gateway for under a subscription and in a specific resource group
      x-ms-examples:
        Replace a connection gateway definition:
          $ref: ./examples/connectionGatewaysCreateOrUpdate.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/connectionGatewayNameParameter'
      - $ref: '#/components/parameters/connectionGatewayBodyParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The updated gateway definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayDefinition'
        '201':
          description: The newly created gateway definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayDefinition'
    patch:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Updates A Specific Gateway
      operationId: microsoftAzureConnectiongatewaysUpdate
      description: Updates a connection gateway's tags
      x-ms-examples:
        Update a connection gateway's tags:
          $ref: ./examples/connectionGatewaysUpdate.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/connectionGatewayNameParameter'
      - $ref: '#/components/parameters/connectionGatewayBodyParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayDefinition'
    delete:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Deletes A Specific Gateway
      operationId: microsoftAzureConnectiongatewaysDelete
      description: Deletes a specific gateway for under a subscription and in a specific resource group
      x-ms-examples:
        Delete a connection gateway definition:
          $ref: ./examples/connectionGatewaysDelete.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/connectionGatewayNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the connection gateway
        '204':
          description: No connection gateway to delete
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/connectionGatewayInstallations:
    get:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Gets A List Of Installed Gateways That The User Is An Admin Of
      operationId: microsoftAzureConnectiongatewayinstallationsList
      description: Gets a list of installed gateways that the user is an admin of, in a specific subscription and at a certain location
      x-ms-examples:
        List all installations in a region:
          $ref: ./examples/connectionGatewayInstallationsList.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/locationParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway installations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayInstallationDefinitionCollection'
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/connectionGatewayInstallations/{gatewayId}:
    get:
      tags:
      - Connection Gateways
      summary: Microsoft Azure Gets An Installed Gateway That The User Is An Admin Of
      operationId: microsoftAzureConnectiongatewayinstallationsGet
      description: Get a specific installed gateway that the user is an admin of, in a specific subscription and at a certain location
      x-ms-examples:
        Get a specific gateway installation:
          $ref: ./examples/connectionGatewayInstallationsGet.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/locationParameter'
      - $ref: '#/components/parameters/gatewayIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway installation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionGatewayInstallationDefinition'
components:
  parameters:
    resourceGroupNameParameter:
      name: resourceGroupName
      description: The resource group
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    gatewayIdParameter:
      name: gatewayId
      description: Gateway ID
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Subscription Id
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    connectionGatewayNameParameter:
      name: connectionGatewayName
      description: The connection gateway name
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    locationParameter:
      name: location
      description: The location
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    connectionGatewayBodyParameter:
      name: connectionGateway
      description: The connection gateway
      in: body
      required: true
      schema:
        $ref: '#/components/schemas/ConnectionGatewayDefinition'
      x-ms-parameter-location: method
    apiVersionParameter:
      name: api-version
      in: query
      description: API Version
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    ResourceReference:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        id:
          description: Resource reference id
          type: string
        type:
          description: Resource reference type
          type: string
    ResourceDefinition:
      description: A resource
      type: object
      additionalProperties: false
      properties:
        id:
          description: Resource id
          type: string
          readOnly: true
        name:
          description: Resource name
          type: string
          readOnly: true
        type:
          description: Resource type
          type: string
          readOnly: true
        location:
          description: Resource location
          type: string
        etag:
          description: Resource ETag
          type: string
        tags:
          $ref: '#/components/schemas/TagsDictionary'
      x-ms-azure-resource: true
    TagsDictionary:
      type: object
      description: Resource tags
      additionalProperties:
        type: string
      example:
        SampleTagName: SampleTagValue
    ConnectionGatewayDefinition:
      description: The gateway definition
      type: object
      additionalProperties: false
      properties:
        properties:
          properties:
            connectionGatewayInstallation:
              $ref: '#/components/schemas/ConnectionGatewayReference'
            contactInformation:
              description: The gateway admin
              type: array
              items:
                type: string
            displayName:
              description: The gateway display name
              type: string
            description:
              description: The gateway description
              type: string
            machineName:
              description: The machine name of the gateway
              type: string
            status:
              description: The gateway status
              type: object
            backendUri:
              description: The URI of the backend
              type: string
      allOf:
      - $ref: '#/components/schemas/ResourceDefinition'
    ConnectionGatewayReference:
      description: The gateway installation reference
      type: object
      properties:
        location:
          description: Resource reference location
          type: string
        name:
          description: Resource reference name
          type: string
      allOf:
      - $ref: '#/components/schemas/ResourceReference'
    ConnectionGatewayInstallationDefinitionCollection:
      description: A list of connection gateway installation definitions
      type: object
      properties:
        value:
          description: Collection of connection gateway installations
          type: array
          items:
            $ref: '#/components/schemas/ConnectionGatewayInstallationDefinition'
    ConnectionGatewayInstallationDefinition:
      description: The gateway installation
      type: object
      additionalProperties: false
      properties:
        properties:
          properties:
            connectionGateway:
              $ref: '#/components/schemas/ConnectionGatewayReference'
            contactInformation:
              description: The gateway admin
              type: array
              items:
                type: string
            displayName:
              description: The gateway display name
              type: string
            description:
              description: The gateway description
              type: string
            machineName:
              description: The machine name of the gateway
              type: string
            status:
              description: The gateway status
              type: object
            backendUri:
              description: The URI of the backend
              type: string
      allOf:
      - $ref: '#/components/schemas/ResourceDefinition'
    ConnectionGatewayDefinitionCollection:
      description: A list of connection gateway definitions
      type: object
      properties:
        value:
          description: Collection of connection gateways
          type: array
          items:
            $ref: '#/components/schemas/ConnectionGatewayDefinition'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate a user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow