swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Connectors API
schemes:
- https
tags:
- name: Connectors
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}
  : put:
      tags:
      - Connectors
      operationId: microsoftAzureConnectorsCreateorupdate
      x-ms-examples:
        Connectors_CreateOrUpdate:
          $ref: ./examples/ConnectorsCreateOrUpdate.json
      description: Creates a connector or updates an existing connector in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: connectorName
        in: path
        required: true
        type: string
        description: The name of the connector.
        pattern: ^[a-zA-Z][a-zA-Z0-9_]+$
        minLength: 1
        maxLength: 128
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ConnectorResourceFormat'
        description: Parameters supplied to the CreateOrUpdate Connector operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully created the connector.
          schema:
            $ref: '#/definitions/ConnectorResourceFormat'
        '202':
          description: Accepted. The create connector operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Connectors Connectorname
    get:
      tags:
      - Connectors
      operationId: microsoftAzureConnectorsGet
      x-ms-examples:
        Connectors_Get:
          $ref: ./examples/ConnectorsGet.json
      description: Gets a connector in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: connectorName
        in: path
        required: true
        type: string
        description: The name of the connector.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the connector.
          schema:
            $ref: '#/definitions/ConnectorResourceFormat'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Connectors Connectorname
    delete:
      tags:
      - Connectors
      operationId: microsoftAzureConnectorsDelete
      x-ms-examples:
        Connectors_Delete:
          $ref: ./examples/ConnectorsDelete.json
      description: Deletes a connector in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: connectorName
        in: path
        required: true
        type: string
        description: The name of the connector.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. The connector is deleted.
        '202':
          description: Accepted. The delete operation is accepted.
        '204':
          description: NoContent. Successfully requested delete operation, but the response is intentionally empty.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Connectors Connectorname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors
  : get:
      tags:
      - Connectors
      operationId: microsoftAzureConnectorsListbyhub
      x-ms-examples:
        Connectors_ListByHub:
          $ref: ./examples/ConnectorsListByHub.json
      description: Gets all the connectors in the specified hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get all the connectors in the hub.
          schema:
            $ref: '#/definitions/ConnectorListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Connectors
definitions:
  Connector:
    required:
    - connectorType
    - connectorProperties
    properties:
      connectorId:
        type: integer
        readOnly: true
        description: ID of the connector.
      connectorName:
        type: string
        description: Name of the connector.
      connectorType:
        $ref: '#/definitions/ConnectorType'
        description: Type of connector.
      displayName:
        type: string
        description: Display name of the connector.
      description:
        type: string
        description: Description of the connector.
      connectorProperties:
        type: object
        additionalProperties:
          type: object
        description: The connector properties.
      created:
        type: string
        readOnly: true
        format: date-time
        description: The created time.
      lastModified:
        type: string
        readOnly: true
        format: date-time
        description: The last modified time.
      state:
        type: string
        readOnly: true
        enum:
        - Creating
        - Created
        - Ready
        - Expiring
        - Deleting
        - Failed
        x-ms-enum:
          name: ConnectorStates
          modelAsString: false
        description: State of connector.
      tenantId:
        type: string
        readOnly: true
        description: The hub name.
      isInternal:
        type: boolean
        description: If this is an internal connector.
    description: Properties of connector.
  ProxyResource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
    x-ms-azure-resource: true
    description: Common properties of proxy resource.
  ConnectorType:
    type: string
    enum:
    - None
    - CRM
    - AzureBlob
    - Salesforce
    - ExchangeOnline
    - Outbound
    x-ms-enum:
      name: ConnectorTypes
      modelAsString: true
    description: Type of connector.
  ConnectorResourceFormat:
    description: The connector resource format.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/Connector'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  ConnectorListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ConnectorResourceFormat'
        description: Results of the list operation.
      nextLink:
        type: string
        description: Link to the next set of results.
    description: The response of list connector operation.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'