Microsoft Azure BotConnection API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BotConnection API
schemes:
- https
tags:
- name: BotConnection
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets
  : post:
      tags:
      - BotConnection
      x-ms-examples:
        List Connection Setting With Secrets:
          $ref: ./examples/GetConnection.json
      description: Get a Connection Setting registration for a Bot Service
      operationId: microsoftAzureBotconnectionListwithsecrets
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/resourceNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: 'The resource provider should return 200 (OK) to indicate that the operation completed successfully. '
          schema:
            $ref: '#/definitions/ConnectionSetting'
        default:
          description: Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname Listwithsecrets
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
  : put:
      tags:
      - BotConnection
      description: Register a new Auth Connection for a Bot Service
      operationId: microsoftAzureBotconnectionCreate
      x-ms-examples:
        Create Connection Setting:
          $ref: ./examples/PutConnection.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/resourceNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ConnectionSetting'
        description: The parameters to provide for creating the Connection Setting.
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: If resource is created successfully or already existed, the service should return 200 (OK).
          schema:
            $ref: '#/definitions/ConnectionSetting'
        '201':
          description: If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.
          schema:
            $ref: '#/definitions/ConnectionSetting'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname
    patch:
      tags:
      - BotConnection
      description: Updates a Connection Setting registration for a Bot Service
      operationId: microsoftAzureBotconnectionUpdate
      x-ms-examples:
        Update Connection Setting:
          $ref: ./examples/UpdateConnection.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/resourceNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ConnectionSetting'
        description: The parameters to provide for updating the Connection Setting.
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: If resource is created successfully or already existed, the service should return 200 (OK).
          schema:
            $ref: '#/definitions/ConnectionSetting'
        '201':
          description: If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.
          schema:
            $ref: '#/definitions/ConnectionSetting'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname
    get:
      tags:
      - BotConnection
      x-ms-examples:
        Get Connection Setting:
          $ref: ./examples/GetConnection.json
      description: Get a Connection Setting registration for a Bot Service
      operationId: microsoftAzureBotconnectionGet
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/resourceNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: 'The resource provider should return 200 (OK) to indicate that the operation completed successfully. '
          schema:
            $ref: '#/definitions/ConnectionSetting'
        default:
          description: Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname
    delete:
      tags:
      - BotConnection
      description: Deletes a Connection Setting registration for a Bot Service
      operationId: microsoftAzureBotconnectionDelete
      x-ms-examples:
        Delete Connection Setting:
          $ref: ./examples/DeleteConnection.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/resourceNameParameter'
      - $ref: '#/parameters/connectionNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: A 200 (OK) should be returned if the object exists and was deleted successfully;
        '204':
          description: a 204 (NoContent) should be used if the resource does not exist and the request is well formed.
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections
  : get:
      tags:
      - BotConnection
      description: Returns all the Connection Settings registered to a particular BotService resource
      operationId: microsoftAzureBotconnectionListbybotservice
      x-ms-examples:
        List Connection Settings:
          $ref: ./examples/ListConnectionsByBotService.json
      parameters:
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/resourceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed."
          schema:
            $ref: '#/definitions/ConnectionSettingResponseList'
        default:
          description: Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.
          schema:
            $ref: '#/definitions/Error'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections
definitions:
  ConnectionSettingProperties:
    properties:
      id:
        type: string
        description: Id of the Connection Setting.
      name:
        type: string
        description: Name of the Connection Setting.
      clientId:
        type: string
        description: Client Id associated with the Connection Setting.
      settingId:
        type: string
        description: Setting Id set by the service for the Connection Setting.
        readOnly: true
      clientSecret:
        x-ms-secret: true
        type: string
        description: Client Secret associated with the Connection Setting
      scopes:
        type: string
        description: Scopes associated with the Connection Setting
        default: ''
      serviceProviderId:
        type: string
        description: Service Provider Id associated with the Connection Setting
      serviceProviderDisplayName:
        type: string
        description: Service Provider Display Name associated with the Connection Setting
      parameters:
        type: array
        description: Service Provider Parameters associated with the Connection Setting
        items:
          $ref: '#/definitions/ConnectionSettingParameter'
      provisioningState:
        type: string
        description: Provisioning state of the resource
    description: Properties for a Connection Setting Item
  ConnectionSettingResponseList:
    properties:
      nextLink:
        description: The link used to get the next page of bot service connection setting resources.
        type: string
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ConnectionSetting'
        description: Gets the list of bot service connection settings and their properties.
    description: The list of bot service connection settings response.
  Resource:
    description: Azure resource
    x-ms-azure-resource: true
    properties:
      id:
        description: Specifies the resource ID.
        type: string
        readOnly: true
      name:
        description: Specifies the name of the resource.
        type: string
        readOnly: true
      location:
        description: Specifies the location of the resource.
        type: string
      type:
        description: Specifies the type of the resource.
        type: string
        readOnly: true
      tags:
        description: Contains resource tags defined as key/value pairs.
        type: object
        additionalProperties:
          type: string
      sku:
        $ref: '#/definitions/Sku'
        description: Gets or sets the SKU of the resource.
      kind:
        $ref: '#/definitions/Kind'
        description: Required. Gets or sets the Kind of the resource.
        x-nullable: true
      etag:
        type: string
        description: Entity Tag.
      zones:
        type: array
        items:
          type: string
        description: Entity zones
        readOnly: true
  Sku:
    properties:
      name:
        $ref: '#/definitions/SkuName'
        description: The sku name
      tier:
        readOnly: true
        type: string
        description: Gets the sku tier. This is based on the SKU name.
        enum:
        - Free
        - Standard
        x-ms-enum:
          name: SkuTier
          modelAsString: true
    required:
    - name
    description: The SKU of the cognitive services account.
  Kind:
    type: string
    description: Indicates the type of bot service
    enum:
    - sdk
    - designer
    - bot
    - function
    - azurebot
    x-ms-enum:
      name: Kind
      modelAsString: true
    x-ms-mutability:
    - create
    - read
  ConnectionSettingParameter:
    properties:
      key:
        type: string
        description: Key for the Connection Setting Parameter.
      value:
        type: string
        description: Value associated with the Connection Setting Parameter.
        x-nullable: true
    description: Extra Parameter in a Connection Setting Properties to indicate service provider specific properties
  ConnectionSetting:
    type: object
    description: Bot channel resource definition
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ConnectionSettingProperties'
        description: The set of properties specific to bot channel resource
  ErrorBody:
    properties:
      code:
        type: string
        description: error code
      message:
        type: string
        description: error message
    description: Bot Service error body.
    required:
    - code
    - message
  SkuName:
    type: string
    description: The name of SKU.
    enum:
    - F0
    - S1
    x-ms-enum:
      name: SkuName
      modelAsString: true
  Error:
    properties:
      error:
        $ref: '#/definitions/ErrorBody'
        description: The error body.
    description: Bot Service error object.
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  connectionNameParameter:
    name: connectionName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    maxLength: 64
    minLength: 2
    pattern: ^[a-zA-Z0-9][\sa-zA-Z0-9_.-]*$
    description: The name of the Bot Service Connection Setting resource.
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request.
  resourceGroupNameParameter:
    name: resourceGroupName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    maxLength: 64
    minLength: 2
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
    description: The name of the Bot resource group in the user subscription.
  resourceNameParameter:
    name: resourceName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    maxLength: 64
    minLength: 2
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
    description: The name of the Bot resource.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'