Microsoft Azure Links API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Links API
schemes:
- https
tags:
- name: Links
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/links/{linkName}
  : put:
      tags:
      - Links
      operationId: microsoftAzureLinksCreateorupdate
      x-ms-examples:
        Links_CreateOrUpdate:
          $ref: ./examples/LinksCreateOrUpdate.json
      description: Creates a link or updates an existing link 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: linkName
        in: path
        required: true
        type: string
        description: The name of the link.
        pattern: ^[a-zA-Z][a-zA-Z0-9_]+$
        minLength: 1
        maxLength: 512
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/LinkResourceFormat'
        description: Parameters supplied to the CreateOrUpdate Link operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully created the link.
          schema:
            $ref: '#/definitions/LinkResourceFormat'
        '202':
          description: Accepted. The create link operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Links Linkname
    get:
      tags:
      - Links
      operationId: microsoftAzureLinksGet
      x-ms-examples:
        Links_Get:
          $ref: ./examples/LinksGet.json
      description: Gets a link 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: linkName
        in: path
        required: true
        type: string
        description: The name of the link.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the link.
          schema:
            $ref: '#/definitions/LinkResourceFormat'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Links Linkname
    delete:
      tags:
      - Links
      operationId: microsoftAzureLinksDelete
      x-ms-examples:
        Links_Delete:
          $ref: ./examples/LinksDelete.json
      description: Deletes a link 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: linkName
        in: path
        required: true
        type: string
        description: The name of the link.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. The link is deleted.
        '202':
          description: Accepted. The delete operation is accepted.
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Links Linkname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/links
  : get:
      tags:
      - Links
      operationId: microsoftAzureLinksListbyhub
      x-ms-examples:
        Links_ListByHub:
          $ref: ./examples/LinksListByHub.json
      description: Gets all the links 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 links in the hub.
          schema:
            $ref: '#/definitions/LinkListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Links
definitions:
  LinkListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/LinkResourceFormat'
        description: Results of the list operation.
      nextLink:
        type: string
        description: Link to the next set of results.
    description: The response of list link operation.
  LinkDefinition:
    required:
    - sourceEntityType
    - targetEntityType
    - sourceEntityTypeName
    - targetEntityTypeName
    - participantPropertyReferences
    properties:
      tenantId:
        type: string
        readOnly: true
        description: The hub name.
      linkName:
        type: string
        readOnly: true
        description: The link name.
      sourceEntityType:
        type: string
        enum:
        - None
        - Profile
        - Interaction
        - Relationship
        x-ms-enum:
          name: EntityType
          modelAsString: false
        description: Type of source entity.
      targetEntityType:
        type: string
        enum:
        - None
        - Profile
        - Interaction
        - Relationship
        x-ms-enum:
          name: EntityType
          modelAsString: false
        description: Type of target entity.
      sourceEntityTypeName:
        type: string
        description: Name of the source Entity Type.
      targetEntityTypeName:
        type: string
        description: Name of the target Entity Type.
      displayName:
        type: object
        additionalProperties:
          type: string
        description: Localized display name for the Link.
      description:
        type: object
        additionalProperties:
          type: string
        description: Localized descriptions for the Link.
      mappings:
        type: array
        items:
          $ref: '#/definitions/TypePropertiesMapping'
        description: The set of properties mappings between the source and target Types.
      participantPropertyReferences:
        type: array
        items:
          $ref: '#/definitions/ParticipantPropertyReference'
        description: The properties that represent the participating profile.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
        description: Provisioning state.
      referenceOnly:
        type: boolean
        description: Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
      operationType:
        type: string
        enum:
        - Upsert
        - Delete
        x-ms-enum:
          name: InstanceOperationType
          modelAsString: false
        description: Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    description: The definition of Link.
  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.
  ProvisioningState:
    type: string
    enum:
    - Provisioning
    - Succeeded
    - Expiring
    - Deleting
    - HumanIntervention
    - Failed
    x-ms-enum:
      name: ProvisioningStates
      modelAsString: true
    description: Provisioning state.
  ParticipantPropertyReference:
    required:
    - sourcePropertyName
    - targetPropertyName
    properties:
      sourcePropertyName:
        type: string
        description: The source property that maps to the target property.
      targetPropertyName:
        type: string
        description: The target property that maps to the source property.
    description: The participant property reference.
  LinkResourceFormat:
    description: The link resource format.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/LinkDefinition'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  TypePropertiesMapping:
    required:
    - sourcePropertyName
    - targetPropertyName
    properties:
      sourcePropertyName:
        type: string
        description: ' Property name on the source Entity Type.'
      targetPropertyName:
        type: string
        description: Property name on the target Entity Type.
      linkType:
        type: string
        enum:
        - UpdateAlways
        - CopyIfNull
        x-ms-enum:
          name: LinkTypes
          modelAsString: false
        description: Link type.
    description: Metadata for a Link's property mapping.
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'