Microsoft Azure Health Data Services IotConnectors API

swagger: '2.0'
info:
  title: Azure Health Data Services de-identification service Collection IotConnectors API
  version: '2024-11-15'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- AadToken:
  - https://deid.azure.com/.default
tags:
- name: IotConnectors
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors
  : get:
      tags:
      - IotConnectors
      description: Lists all IoT Connectors for the given workspace
      operationId: IotConnectors_ListByWorkspace
      x-ms-examples:
        List iotconnectors:
          $ref: ./examples/iotconnectors/iotconnector_List.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/workspaceName'
      responses:
        '200':
          description: List of IoT Connectors.
          schema:
            $ref: '#/definitions/IotConnectorCollection'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  : get:
      tags:
      - IotConnectors
      description: Gets the properties of the specified IoT Connector.
      operationId: IotConnectors_Get
      x-ms-examples:
        Get an IoT Connector:
          $ref: ./examples/iotconnectors/iotconnector_Get.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/workspaceName'
      - $ref: '#/parameters/iotConnectorName'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/IotConnector'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorDetails'
    put:
      tags:
      - IotConnectors
      description: Creates or updates an IoT Connector resource with the specified parameters.
      operationId: IotConnectors_CreateOrUpdate
      x-ms-long-running-operation: true
      x-ms-examples:
        Create an IoT Connector:
          $ref: ./examples/iotconnectors/iotconnector_Create.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/workspaceName'
      - $ref: '#/parameters/iotConnectorName'
      - name: iotConnector
        description: The parameters for creating or updating an IoT Connectors resource.
        in: body
        required: true
        schema:
          $ref: '#/definitions/IotConnector'
      responses:
        '200':
          description: Updated - Put request accepted and an existing resource is updated.
          schema:
            $ref: '#/definitions/IotConnector'
        '201':
          description: Created - Put request accepted and an existing resource is being created asynchronously.
          schema:
            $ref: '#/definitions/IotConnector'
        '202':
          description: Accepted - Put request accepted and an existing resource is being updated asynchronously.
          schema:
            $ref: '#/definitions/IotConnector'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorDetails'
    patch:
      tags:
      - IotConnectors
      description: Patch an IoT Connector.
      operationId: IotConnectors_Update
      x-ms-long-running-operation: true
      x-ms-examples:
        Patch an IoT Connector:
          $ref: ./examples/iotconnectors/iotconnector_Patch.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/iotConnectorName'
      - $ref: '#/parameters/workspaceName'
      - name: iotConnectorPatchResource
        description: The parameters for updating an IoT Connector.
        in: body
        required: true
        schema:
          $ref: '#/definitions/IotConnectorPatchResource'
      responses:
        '200':
          description: Updated - Patch request accepted and an existing resource is updated.
          schema:
            $ref: '#/definitions/IotConnector'
        '202':
          description: Accepted - Patch request accepted and an existing resource is being updated asynchronously.
          schema:
            $ref: '#/definitions/IotConnector'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorDetails'
    delete:
      tags:
      - IotConnectors
      description: Deletes an IoT Connector.
      operationId: IotConnectors_Delete
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete an IoT Connector:
          $ref: ./examples/iotconnectors/iotconnector_Delete.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/iotConnectorName'
      - $ref: '#/parameters/workspaceName'
      responses:
        '200':
          description: Resource deleted.
        '202':
          description: Delete request accepted; the operation will complete asynchronously.
        '204':
          description: The resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/Error'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations
  : get:
      tags:
      - IotConnectors
      description: Lists all FHIR destinations for the given IoT Connector
      operationId: FhirDestinations_ListByIotConnector
      x-ms-examples:
        List IoT Connectors:
          $ref: ./examples/iotconnectors/iotconnector_fhirdestination_List.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/workspaceName'
      - $ref: '#/parameters/iotConnectorName'
      responses:
        '200':
          description: List of IoT Connector FHIR destinations.
          schema:
            $ref: '#/definitions/IotFhirDestinationCollection'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorDetails'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}
  : get:
      tags:
      - IotConnectors
      description: Gets the properties of the specified Iot Connector FHIR destination.
      operationId: IotConnectorFhirDestination_Get
      x-ms-examples:
        Get an IoT Connector destination:
          $ref: ./examples/iotconnectors/iotconnector_fhirdestination_Get.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/workspaceName'
      - $ref: '#/parameters/iotConnectorName'
      - $ref: '#/parameters/fhirDestinationName'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/IotFhirDestination'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorDetails'
    put:
      tags:
      - IotConnectors
      description: Creates or updates an IoT Connector FHIR destination resource with the specified parameters.
      operationId: IotConnectorFhirDestination_CreateOrUpdate
      x-ms-long-running-operation: true
      x-ms-examples:
        Create or update an Iot Connector FHIR destination:
          $ref: ./examples/iotconnectors/iotconnector_fhirdestination_Create.json
      parameters:
      - $ref: '#/parameters/resourceGroupName'
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/workspaceName'
      - $ref: '#/parameters/iotConnectorName'
      - $ref: '#/parameters/fhirDestinationName'
      - name: iotFhirDestination
        description: The parameters for creating or updating an IoT Connector FHIR destination resource.
        in: body
        required: true
        schema:
          $ref: '#/definitions/IotFhirDestination'
      responses:
        '200':
          description: Updated - Put request accepted and an existing resource is updated.
          schema:
            $ref: '#/definitions/IotFhirDestination'
        '201':
          description: Created - Put request accepted and an existing resource is being created asynchronously.
          schema:
            $ref: '#/definitions/IotFhirDestination'
        '202':
          description: Accepted - Put request accepted and an existing resource is being updated asynchronously.
          schema:
            $ref: '#/definitions/IotFhirDestination'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorDetails'
    delete:
      tags:
      - IotConnectors
      description: Deletes an IoT Connector FHIR destination.
      operationId: IotConnectorFhirDestination_Delete
      x-ms-long-running-operation: true
      x-ms-examples:
        Delete an IoT Connector destination:
          $ref: ./examples/iotconnectors/iotconnector_fhirdestination_Delete.json
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/workspaceName'
      - $ref: '#/parameters/iotConnectorName'
      - $ref: '#/parameters/fhirDestinationName'
      responses:
        '200':
          description: Resource deleted.
        '202':
          description: Delete request accepted; the operation will complete asynchronously.
        '204':
          description: The resource does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/Error'
