@datafire/azure_datafactory v5.0.0
@datafire/azure_datafactory
Client library for DataFactoryManagementClient
Installation and Usage
npm install --save @datafire/azure_datafactory
let azure_datafactory = require('@datafire/azure_datafactory').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Actions
Operations_List
Lists the available Azure Data Factory API operations.
azure_datafactory.Operations_List({
"api-version": ""
}, context)
Input
- input
object
- api-version required
string
: The API version.
- api-version required
Output
- output OperationListResponse
Factories_List
Lists factories under the specified subscription.
azure_datafactory.Factories_List({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - api-version required
string
: The API version.
- subscriptionId required
Output
- output FactoryListResponse
Factories_ConfigureFactoryRepo
Updates a factory's repo information.
azure_datafactory.Factories_ConfigureFactoryRepo({
"subscriptionId": "",
"locationId": "",
"api-version": "",
"factoryRepoUpdate": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - locationId required
string
: The location identifier. - api-version required
string
: The API version. - factoryRepoUpdate required FactoryRepoUpdate
- subscriptionId required
Output
- output Factory
ExposureControl_GetFeatureValue
Get exposure control feature for specific location.
azure_datafactory.ExposureControl_GetFeatureValue({
"subscriptionId": "",
"locationId": "",
"api-version": "",
"exposureControlRequest": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - locationId required
string
: The location identifier. - api-version required
string
: The API version. - exposureControlRequest required ExposureControlRequest
- subscriptionId required
Output
- output ExposureControlResponse
Factories_ListByResourceGroup
Lists factories.
azure_datafactory.Factories_ListByResourceGroup({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output FactoryListResponse
Factories_Delete
Deletes a factory.
azure_datafactory.Factories_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Factories_Get
Gets a factory.
azure_datafactory.Factories_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output Factory
Factories_Update
Updates a factory.
azure_datafactory.Factories_Update({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"factoryUpdateParameters": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - factoryUpdateParameters required FactoryUpdateParameters
- subscriptionId required
Output
- output Factory
Factories_CreateOrUpdate
Creates or updates a factory.
azure_datafactory.Factories_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"factory": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - factory required Factory
- If-Match
string
: ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
- subscriptionId required
Output
- output Factory
DataFlowDebugSession_AddDataFlow
Add a data flow into debug session.
azure_datafactory.DataFlowDebugSession_AddDataFlow({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"request": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - request required DataFlowDebugPackage
- subscriptionId required
Output
DataFlowDebugSession_Create
Creates a data flow debug session.
azure_datafactory.DataFlowDebugSession_Create({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"request": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - request required CreateDataFlowDebugSessionRequest
- subscriptionId required
Output
DataFlows_ListByFactory
Lists data flows.
azure_datafactory.DataFlows_ListByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output DataFlowListResponse
DataFlows_Delete
Deletes a data flow.
azure_datafactory.DataFlows_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"dataFlowName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - dataFlowName required
string
: The data flow name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
DataFlows_Get
Gets a data flow.
azure_datafactory.DataFlows_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"dataFlowName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - dataFlowName required
string
: The data flow name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output DataFlowResource
DataFlows_CreateOrUpdate
Creates or updates a data flow.
azure_datafactory.DataFlows_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"dataFlowName": "",
"api-version": "",
"dataFlow": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - dataFlowName required
string
: The data flow name. - api-version required
string
: The API version. - If-Match
string
: 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. - dataFlow required DataFlowResource
- subscriptionId required
Output
- output DataFlowResource
Datasets_ListByFactory
Lists datasets.
azure_datafactory.Datasets_ListByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output DatasetListResponse
Datasets_Delete
Deletes a dataset.
azure_datafactory.Datasets_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"datasetName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - datasetName required
string
: The dataset name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Datasets_Get
Gets a dataset.
azure_datafactory.Datasets_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"datasetName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - datasetName required
string
: The dataset name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output DatasetResource
Datasets_CreateOrUpdate
Creates or updates a dataset.
azure_datafactory.Datasets_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"datasetName": "",
"api-version": "",
"dataset": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - datasetName required
string
: The dataset name. - api-version required
string
: The API version. - If-Match
string
: ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. - dataset required DatasetResource
- subscriptionId required
Output
- output DatasetResource
DataFlowDebugSession_Delete
Deletes a data flow debug session.
azure_datafactory.DataFlowDebugSession_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"request": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - request required DeleteDataFlowDebugSessionRequest
- subscriptionId required
Output
Output schema unknown
DataFlowDebugSession_ExecuteCommand
Execute a data flow debug command.
azure_datafactory.DataFlowDebugSession_ExecuteCommand({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"request": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - request required DataFlowDebugCommandRequest
- subscriptionId required
Output
- output DataFlowDebugCommandResponse
Factories_GetDataPlaneAccess
Get Data Plane access.
azure_datafactory.Factories_GetDataPlaneAccess({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"policy": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - policy required UserAccessPolicy
- subscriptionId required
Output
- output AccessPolicyResponse
ExposureControl_GetFeatureValueByFactory
Get exposure control feature for specific factory.
azure_datafactory.ExposureControl_GetFeatureValueByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"exposureControlRequest": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - exposureControlRequest required ExposureControlRequest
- subscriptionId required
Output
- output ExposureControlResponse
Factories_GetGitHubAccessToken
Get GitHub Access Token.
azure_datafactory.Factories_GetGitHubAccessToken({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"gitHubAccessTokenRequest": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - gitHubAccessTokenRequest required GitHubAccessTokenRequest
- subscriptionId required
Output
- output GitHubAccessTokenResponse
IntegrationRuntimes_ListByFactory
Lists integration runtimes.
azure_datafactory.IntegrationRuntimes_ListByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
IntegrationRuntimes_Delete
Deletes an integration runtime.
azure_datafactory.IntegrationRuntimes_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
IntegrationRuntimes_Get
Gets an integration runtime.
azure_datafactory.IntegrationRuntimes_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output IntegrationRuntimeResource
IntegrationRuntimes_Update
Updates an integration runtime.
azure_datafactory.IntegrationRuntimes_Update({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": "",
"updateIntegrationRuntimeRequest": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version. - updateIntegrationRuntimeRequest required UpdateIntegrationRuntimeRequest
- subscriptionId required
Output
- output IntegrationRuntimeResource
IntegrationRuntimes_CreateOrUpdate
Creates or updates an integration runtime.
azure_datafactory.IntegrationRuntimes_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": "",
"integrationRuntime": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version. - If-Match
string
: 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. - integrationRuntime required IntegrationRuntimeResource
- subscriptionId required
Output
- output IntegrationRuntimeResource
IntegrationRuntimes_GetConnectionInfo
Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.
azure_datafactory.IntegrationRuntimes_GetConnectionInfo({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output
object
: Connection information for encrypting the on-premises data source credentials.- hostServiceUri
string
: The on-premises integration runtime host URL. - identityCertThumbprint
string
: The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation. - isIdentityCertExprired
boolean
: Whether the identity certificate is expired. - publicKey
string
: The public key for encrypting a credential when transferring the credential to the integration runtime. - serviceToken
string
: The token generated in service. Callers use this token to authenticate to integration runtime. - version
string
: The integration runtime version.
- hostServiceUri
IntegrationRuntimeObjectMetadata_Get
Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
azure_datafactory.IntegrationRuntimeObjectMetadata_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - getMetadataRequest GetSsisObjectMetadataRequest
- api-version required
string
: The API version.
- subscriptionId required
Output
- output
object
: A list of SSIS object metadata.- nextLink
string
: The link to the next page of results, if any remaining results exist. - value
array
: List of SSIS object metadata.- items
object
: SSIS object metadata.- description
string
: Metadata description. - id
integer
: Metadata id. - name
string
: Metadata name. - type required
string
(values: Folder, Project, Package, Environment): The type of SSIS object metadata.
- description
- items
- nextLink
IntegrationRuntimes_GetStatus
Gets detailed status information for an integration runtime.
azure_datafactory.IntegrationRuntimes_GetStatus({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
IntegrationRuntimes_CreateLinkedIntegrationRuntime
Create a linked integration runtime entry in a shared integration runtime.
azure_datafactory.IntegrationRuntimes_CreateLinkedIntegrationRuntime({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": "",
"createLinkedIntegrationRuntimeRequest": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version. - createLinkedIntegrationRuntimeRequest required CreateLinkedIntegrationRuntimeRequest
- subscriptionId required
Output
IntegrationRuntimes_ListAuthKeys
Retrieves the authentication keys for an integration runtime.
azure_datafactory.IntegrationRuntimes_ListAuthKeys({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output
object
: The integration runtime authentication keys.- authKey1
string
: The primary integration runtime authentication key. - authKey2
string
: The secondary integration runtime authentication key.
- authKey1
IntegrationRuntimes_GetMonitoringData
Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
azure_datafactory.IntegrationRuntimes_GetMonitoringData({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output
object
: Get monitoring data response.- name
string
: Integration runtime name. - nodes
array
: Integration runtime node monitoring data.- items
object
: Monitoring data for integration runtime node.- availableMemoryInMB
integer
: Available memory (MB) on the integration runtime node. - concurrentJobsLimit
integer
: Maximum concurrent jobs on the integration runtime node. - concurrentJobsRunning
integer
: The number of jobs currently running on the integration runtime node. - cpuUtilization
integer
: CPU percentage on the integration runtime node. - maxConcurrentJobs
integer
: The maximum concurrent jobs in this integration runtime. - nodeName
string
: Name of the integration runtime node. - receivedBytes
number
: Received bytes on the integration runtime node. - sentBytes
number
: Sent bytes on the integration runtime node.
- availableMemoryInMB
- items
- name
IntegrationRuntimeNodes_Delete
Deletes a self-hosted integration runtime node.
azure_datafactory.IntegrationRuntimeNodes_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"nodeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - nodeName required
string
: The integration runtime node name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
IntegrationRuntimeNodes_Get
Gets a self-hosted integration runtime node.
azure_datafactory.IntegrationRuntimeNodes_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"nodeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - nodeName required
string
: The integration runtime node name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output
object
: Properties of Self-hosted integration runtime node.- capabilities
object
: The integration runtime capabilities dictionary - concurrentJobsLimit
integer
: Maximum concurrent jobs on the integration runtime node. - expiryTime
string
: The time at which the integration runtime will expire in ISO8601 format. - hostServiceUri
string
: URI for the host machine of the integration runtime. - isActiveDispatcher
boolean
: Indicates whether this node is the active dispatcher for integration runtime requests. - lastConnectTime
string
: The most recent time at which the integration runtime was connected in ISO8601 format. - lastEndUpdateTime
string
: The last time for the integration runtime node update end. - lastStartTime
string
: The time the node last started up. - lastStartUpdateTime
string
: The last time for the integration runtime node update start. - lastStopTime
string
: The integration runtime node last stop time. - lastUpdateResult
string
(values: None, Succeed, Fail): The result of the last integration runtime node update. - machineName
string
: Machine name of the integration runtime node. - maxConcurrentJobs
integer
: The maximum concurrent jobs in this integration runtime. - nodeName
string
: Name of the integration runtime node. - registerTime
string
: The time at which the integration runtime node was registered in ISO8601 format. - status
string
(values: NeedRegistration, Online, Limited, Offline, Upgrading, Initializing, InitializeFailed): Status of the integration runtime node. - version
string
: Version of the integration runtime node. - versionStatus
string
: Status of the integration runtime node version.
- capabilities
IntegrationRuntimeNodes_Update
Updates a self-hosted integration runtime node.
azure_datafactory.IntegrationRuntimeNodes_Update({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"nodeName": "",
"api-version": "",
"updateIntegrationRuntimeNodeRequest": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - nodeName required
string
: The integration runtime node name. - api-version required
string
: The API version. - updateIntegrationRuntimeNodeRequest required UpdateIntegrationRuntimeNodeRequest
- subscriptionId required
Output
- output
object
: Properties of Self-hosted integration runtime node.- capabilities
object
: The integration runtime capabilities dictionary - concurrentJobsLimit
integer
: Maximum concurrent jobs on the integration runtime node. - expiryTime
string
: The time at which the integration runtime will expire in ISO8601 format. - hostServiceUri
string
: URI for the host machine of the integration runtime. - isActiveDispatcher
boolean
: Indicates whether this node is the active dispatcher for integration runtime requests. - lastConnectTime
string
: The most recent time at which the integration runtime was connected in ISO8601 format. - lastEndUpdateTime
string
: The last time for the integration runtime node update end. - lastStartTime
string
: The time the node last started up. - lastStartUpdateTime
string
: The last time for the integration runtime node update start. - lastStopTime
string
: The integration runtime node last stop time. - lastUpdateResult
string
(values: None, Succeed, Fail): The result of the last integration runtime node update. - machineName
string
: Machine name of the integration runtime node. - maxConcurrentJobs
integer
: The maximum concurrent jobs in this integration runtime. - nodeName
string
: Name of the integration runtime node. - registerTime
string
: The time at which the integration runtime node was registered in ISO8601 format. - status
string
(values: NeedRegistration, Online, Limited, Offline, Upgrading, Initializing, InitializeFailed): Status of the integration runtime node. - version
string
: Version of the integration runtime node. - versionStatus
string
: Status of the integration runtime node version.
- capabilities
IntegrationRuntimeNodes_GetIpAddress
Get the IP address of self-hosted integration runtime node.
azure_datafactory.IntegrationRuntimeNodes_GetIpAddress({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"nodeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - nodeName required
string
: The integration runtime node name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output
object
: The IP address of self-hosted integration runtime node.- ipAddress
string
: The IP address of self-hosted integration runtime node.
- ipAddress
IntegrationRuntimeObjectMetadata_Refresh
Refresh a SSIS integration runtime object metadata.
azure_datafactory.IntegrationRuntimeObjectMetadata_Refresh({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
IntegrationRuntimes_RegenerateAuthKey
Regenerates the authentication key for an integration runtime.
azure_datafactory.IntegrationRuntimes_RegenerateAuthKey({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": "",
"regenerateKeyParameters": {}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version. - regenerateKeyParameters required
object
: Parameters to regenerate the authentication key.- keyName
string
(values: authKey1, authKey2): The name of the authentication key to regenerate.
- keyName
- subscriptionId required
Output
- output
object
: The integration runtime authentication keys.- authKey1
string
: The primary integration runtime authentication key. - authKey2
string
: The secondary integration runtime authentication key.
- authKey1
IntegrationRuntimes_RemoveLinks
Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.
azure_datafactory.IntegrationRuntimes_RemoveLinks({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": "",
"linkedIntegrationRuntimeRequest": {
"factoryName": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version. - linkedIntegrationRuntimeRequest required LinkedIntegrationRuntimeRequest
- subscriptionId required
Output
Output schema unknown
IntegrationRuntimes_Start
Starts a ManagedReserved type integration runtime.
azure_datafactory.IntegrationRuntimes_Start({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
IntegrationRuntimes_Stop
Stops a ManagedReserved type integration runtime.
azure_datafactory.IntegrationRuntimes_Stop({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
IntegrationRuntimes_SyncCredentials
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.
azure_datafactory.IntegrationRuntimes_SyncCredentials({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
IntegrationRuntimes_Upgrade
Upgrade self-hosted integration runtime to latest version if availability.
azure_datafactory.IntegrationRuntimes_Upgrade({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"integrationRuntimeName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - integrationRuntimeName required
string
: The integration runtime name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
LinkedServices_ListByFactory
Lists linked services.
azure_datafactory.LinkedServices_ListByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output LinkedServiceListResponse
LinkedServices_Delete
Deletes a linked service.
azure_datafactory.LinkedServices_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"linkedServiceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - linkedServiceName required
string
: The linked service name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
LinkedServices_Get
Gets a linked service.
azure_datafactory.LinkedServices_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"linkedServiceName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - linkedServiceName required
string
: The linked service name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output LinkedServiceResource
LinkedServices_CreateOrUpdate
Creates or updates a linked service.
azure_datafactory.LinkedServices_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"linkedServiceName": "",
"api-version": "",
"linkedService": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - linkedServiceName required
string
: The linked service name. - api-version required
string
: The API version. - If-Match
string
: ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. - linkedService required LinkedServiceResource
- subscriptionId required
Output
- output LinkedServiceResource
PipelineRuns_Get
Get a pipeline run by its run ID.
azure_datafactory.PipelineRuns_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"runId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - runId required
string
: The pipeline run identifier. - api-version required
string
: The API version.
- subscriptionId required
Output
- output PipelineRun
PipelineRuns_Cancel
Cancel a pipeline run by its run ID.
azure_datafactory.PipelineRuns_Cancel({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"runId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - runId required
string
: The pipeline run identifier. - isRecursive
boolean
: If true, cancel all the Child pipelines that are triggered by the current pipeline. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
ActivityRuns_QueryByPipelineRun
Query activity runs based on input filter conditions.
azure_datafactory.ActivityRuns_QueryByPipelineRun({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"runId": "",
"api-version": "",
"filterParameters": {
"lastUpdatedAfter": "",
"lastUpdatedBefore": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - runId required
string
: The pipeline run identifier. - api-version required
string
: The API version. - filterParameters required RunFilterParameters
- subscriptionId required
Output
- output ActivityRunsQueryResponse
Pipelines_ListByFactory
Lists pipelines.
azure_datafactory.Pipelines_ListByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output PipelineListResponse
Pipelines_Delete
Deletes a pipeline.
azure_datafactory.Pipelines_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"pipelineName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - pipelineName required
string
: The pipeline name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Pipelines_Get
Gets a pipeline.
azure_datafactory.Pipelines_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"pipelineName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - pipelineName required
string
: The pipeline name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output PipelineResource
Pipelines_CreateOrUpdate
Creates or updates a pipeline.
azure_datafactory.Pipelines_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"pipelineName": "",
"api-version": "",
"pipeline": {
"properties": {}
}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - pipelineName required
string
: The pipeline name. - api-version required
string
: The API version. - If-Match
string
: ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. - pipeline required PipelineResource
- subscriptionId required
Output
- output PipelineResource
Pipelines_CreateRun
Creates a run of a pipeline.
azure_datafactory.Pipelines_CreateRun({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"pipelineName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - pipelineName required
string
: The pipeline name. - api-version required
string
: The API version. - referencePipelineRunId
string
: The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. - isRecovery
boolean
: 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
string
: In recovery mode, the rerun will start from this activity. If not specified, all activities will run. - parameters ParameterValueSpecification
- subscriptionId required
Output
- output CreateRunResponse
DataFlowDebugSession_QueryByFactory
Query all active data flow debug sessions.
azure_datafactory.DataFlowDebugSession_QueryByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
PipelineRuns_QueryByFactory
Query pipeline runs in the factory based on input filter conditions.
azure_datafactory.PipelineRuns_QueryByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"filterParameters": {
"lastUpdatedAfter": "",
"lastUpdatedBefore": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - filterParameters required RunFilterParameters
- subscriptionId required
Output
- output PipelineRunsQueryResponse
TriggerRuns_QueryByFactory
Query trigger runs.
azure_datafactory.TriggerRuns_QueryByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": "",
"filterParameters": {
"lastUpdatedAfter": "",
"lastUpdatedBefore": ""
}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version. - filterParameters required RunFilterParameters
- subscriptionId required
Output
- output TriggerRunsQueryResponse
Triggers_ListByFactory
Lists triggers.
azure_datafactory.Triggers_ListByFactory({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output TriggerListResponse
Triggers_Delete
Deletes a trigger.
azure_datafactory.Triggers_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Triggers_Get
Gets a trigger.
azure_datafactory.Triggers_Get({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version. - If-None-Match
string
: 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.
- subscriptionId required
Output
- output TriggerResource
Triggers_CreateOrUpdate
Creates or updates a trigger.
azure_datafactory.Triggers_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": "",
"trigger": null
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version. - If-Match
string
: ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. - trigger required TriggerResource
- subscriptionId required
Output
- output TriggerResource
Triggers_GetEventSubscriptionStatus
Get a trigger's event subscription status.
azure_datafactory.Triggers_GetEventSubscriptionStatus({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
RerunTriggers_ListByTrigger
Lists rerun triggers by an original trigger name.
azure_datafactory.RerunTriggers_ListByTrigger({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
- output RerunTriggerListResponse
RerunTriggers_Create
Creates a rerun trigger.
azure_datafactory.RerunTriggers_Create({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"rerunTriggerName": "",
"api-version": "",
"rerunTumblingWindowTriggerActionParameters": {
"startTime": "",
"endTime": "",
"maxConcurrency": 0
}
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - rerunTriggerName required
string
: The rerun trigger name. - api-version required
string
: The API version. - rerunTumblingWindowTriggerActionParameters required RerunTumblingWindowTriggerActionParameters
- subscriptionId required
Output
- output TriggerResource
RerunTriggers_Cancel
Cancels a trigger.
azure_datafactory.RerunTriggers_Cancel({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"rerunTriggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - rerunTriggerName required
string
: The rerun trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
RerunTriggers_Start
Starts a trigger.
azure_datafactory.RerunTriggers_Start({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"rerunTriggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - rerunTriggerName required
string
: The rerun trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
RerunTriggers_Stop
Stops a trigger.
azure_datafactory.RerunTriggers_Stop({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"rerunTriggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - rerunTriggerName required
string
: The rerun trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Triggers_Start
Starts a trigger.
azure_datafactory.Triggers_Start({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Triggers_Stop
Stops a trigger.
azure_datafactory.Triggers_Stop({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Triggers_SubscribeToEvents
Subscribe event trigger to events.
azure_datafactory.Triggers_SubscribeToEvents({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
TriggerRuns_Rerun
Rerun single trigger instance by runId.
azure_datafactory.TriggerRuns_Rerun({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"runId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - runId required
string
: The pipeline run identifier. - api-version required
string
: The API version.
- subscriptionId required
Output
Output schema unknown
Triggers_UnsubscribeFromEvents
Unsubscribe event trigger from events.
azure_datafactory.Triggers_UnsubscribeFromEvents({
"subscriptionId": "",
"resourceGroupName": "",
"factoryName": "",
"triggerName": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription identifier. - resourceGroupName required
string
: The resource group name. - factoryName required
string
: The factory name. - triggerName required
string
: The trigger name. - api-version required
string
: The API version.
- subscriptionId required
Output
Definitions
AccessPolicyResponse
- AccessPolicyResponse
object
: Get Data Plane read only token response definition.- accessToken
string
: Data Plane read only access token. - dataPlaneUrl
string
: Data Plane service base URL. - policy UserAccessPolicy
- accessToken
ActivityRun
- ActivityRun
object
: Information about an activity run in a pipeline.- activityName
string
: The name of the activity. - activityRunEnd
string
: The end time of the activity run in 'ISO 8601' format. - activityRunId
string
: The id of the activity run. - activityRunStart
string
: The start time of the activity run in 'ISO 8601' format. - activityType
string
: The type of the activity. - durationInMs
integer
: The duration of the activity run. - error
object
: The error if any from the activity run. - input
object
: The input for the activity. - linkedServiceName
string
: The name of the compute linked service. - output
object
: The output for the activity. - pipelineName
string
: The name of the pipeline. - pipelineRunId
string
: The id of the pipeline run. - status
string
: The status of the activity run.
- activityName
ActivityRunsQueryResponse
- ActivityRunsQueryResponse
object
: A list activity runs.- continuationToken
string
: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. - value required
array
: List of activity runs.- items ActivityRun
- continuationToken
AddDataFlowToDebugSessionResponse
- AddDataFlowToDebugSessionResponse
object
: Response body structure for starting data flow debug session.- jobVersion
string
: The ID of data flow debug job version.
- jobVersion
AzureKeyVaultSecretReference
- AzureKeyVaultSecretReference
object
: Azure Key Vault secret reference.- secretName required
object
: The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). - secretVersion
object
: The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string). - store required LinkedServiceReference
- type required
string
: Type of the secret.
- secretName required
CloudError
- CloudError
object
: The object that defines the structure of an Azure Data Factory error response.- error required CloudErrorBody
CloudErrorBody
- CloudErrorBody
object
: The object that defines the structure of an Azure Data Factory error.- code required
string
: Error code. - details
array
: Array with additional error details.- items CloudError
- message required
string
: Error message. - target
string
: Property name/path in request associated with error.
- code required
CreateDataFlowDebugSessionRequest
- CreateDataFlowDebugSessionRequest
object
: Request body structure for creating data flow debug session.- computeType
string
: Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided. - coreCount
integer
: Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided. - integrationRuntime IntegrationRuntimeDebugResource
- timeToLive
integer
: Time to live setting of the cluster in minutes.
- computeType
CreateDataFlowDebugSessionResponse
- CreateDataFlowDebugSessionResponse
object
: Response body structure for creating data flow debug session.- sessionId
string
: The ID of data flow debu
- sessionId