Add-AzDataFactoryV2DataFlowDebugSessionPackage
Add data flow resource and its dependencies into specific data flow debug session.
Syntax
ByFactoryName (Default)
Add-AzDataFactoryV2DataFlowDebugSessionPackage
[-PackageFile] <String>
[[-SessionId] <String>]
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByFactoryObject
Add-AzDataFactoryV2DataFlowDebugSessionPackage
[-PackageFile] <String>
[[-SessionId] <String>]
[-DataFactory] <PSDataFactory>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceId
Add-AzDataFactoryV2DataFlowDebugSessionPackage
[-PackageFile] <String>
[[-SessionId] <String>]
[-ResourceId] <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This command attaches data flow resource and its dependencies to the specific debug session
The PowerShell command sequence for data flow debug workflow should be:
Start-AzDataFactoryV2DataFlowDebugSession
Add-AzDataFactoryV2DataFlowDebugSessionPackage
Invoke-AzDataFactoryV2DataFlowDebugSessionCommand (repeat this step for different commands/targets, or repeat step 2-3 in order to change the package file)
Stop-AzDataFactoryV2DataFlowDebugSession
Examples
Example 1
Add-AzDataFactoryV2DataFlowDebugSessionPackage -ResourceGroupName adf -DataFactoryName WikiADF -PackageFile "D:\dataflowps\addpackage.json" -SessionId 550effe4-93a3-485c-8525-eaf25259efbd
Add data flow package into debug session "550effe4-93a3-485c-8525-eaf25259efbd" of "WikiADF" data factory.
Package file contains data flow debug resource, list of dataset debug resource, list of linked service debug resource, debug setting and session ID. For instance:
{
"dataFlow": {
"name": "dataflow5",
"properties": {
"type": "MappingDataFlow",
"typeProperties": {
"sources": [
{
"dataset": {
"referenceName": "DelimitedTextInput",
"type": "DatasetReference"
},
"name": "source1",
"typeProperties": {}
}
],
"sinks": [],
"transformations": [],
"script": "\n\nsource(output(\n\t\tResourceAgencyNum as string,\n\t\tPublicName as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1"
}
}
},
"datasets": [
{
"name": "DelimitedTextInput",
"properties": {
"linkedServiceName": {
"referenceName": "AzureBlobStorage1",
"type": "LinkedServiceReference"
},
"annotations": [],
"type": "DelimitedText",
"typeProperties": {
"location": {
"type": "AzureBlobStorageLocation",
"container": "20192019"
},
"columnDelimiter": ",",
"escapeChar": "\",
"firstRowAsHeader": true,
"quoteChar": """
},
"schema": [
{
"name": "ResourceAgencyNum",
"type": "String"
},
{
"name": "PublicName",
"type": "String"
}
]
},
"type": "Microsoft.DataFactory/factories/datasets"
}
],
"linkedServices": [
{
"name": "AzureBlobStorage1",
"type": "Microsoft.DataFactory/factories/linkedservices",
"properties": {
"annotations": [],
"type": "AzureBlobStorage",
"typeProperties": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=name;AccountKey=key;EndpointSuffix=core.windows.net"
}
}
}
],
"debugSettings": {
"sourceSettings": [
{
"sourceName": "source1",
"rowLimit": 1000
}
]
},
"sessionId": "4f988caf-e765-47d2-82cd-430334a6b135"
}
SessionID parameter is used to replace the existing sessionId property in the package file.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataFactory
The data factory object.
Parameter properties
Type: PSDataFactory
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFactoryObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-DataFactoryName
The data factory name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFactoryName
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PackageFile
The JSON file path.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: File
Parameter sets
(All)
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
If specified will write true in case operation succeeds. This parameter is optional.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFactoryName
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
The Azure resource ID.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SessionId
The data flow debug session ID.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 3 Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, data, factories
