swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Connection Gateways API
schemes:
- https
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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definitions
          schema:
            $ref: '#/definitions/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definitions
          schema:
            $ref: '#/definitions/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionGatewayNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definition
          schema:
            $ref: '#/definitions/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionGatewayNameParameter'
      - $ref: '#/parameters/connectionGatewayBodyParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The updated gateway definition
          schema:
            $ref: '#/definitions/ConnectionGatewayDefinition'
        '201':
          description: The newly created gateway definition
          schema:
            $ref: '#/definitions/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionGatewayNameParameter'
      - $ref: '#/parameters/connectionGatewayBodyParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway definition
          schema:
            $ref: '#/definitions/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/connectionGatewayNameParameter'
      - $ref: '#/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/locationParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway installations
          schema:
            $ref: '#/definitions/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: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/locationParameter'
      - $ref: '#/parameters/gatewayIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The gateway installation
          schema:
            $ref: '#/definitions/ConnectionGatewayInstallationDefinition'
definitions:
  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: '#/definitions/ResourceReference'
  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: '#/definitions/TagsDictionary'
    x-ms-azure-resource: true
  ConnectionGatewayInstallationDefinition:
    description: The gateway installation
    type: object
    additionalProperties: false
    properties:
      properties:
        properties:
          connectionGateway:
            $ref: '#/definitions/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: '#/definitions/ResourceDefinition'
  ConnectionGatewayInstallationDefinitionCollection:
    description: A list of connection gateway installation definitions
    type: object
    properties:
      value:
        description: Collection of connection gateway installations
        type: array
        items:
          $ref: '#/definitions/ConnectionGatewayInstallationDefinition'
  ConnectionGatewayDefinition:
    description: The gateway definition
    type: object
    additionalProperties: false
    properties:
      properties:
        properties:
          connectionGatewayInstallation:
            $ref: '#/definitions/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: '#/definitions/ResourceDefinition'
  ConnectionGatewayDefinitionCollection:
    description: A list of connection gateway definitions
    type: object
    properties:
      value:
        description: Collection of connection gateways
        type: array
        items:
          $ref: '#/definitions/ConnectionGatewayDefinition'
  TagsDictionary:
    type: object
    description: Resource tags
    additionalProperties:
      type: string
    example:
      SampleTagName: SampleTagValue
  ResourceReference:
    type: object
    x-abstract: true
    additionalProperties: false
    properties:
      id:
        description: Resource reference id
        type: string
      type:
        description: Resource reference type
        type: string
parameters:
  connectionGatewayNameParameter:
    name: connectionGatewayName
    description: The connection gateway name
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription Id
    required: true
    type: string
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
    x-ms-parameter-location: method
  resourceGroupNameParameter:
    name: resourceGroupName
    description: The resource group
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  connectionGatewayBodyParameter:
    name: connectionGateway
    description: The connection gateway
    in: body
    required: true
    schema:
      $ref: '#/definitions/ConnectionGatewayDefinition'
    x-ms-parameter-location: method
  gatewayIdParameter:
    type: string
    name: gatewayId
    description: Gateway ID
    in: path
    required: true
    x-ms-parameter-location: method
  locationParameter:
    name: location
    description: The location
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'