@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api DataFactoryManagementClient
@base https://management.azure.com
@version 2018-06-01
@auth OAuth2
@common_fields {api-version: any # The API version., subscriptionId: any # The subscription identifier., resourceGroupName: any # The resource group name., factoryName: any # The factory name.}
@endpoints 102
@hint download_for_search
@toc providers(1), subscriptions(101)

@group providers
@endpoint GET /providers/Microsoft.DataFactory/operations
@desc Lists the available Azure Data Factory API operations.
@returns(200) OK.

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories
@desc Lists factories under the specified subscription.
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo
@desc Updates a factory's repo information.
@required {locationId: any # The location identifier., factoryRepoUpdate: any # Update factory repo request definition.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/getFeatureValue
@desc Get exposure control feature for specific location.
@required {locationId: any # The location identifier., exposureControlRequest: map # The exposure control request.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getFeatureValue
@desc Get exposure control feature for specific factory.
@required {exposureControlRequest: map # The exposure control request.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryFeaturesValue
@desc Get list of exposure control features for specific factory.
@required {exposureControlBatchRequest: map # The exposure control request for list of features.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories
@desc Lists factories.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
@desc Creates or updates a factory.
@required {factory: map # Factory resource definition.}
@optional {If-Match: any # ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
@desc Updates a factory.
@required {factoryUpdateParameters: any # The parameters for updating a factory.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
@desc Gets a factory.
@optional {If-None-Match: any # ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}
@desc Deletes a factory.
@returns(200) OK.
@returns(204) No Content.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken
@desc Get GitHub Access Token.
@required {gitHubAccessTokenRequest: any # Get GitHub access token request definition.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess
@desc Get Data Plane access.
@required {policy: any # Data Plane user access policy definition.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes
@desc Lists integration runtimes.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
@desc Creates or updates an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name., integrationRuntime: any # Integration runtime resource definition.}
@optional {If-Match: any # ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
@desc Gets an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@optional {If-None-Match: any # ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
@desc Updates an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name., updateIntegrationRuntimeRequest: map # The parameters for updating an integration runtime.}
@returns(200) OK.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}
@desc Deletes an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus
@desc Gets detailed status information for an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints
@desc Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo
@desc Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey
@desc Regenerates the authentication key for an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name., regenerateKeyParameters: any # The parameters for regenerating integration runtime authentication key.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys
@desc Retrieves the authentication keys for an integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start
@desc Starts a ManagedReserved type integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.
@returns(202) Accepted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop
@desc Stops a ManagedReserved type integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.
@returns(202) Accepted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials
@desc Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData
@desc Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade
@desc Upgrade self-hosted integration runtime to latest version if availability.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks
@desc Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
@required {integrationRuntimeName: any # The integration runtime name., linkedIntegrationRuntimeRequest: map # The data factory name for the linked integration runtime.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime
@desc Create a linked integration runtime entry in a shared integration runtime.
@required {integrationRuntimeName: any # The integration runtime name., createLinkedIntegrationRuntimeRequest: map # The linked integration runtime properties.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata
@desc Refresh a SSIS integration runtime object metadata.
@required {integrationRuntimeName: any # The integration runtime name.}
@returns(200) OK.
@returns(202) Accepted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata
@desc Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
@required {integrationRuntimeName: any # The integration runtime name.}
@optional {getMetadataRequest: map # The parameters for getting a SSIS object metadata.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
@desc Gets a self-hosted integration runtime node.
@required {integrationRuntimeName: any # The integration runtime name., nodeName: any # The integration runtime node name.}
@returns(200) OK.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
@desc Deletes a self-hosted integration runtime node.
@required {integrationRuntimeName: any # The integration runtime name., nodeName: any # The integration runtime node name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}
@desc Updates a self-hosted integration runtime node.
@required {integrationRuntimeName: any # The integration runtime name., nodeName: any # The integration runtime node name., updateIntegrationRuntimeNodeRequest: map # The parameters for updating an integration runtime node.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress
@desc Get the IP address of self-hosted integration runtime node.
@required {integrationRuntimeName: any # The integration runtime name., nodeName: any # The integration runtime node name.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices
@desc Lists linked services.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
@desc Creates or updates a linked service.
@required {linkedServiceName: any # The linked service name., linkedService: any # Linked service resource definition.}
@optional {If-Match: any # ETag of the linkedService entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
@desc Gets a linked service.
@required {linkedServiceName: any # The linked service name.}
@optional {If-None-Match: any # ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}
@desc Deletes a linked service.
@required {linkedServiceName: any # The linked service name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets
@desc Lists datasets.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
@desc Creates or updates a dataset.
@required {datasetName: any # The dataset name., dataset: any # Dataset resource definition.}
@optional {If-Match: any # ETag of the dataset entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
@desc Gets a dataset.
@required {datasetName: any # The dataset name.}
@optional {If-None-Match: any # ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}
@desc Deletes a dataset.
@required {datasetName: any # The dataset name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines
@desc Lists pipelines.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
@desc Creates or updates a pipeline.
@required {pipelineName: any # The pipeline name., pipeline: map # Pipeline resource definition.}
@optional {If-Match: any # ETag of the pipeline entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
@desc Gets a pipeline.
@required {pipelineName: any # The pipeline name.}
@optional {If-None-Match: any # ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}
@desc Deletes a pipeline.
@required {pipelineName: any # The pipeline name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun
@desc Creates a run of a pipeline.
@required {pipelineName: any # The pipeline name.}
@optional {referencePipelineRunId: any # The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run., isRecovery: any # Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId., startActivityName: any # In recovery mode, the rerun will start from this activity. If not specified, all activities will run., startFromFailure: any # In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified., parameters: map # Parameters of the pipeline run. These parameters will be used only if the runId is not specified.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns
@desc Query pipeline runs in the factory based on input filter conditions.
@required {filterParameters: map # Parameters to filter the pipeline run.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}
@desc Get a pipeline run by its run ID.
@required {runId: any # The pipeline run identifier.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns
@desc Query activity runs based on input filter conditions.
@required {runId: any # The pipeline run identifier., filterParameters: map # Parameters to filter the activity runs.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel
@desc Cancel a pipeline run by its run ID.
@required {runId: any # The pipeline run identifier.}
@optional {isRecursive: any # If true, cancel all the Child pipelines that are triggered by the current pipeline.}
@returns(200) Pipeline run has been canceled successfully.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers
@desc Lists triggers.
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/querytriggers
@desc Query triggers.
@required {filterParameters: map # Parameters to filter the triggers.}
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
@desc Creates or updates a trigger.
@required {triggerName: any # The trigger name., trigger: any # Trigger resource definition.}
@optional {If-Match: any # ETag of the trigger entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
@desc Gets a trigger.
@required {triggerName: any # The trigger name.}
@optional {If-None-Match: any # ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}
@desc Deletes a trigger.
@required {triggerName: any # The trigger name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/subscribeToEvents
@desc Subscribe event trigger to events.
@required {triggerName: any # The trigger name.}
@returns(200) Trigger is subscribed to events.
@returns(202) Accepted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/getEventSubscriptionStatus
@desc Get a trigger's event subscription status.
@required {triggerName: any # The trigger name.}
@returns(200) Trigger event subscription state.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/unsubscribeFromEvents
@desc Unsubscribe event trigger from events.
@required {triggerName: any # The trigger name.}
@returns(200) Trigger is unsubscribed from events.
@returns(202) Accepted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start
@desc Starts a trigger.
@required {triggerName: any # The trigger name.}
@returns(200) Trigger has been started successfully.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop
@desc Stops a trigger.
@required {triggerName: any # The trigger name.}
@returns(200) Trigger has been stopped successfully.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/rerun
@desc Rerun single trigger instance by runId.
@required {triggerName: any # The trigger name., runId: any # The pipeline run identifier.}
@returns(200) TriggerRun has been restarted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/cancel
@desc Cancel a single trigger instance by runId.
@required {triggerName: any # The trigger name., runId: any # The pipeline run identifier.}
@returns(200) TriggerRun has been cancelled.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns
@desc Query trigger runs.
@required {filterParameters: map # Parameters to filter the pipeline run.}
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
@desc Creates or updates a data flow.
@required {dataFlowName: any # The data flow name., dataFlow: any # Data flow resource definition.}
@optional {If-Match: any # ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
@desc Gets a data flow.
@required {dataFlowName: any # The data flow name.}
@optional {If-None-Match: any # ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
@desc Deletes a data flow.
@required {dataFlowName: any # The data flow name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows
@desc Lists data flows.
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession
@desc Creates a data flow debug session.
@required {request: map # Data flow debug session definition}
@returns(200) OK.
@returns(202) Accepted.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions
@desc Query all active data flow debug sessions.
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/addDataFlowToDebugSession
@desc Add a data flow into debug session.
@required {request: map # Data flow debug session definition with debug content.}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/deleteDataFlowDebugSession
@desc Deletes a data flow debug session.
@required {request: map # Data flow debug session definition for deletion}
@returns(200) OK.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand
@desc Execute a data flow debug command.
@required {request: map # Data flow debug command definition.}
@returns(200) OK.
@returns(202) Accepted.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks
@desc Lists managed Virtual Networks.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}
@desc Creates or updates a managed Virtual Network.
@required {managedVirtualNetworkName: any # Managed virtual network name, managedVirtualNetwork: any # Managed Virtual Network resource definition.}
@optional {If-Match: any # ETag of the managed Virtual Network entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}
@desc Gets a managed Virtual Network.
@required {managedVirtualNetworkName: any # Managed virtual network name}
@optional {If-None-Match: any # ETag of the managed Virtual Network entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints
@desc Lists managed private endpoints.
@required {managedVirtualNetworkName: any # Managed virtual network name}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials
@desc List credentials.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
@desc Creates or updates a credential.
@required {credentialName: any # Credential name, credential: map # Credential resource definition.}
@optional {If-Match: any # ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
@desc Gets a credential.
@required {credentialName: any # Credential name}
@optional {If-None-Match: any # ETag of the credential entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.
@errors {304: Not modified.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
@desc Deletes a credential.
@required {credentialName: any # Credential name}
@returns(200) OK.
@returns(204) No Content.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
@desc Creates or updates a managed private endpoint.
@required {managedVirtualNetworkName: any # Managed virtual network name, managedPrivateEndpointName: any # Managed private endpoint name, managedPrivateEndpoint: any # Managed private endpoint resource definition.}
@optional {If-Match: any # ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
@desc Gets a managed private endpoint.
@required {managedVirtualNetworkName: any # Managed virtual network name, managedPrivateEndpointName: any # Managed private endpoint name}
@optional {If-None-Match: any # ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
@desc Deletes a managed private endpoint.
@required {managedVirtualNetworkName: any # Managed virtual network name, managedPrivateEndpointName: any # Managed private endpoint name}
@returns(200) OK.
@returns(204) No Content.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndPointConnections
@desc Lists Private endpoint connections
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
@desc Approves or rejects a private endpoint connection
@required {privateEndpointConnectionName: any # The private endpoint connection name., privateEndpointWrapper: map}
@optional {If-Match: any # ETag of the private endpoint connection entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
@desc Gets a private endpoint connection
@required {privateEndpointConnectionName: any # The private endpoint connection name.}
@optional {If-None-Match: any # ETag of the private endpoint connection entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
@desc Deletes a private endpoint connection
@required {privateEndpointConnectionName: any # The private endpoint connection name.}
@returns(200) OK.
@returns(204) No content.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateLinkResources
@desc Gets the private link resources
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters
@desc Lists Global parameters
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
@desc Gets a Global parameter
@required {globalParameterName: any # The global parameter name.}
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
@desc Creates or updates a Global parameter
@required {globalParameterName: any # The global parameter name., default: map # Global parameter resource definition.}
@returns(200) OK.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
@desc Deletes a Global parameter
@required {globalParameterName: any # The global parameter name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs
@desc Lists all resources of type change data capture.
@returns(200) OK.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
@desc Creates or updates a change data capture resource.
@required {changeDataCaptureName: any # The change data capture name., changeDataCapture: map # Change data capture resource definition.}
@optional {If-Match: any # ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.}
@returns(200) OK.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
@desc Gets a change data capture.
@required {changeDataCaptureName: any # The change data capture name.}
@optional {If-None-Match: any # ETag of the change data capture entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.}
@returns(200) OK.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
@desc Deletes a change data capture.
@required {changeDataCaptureName: any # The change data capture name.}
@returns(200) OK.
@returns(204) No Content.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/start
@desc Starts a change data capture.
@required {changeDataCaptureName: any # The change data capture name.}
@returns(200) Change data capture has been started successfully.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/stop
@desc Stops a change data capture.
@required {changeDataCaptureName: any # The change data capture name.}
@returns(200) Change data capture has been stopped successfully.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/status
@desc Gets the current status for the change data capture resource.
@required {changeDataCaptureName: any # The change data capture name.}
@returns(200) OK.

@endgroup

@end