Patch an export.

Changed on

Perform an incremental update to an export.

patch/dataExport/exports/{exportId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    OAuth 2
    Implicithttps://login.microsoftonline.com/common/oauth2/authorize
    Scopesuser_impersonation

Path parameters

exportIdstring required

Unique ID for the export.

Query parameters

api-versionstring required

The version of the API being called.

Headers

If-Matchstring

Only perform the operation if the entity's etag matches one of the etags provided or * is provided.

Request body

object required

Response

Success

statusstring

Indication of the current health and operation of the export or destination.

lastExportTimestring date-time

The timestamp of the last message that was sent to the export or destination.

idstring

Unique ID of the export.

displayNamestring required

Display name of the export.

enabledboolean required

Toggle to start/stop an export from sending data.

source'telemetry' | 'properties' | 'deviceLifecycle' | 'deviceTemplateLifecycle' | 'deviceConnectivity' | 'audit' required

The type of data to export.

filterstring

Query defining which events from the source should be exported.

enrichmentsobject

Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send.

Changes