definitions:
  IotConnectorCollection:
    description: A collection of IoT Connectors.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of IoT Connectors.
        type: string
      value:
        description: The list of IoT Connectors.
        type: array
        items:
          $ref: '#/definitions/IotConnector'
  ErrorDetails:
    description: Error details.
    type: object
    properties:
      error:
        description: Error details
        $ref: '#/definitions/ErrorDetailsInternal'
  IotFhirDestinationProperties:
    required:
    - resourceIdentityResolutionType
    - fhirServiceResourceId
    - fhirMapping
    type: object
    allOf:
    - $ref: '#/definitions/IotDestinationProperties'
    description: IoT Connector destination properties for an Azure FHIR service.
    properties:
      resourceIdentityResolutionType:
        description: Determines how resource identity is resolved on the destination.
        $ref: '#/definitions/IotIdentityResolutionType'
      fhirServiceResourceId:
        type: string
        description: Fully qualified resource id of the FHIR service to connect to.
      fhirMapping:
        description: FHIR Mappings
        $ref: '#/definitions/IotMappingProperties'
  IotDestinationProperties:
    type: object
    description: Common IoT Connector destination properties.
    properties:
      provisioningState:
        description: The provisioning state.
        $ref: '#/definitions/ProvisioningState'
        x-ms-client-flatten: true
  IotFhirDestination:
    required:
    - properties
    type: object
    description: IoT Connector FHIR destination definition.
    allOf:
    - $ref: '#/definitions/LocationBasedResource'
    properties:
      properties:
        description: IoT FHIR Destination settings.
        $ref: '#/definitions/IotFhirDestinationProperties'
        x-ms-client-flatten: true
      systemData:
        description: Metadata pertaining to creation and last modification of the resource.
        $ref: '#/definitions/systemData'
  ServiceManagedIdentity:
    type: object
    description: Managed service identity (system assigned and/or user assigned identities)
    properties:
      identity:
        type: object
        description: Setting indicating whether the service has a managed identity associated with it.
        properties:
          type:
            description: Type of identity being specified, currently SystemAssigned and None are allowed.
            type: string
            enum:
            - None
            - SystemAssigned
            - UserAssigned
            - SystemAssigned,UserAssigned
            x-ms-enum:
              name: ServiceManagedIdentityType
              modelAsString: true
          principalId:
            readOnly: true
            format: uuid
            type: string
            description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
          tenantId:
            readOnly: true
            format: uuid
            type: string
            description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
          userAssignedIdentities:
            $ref: '#/definitions/UserAssignedIdentities'
        required:
        - type
  IotMappingProperties:
    description: The mapping content.
    type: object
    properties:
      content:
        description: The mapping.
        type: object
  ErrorDetailsInternal:
    description: Error details.
    type: object
    properties:
      code:
        description: The error code.
        type: string
        readOnly: true
      message:
        description: The error message.
        type: string
        readOnly: true
      target:
        description: The target of the particular error.
        type: string
        readOnly: true
  LocationBasedResource:
    type: object
    description: The common properties for any location based resource, tracked or proxy.
    allOf:
    - $ref: '#/definitions/ResourceCore'
    properties:
      location:
        type: string
        description: The resource location.
        x-ms-mutability:
        - create
        - read
    x-ms-azure-resource: true
  UserAssignedIdentity:
    type: object
    description: User assigned identity properties
    properties:
      principalId:
        description: The principal ID of the assigned identity.
        format: uuid
        type: string
        readOnly: true
      clientId:
        description: The client ID of the assigned identity.
        format: uuid
        type: string
        readOnly: true
  IotConnectorProperties:
    description: IoT Connector properties.
    type: object
    properties:
      provisioningState:
        description: The provisioning state.
        $ref: '#/definitions/ProvisioningState'
      ingestionEndpointConfiguration:
        description: Source configuration.
        $ref: '#/definitions/IotEventHubIngestionEndpointConfiguration'
      deviceMapping:
        description: Device Mappings.
        $ref: '#/definitions/IotMappingProperties'
  ResourceTags:
    type: object
    description: List of key value pairs that describe the resource. This will overwrite the existing tags.
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
  Error:
    description: Error details.
    type: object
    properties:
      error:
        description: Error details
        $ref: '#/definitions/ErrorDetailsInternal'
  IotEventHubIngestionEndpointConfiguration:
    type: object
    properties:
      eventHubName:
        type: string
        description: Event Hub name to connect to.
      consumerGroup:
        type: string
        description: Consumer group of the event hub to connected to.
      fullyQualifiedEventHubNamespace:
        type: string
        description: Fully qualified namespace of the Event Hub to connect to.
    description: Event Hub ingestion endpoint configuration
  IotConnectorPatchResource:
    type: object
    description: Iot Connector patch properties
    allOf:
    - $ref: '#/definitions/ResourceTags'
    - $ref: '#/definitions/ServiceManagedIdentity'
  TaggedResource:
    type: object
    description: The common properties of tracked resources in the service.
    allOf:
    - $ref: '#/definitions/ResourceTags'
    - $ref: '#/definitions/LocationBasedResource'
    x-ms-azure-resource: true
  IotIdentityResolutionType:
    description: The type of IoT identity resolution to use with the destination.
    enum:
    - Create
    - Lookup
    type: string
    x-ms-enum:
      name: IotIdentityResolutionType
      modelAsString: true
  ProvisioningState:
    description: The provisioning state.
    enum:
    - Deleting
    - Succeeded
    - Creating
    - Accepted
    - Verifying
    - Updating
    - Failed
    - Canceled
    - Deprovisioned
    - Moving
    - Suspended
    - Warned
    - SystemMaintenance
    type: string
    readOnly: true
    x-ms-enum:
      name: provisioningState
      modelAsString: true
  IotFhirDestinationCollection:
    description: A collection of IoT Connector FHIR destinations.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of IoT FHIR destinations.
        type: string
      value:
        description: The list of IoT Connector FHIR destinations.
        type: array
        items:
          $ref: '#/definitions/IotFhirDestination'
  UserAssignedIdentities:
    title: User-Assigned Identities
    description: 'The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.'
    type: object
    additionalProperties:
      $ref: '#/definitions/UserAssignedIdentity'
  IotConnector:
    type: object
    description: IoT Connector definition.
    allOf:
    - $ref: '#/definitions/TaggedResource'
    - $ref: '#/definitions/ServiceManagedIdentity'
    properties:
      properties:
        description: IoT Connector configuration.
        $ref: '#/definitions/IotConnectorProperties'
        x-ms-client-flatten: true
      systemData:
        description: Metadata pertaining to creation and last modification of the resource.
        $ref: '#/definitions/systemData'
  ResourceCore:
    type: object
    description: The common properties for any resource, tracked or proxy.
    properties:
      id:
        readOnly: true
        type: string
        description: The resource identifier.
      name:
        readOnly: true
        type: string
        description: The resource name.
        pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$
      type:
        readOnly: true
        type: string
        description: The resource type.
      etag:
        description: An etag associated with the resource, used for optimistic concurrency when editing it.
        type: string
    x-ms-azure-resource: true
  systemData:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    readOnly: true
    properties:
      createdBy:
        type: string
        description: The identity that created the resource.
      createdByType:
        type: string
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      createdAt:
        type: string
        format: date-time
        description: The timestamp of resource creation (UTC).
      lastModifiedBy:
        type: string
        description: The identity that last modified the resource.
      lastModifiedByType:
        type: string
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      lastModifiedAt:
        type: string
        format: date-time
        description: The timestamp of resource last modification (UTC)
parameters:
  fhirDestinationName:
    name: fhirDestinationName
    in: path
    required: true
    type: string
    description: The name of IoT Connector FHIR destination resource.
    x-ms-parameter-location: method
    minLength: 3
    maxLength: 24
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group that contains the service instance.
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
  iotConnectorName:
    name: iotConnectorName
    in: path
    required: true
    type: string
    description: The name of IoT Connector resource.
    x-ms-parameter-location: method
    minLength: 3
    maxLength: 24
  workspaceName:
    name: workspaceName
    in: path
    required: true
    type: string
    description: The name of workspace resource.
    x-ms-parameter-location: method
    minLength: 3
    maxLength: 24
securityDefinitions:
  AadToken:
    type: oauth2
    description: The Azure Active Directory OAuth2 Flow
    flow: accessCode
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
    scopes:
      https://deid.azure.com/.default: ''
    tokenUrl: https://login.microsoftonline.com/common/oauth2/token
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: Url of your De-identification Service.
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true