Microsoft Azure

Microsoft Azure Ingestion Using Data Collection Rules

Microsoft Azure Ingestion Using Data Collection Rules is a feature that allows organizations to easily and efficiently ingest large amounts of data into their Azure environment. By creating data collection rules, users can specify how data should be collected, transformed, and stored, making the ingestion process more streamlined and automated.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/data-collection-rule-overview

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/ingestion-using-data-collection-rules-openapi-original.yml

OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure Ingestion Using Data Collection Rules
  version: '2023-01-01'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
    - $ref: '#/parameters/Endpoint'
schemes:
  - https
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
security:
  - azure_auth:
      - user_impersonation
paths:
  /dataCollectionRules/{ruleId}/streams/{stream}:
    post:
      tags:
        - Data Collection Rules
      summary: Microsoft Azure Ingestion Api Used To Directly Ingest Data Using Data Collection Rules
      description: See error response code and error response message for more detail.
      operationId: microsoftAzureUpload
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: ruleId
          description: The immutable Id of the Data Collection Rule resource.
          required: true
          type: string
        - in: path
          name: stream
          description: The streamDeclaration name as defined in the Data Collection Rule.
          required: true
          type: string
        - in: query
          name: api-version
          required: true
          type: string
          description: The API version to use for this operation.
        - in: header
          name: Content-Encoding
          description: gzip
          type: string
        - in: header
          name: x-ms-client-request-id
          description: Client request Id
          type: string
        - in: body
          name: body
          description: >-
            An array of objects matching the schema defined by the provided
            stream.
          required: true
          schema:
            type: array
            items:
              type: object
      x-ms-examples:
        postIngestUsingDataCollectionRule:
          $ref: ./examples/post_IngestUsingDataCollectionRule.json
      responses:
        '204':
          description: Ingestion request accepted
        default:
          description: An error response object.
          schema:
            $ref: >-
              ../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse
          headers:
            x-ms-error-code:
              description: A value that indicates the ingestion service error code.
              type: string
definitions: {}
parameters:
  Endpoint:
    name: endpoint
    description: >-
      The Data Collection Endpoint for the Data Collection Rule, for example
      https://dce-name.eastus-2.ingest.monitor.azure.com.
    required: true
    type: string
    in: path
    x-ms-skip-url-encoding: true
    x-ms-parameter-location: client
tags:
  - name: Data Collection Rules