Microsoft Azure ReferenceDataSets API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Reference Data Sets API
tags:
- name: ReferenceDataSets
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}
  : put:
      tags:
      - ReferenceDataSets
      operationId: microsoftAzureReferencedatasetsCreateorupdate
      x-ms-examples:
        ReferenceDataSetsCreate:
          $ref: ./examples/ReferenceDataSetsCreate.json
      description: Create or update a reference data set in the specified environment.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - name: referenceDataSetName
        in: path
        required: true
        description: Name of the reference data set.
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[A-Za-z0-9]
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The existing reference data set definition was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceDataSetResource'
        '201':
          description: The reference data set was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceDataSetResource'
        default:
          description: 'HTTP 400 (Bad Request): The given reference data set request body is invalid; See the error code and message in the response for details.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferenceDataSetCreateOrUpdateParameters'
        description: Parameters for creating a reference data set.
        required: true
    get:
      tags:
      - ReferenceDataSets
      operationId: microsoftAzureReferencedatasetsGet
      x-ms-examples:
        ReferenceDataSetsGet:
          $ref: ./examples/ReferenceDataSetsGet.json
      description: Gets the reference data set with the specified name in the specified environment.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - $ref: '#/components/parameters/ReferenceDataSetNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The reference data set definition was successfully retrieved and is in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceDataSetResource'
        default:
          description: 'HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname
    patch:
      tags:
      - ReferenceDataSets
      operationId: microsoftAzureReferencedatasetsUpdate
      x-ms-examples:
        ReferenceDataSetsUpdate:
          $ref: ./examples/ReferenceDataSetsPatchTags.json
      description: Updates the reference data set with the specified name in the specified subscription, resource group, and environment.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - $ref: '#/components/parameters/ReferenceDataSetNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The reference data set definition was successfully updated and is in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceDataSetResource'
        default:
          description: 'HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferenceDataSetUpdateParameters'
        description: Request object that contains the updated information for the reference data set.
        required: true
    delete:
      tags:
      - ReferenceDataSets
      operationId: microsoftAzureReferencedatasetsDelete
      x-ms-examples:
        ReferenceDataSetsDelete:
          $ref: ./examples/ReferenceDataSetsDelete.json
      description: Deletes the reference data set with the specified name in the specified subscription, resource group, and environment
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - $ref: '#/components/parameters/ReferenceDataSetNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The reference data set was successfully deleted.
        '204':
          description: The reference data set was successfully deleted.
        default:
          description: 'HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets
  : get:
      tags:
      - ReferenceDataSets
      operationId: microsoftAzureReferencedatasetsListbyenvironment
      x-ms-examples:
        ReferenceDataSetsListByEnvironment:
          $ref: ./examples/ReferenceDataSetsListByEnvironment.json
      description: Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/EnvironmentNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Reference data sets returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceDataSetListResponse'
        default:
          description: 'HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets
components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Version of the API to be used with the client request.
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      x-ms-parameter-location: method
      description: Name of an Azure Resource group.
      schema:
        type: string
    ReferenceDataSetNameParameter:
      name: referenceDataSetName
      in: path
      required: true
      description: The name of the Time Series Insights reference data set associated with the specified environment.
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Azure Subscription ID.
      required: true
      schema:
        type: string
    EnvironmentNameParameter:
      name: environmentName
      in: path
      required: true
      description: The name of the Time Series Insights environment associated with the specified resource group.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    ReferenceDataSetUpdateParameters:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of additional properties for the reference data set.
      description: Parameters supplied to the Update Reference Data Set operation.
    CreateOrUpdateTrackedResourceProperties:
      properties:
        location:
          type: string
          description: The location of the resource.
          x-ms-mutability:
          - read
          - create
        tags:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of additional properties for the resource.
      required:
      - location
      description: Properties required to create any resource tracked by Azure Resource Manager.
    Resource:
      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
      description: Time Series Insights resource
      x-ms-azure-resource: true
    ReferenceDataSetKeyProperty:
      properties:
        name:
          type: string
          description: The name of the key property.
        type:
          type: string
          description: The type of the key property.
          enum:
          - String
          - Double
          - Bool
          - DateTime
          x-ms-enum:
            name: ReferenceDataKeyPropertyType
            modelAsString: true
      description: A key property for the reference data set. A reference data set can have multiple key properties.
    ReferenceDataSetResourceProperties:
      allOf:
      - $ref: '#/components/schemas/ReferenceDataSetCreationProperties'
      - $ref: '#/components/schemas/ResourceProperties'
      required:
      - keyProperties
      description: Properties of the reference data set.
    ProvisioningState:
      readOnly: true
      type: string
      description: Provisioning state of the resource.
      enum:
      - Accepted
      - Creating
      - Updating
      - Succeeded
      - Failed
      - Deleting
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
    CloudErrorBody:
      type: object
      description: Describes a particular API error with an error code and a message.
      properties:
        code:
          type: string
          description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.
        message:
          type: string
          description: A message that describes the error in detail and provides debugging information.
        target:
          type: string
          description: The target of the particular error (for example, the name of the property in error).
        details:
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
            description: Describes a particular API error with an error code and a message.
          x-ms-identifiers: []
          description: Contains nested errors that are related to this error.
      x-ms-external: true
    CloudError:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Describes a particular API error with an error code and a message.
      description: Contains information about an API error.
      x-ms-external: true
    TrackedResource:
      properties:
        location:
          type: string
          description: Resource location
          x-ms-mutability:
          - read
          - create
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags
      allOf:
      - $ref: '#/components/schemas/Resource'
      required:
      - location
      description: Time Series Insights resource that is tracked by Azure Resource Manager.
    ReferenceDataSetCreateOrUpdateParameters:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ReferenceDataSetCreationProperties'
      required:
      - properties
      allOf:
      - $ref: '#/components/schemas/CreateOrUpdateTrackedResourceProperties'
    ReferenceDataSetResource:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ReferenceDataSetResourceProperties'
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
      description: A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs.
    ResourceProperties:
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: Provisioning state of the resource.
        creationTime:
          readOnly: true
          type: string
          format: date-time
          description: The time the resource was created.
      description: Properties that are common to all tracked resources.
    ReferenceDataSetListResponse:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ReferenceDataSetResource'
          description: Result of the List Reference Data Sets operation.
      description: The response of the List Reference Data Sets operation.
    ReferenceDataSetCreationProperties:
      properties:
        keyProperties:
          type: array
          items:
            $ref: '#/components/schemas/ReferenceDataSetKeyProperty'
          x-ms-identifiers:
          - name
          description: The list of key properties for the reference data set.
        dataStringComparisonBehavior:
          type: string
          description: The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
          enum:
          - Ordinal
          - OrdinalIgnoreCase
          x-ms-enum:
            name: DataStringComparisonBehavior
            modelAsString: true
      required:
      - keyProperties
      description: Properties used to create a reference data set.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'