Azure Native v1.102.0, May 2 23

azure-native.datafactory.getDataFlow

Explore with Pulumi AI

Gets a data flow. API Version: 2018-06-01.

Using getDataFlow

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataFlow(args: GetDataFlowArgs, opts?: InvokeOptions): Promise<GetDataFlowResult>
function getDataFlowOutput(args: GetDataFlowOutputArgs, opts?: InvokeOptions): Output<GetDataFlowResult>

def get_data_flow(data_flow_name: Optional[str] = None,
                  factory_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDataFlowResult
def get_data_flow_output(data_flow_name: Optional[pulumi.Input[str]] = None,
                  factory_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDataFlowResult]

func LookupDataFlow(ctx *Context, args *LookupDataFlowArgs, opts ...InvokeOption) (*LookupDataFlowResult, error)
func LookupDataFlowOutput(ctx *Context, args *LookupDataFlowOutputArgs, opts ...InvokeOption) LookupDataFlowResultOutput

> Note: This function is named LookupDataFlow in the Go SDK.

public static class GetDataFlow 
{
    public static Task<GetDataFlowResult> InvokeAsync(GetDataFlowArgs args, InvokeOptions? opts = null)
    public static Output<GetDataFlowResult> Invoke(GetDataFlowInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataFlowResult> getDataFlow(GetDataFlowArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:datafactory:getDataFlow
  arguments:
    # arguments dictionary

The following arguments are supported:

DataFlowName string: The data flow name.
FactoryName string: The factory name.
ResourceGroupName string: The resource group name.

DataFlowName string: The data flow name.
FactoryName string: The factory name.
ResourceGroupName string: The resource group name.

dataFlowName String: The data flow name.
factoryName String: The factory name.
resourceGroupName String: The resource group name.

dataFlowName string: The data flow name.
factoryName string: The factory name.
resourceGroupName string: The resource group name.

data_flow_name str: The data flow name.
factory_name str: The factory name.
resource_group_name str: The resource group name.

dataFlowName String: The data flow name.
factoryName String: The factory name.
resourceGroupName String: The resource group name.

getDataFlow Result

The following output properties are available:

Etag string: Etag identifies change in the resource.
Id string: The resource identifier.
Name string: The resource name.
Properties Pulumi.AzureNative.DataFactory.Outputs.FlowletResponse | Pulumi.AzureNative.DataFactory.Outputs.MappingDataFlowResponse | Pulumi.AzureNative.DataFactory.Outputs.WranglingDataFlowResponse: Data flow properties.
Type string: The resource type.

Etag string: Etag identifies change in the resource.
Id string: The resource identifier.
Name string: The resource name.
Properties FlowletResponse | MappingDataFlowResponse | WranglingDataFlowResponse: Data flow properties.
Type string: The resource type.

etag String: Etag identifies change in the resource.
id String: The resource identifier.
name String: The resource name.
properties FlowletResponse | MappingDataFlowResponse | WranglingDataFlowResponse: Data flow properties.
type String: The resource type.

etag string: Etag identifies change in the resource.
id string: The resource identifier.
name string: The resource name.
properties FlowletResponse | MappingDataFlowResponse | WranglingDataFlowResponse: Data flow properties.
type string: The resource type.

etag str: Etag identifies change in the resource.
id str: The resource identifier.
name str: The resource name.
properties FlowletResponse | MappingDataFlowResponse | WranglingDataFlowResponse: Data flow properties.
type str: The resource type.

etag String: Etag identifies change in the resource.
id String: The resource identifier.
name String: The resource name.
properties Property Map | Property Map | Property Map: Data flow properties.
type String: The resource type.

Supporting Types

DataFlowReferenceResponse

ReferenceName string: Reference data flow name.
Type string: Data flow reference type.
DatasetParameters object: Reference data flow parameters from dataset.
Parameters Dictionary<string, object>: Data flow parameters

ReferenceName string: Reference data flow name.
Type string: Data flow reference type.
DatasetParameters interface{}: Reference data flow parameters from dataset.
Parameters map[string]interface{}: Data flow parameters

referenceName String: Reference data flow name.
type String: Data flow reference type.
datasetParameters Object: Reference data flow parameters from dataset.
parameters Map<String,Object>: Data flow parameters

referenceName string: Reference data flow name.
type string: Data flow reference type.
datasetParameters any: Reference data flow parameters from dataset.
parameters {[key: string]: any}: Data flow parameters

reference_name str: Reference data flow name.
type str: Data flow reference type.
dataset_parameters Any: Reference data flow parameters from dataset.
parameters Mapping[str, Any]: Data flow parameters

referenceName String: Reference data flow name.
type String: Data flow reference type.
datasetParameters Any: Reference data flow parameters from dataset.
parameters Map<Any>: Data flow parameters

DataFlowResponseFolder

Name string: The name of the folder that this data flow is in.

Name string: The name of the folder that this data flow is in.

name String: The name of the folder that this data flow is in.

name string: The name of the folder that this data flow is in.

name str: The name of the folder that this data flow is in.

name String: The name of the folder that this data flow is in.

DataFlowSinkResponse

Name string: Transformation name.
Dataset Pulumi.AzureNative.DataFactory.Inputs.DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet Pulumi.AzureNative.DataFactory.Inputs.DataFlowReferenceResponse: Flowlet Reference
LinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Linked service reference.
RejectedDataLinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Rejected data linked service reference.
SchemaLinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Schema linked service reference.

Name string: Transformation name.
Dataset DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet DataFlowReferenceResponse: Flowlet Reference
LinkedService LinkedServiceReferenceResponse: Linked service reference.
RejectedDataLinkedService LinkedServiceReferenceResponse: Rejected data linked service reference.
SchemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.

name String: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description String: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.
rejectedDataLinkedService LinkedServiceReferenceResponse: Rejected data linked service reference.
schemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.

name string: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description string: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.
rejectedDataLinkedService LinkedServiceReferenceResponse: Rejected data linked service reference.
schemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.

name str: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description str: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linked_service LinkedServiceReferenceResponse: Linked service reference.
rejected_data_linked_service LinkedServiceReferenceResponse: Rejected data linked service reference.
schema_linked_service LinkedServiceReferenceResponse: Schema linked service reference.

name String: Transformation name.
dataset Property Map: Dataset reference.
description String: Transformation description.
flowlet Property Map: Flowlet Reference
linkedService Property Map: Linked service reference.
rejectedDataLinkedService Property Map: Rejected data linked service reference.
schemaLinkedService Property Map: Schema linked service reference.

DataFlowSourceResponse

Name string: Transformation name.
Dataset Pulumi.AzureNative.DataFactory.Inputs.DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet Pulumi.AzureNative.DataFactory.Inputs.DataFlowReferenceResponse: Flowlet Reference
LinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Linked service reference.
SchemaLinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Schema linked service reference.

Name string: Transformation name.
Dataset DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet DataFlowReferenceResponse: Flowlet Reference
LinkedService LinkedServiceReferenceResponse: Linked service reference.
SchemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.

name String: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description String: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.
schemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.

name string: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description string: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.
schemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.

name str: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description str: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linked_service LinkedServiceReferenceResponse: Linked service reference.
schema_linked_service LinkedServiceReferenceResponse: Schema linked service reference.

name String: Transformation name.
dataset Property Map: Dataset reference.
description String: Transformation description.
flowlet Property Map: Flowlet Reference
linkedService Property Map: Linked service reference.
schemaLinkedService Property Map: Schema linked service reference.

DatasetReferenceResponse

ReferenceName string: Reference dataset name.
Type string: Dataset reference type.
Parameters Dictionary<string, object>: Arguments for dataset.

ReferenceName string: Reference dataset name.
Type string: Dataset reference type.
Parameters map[string]interface{}: Arguments for dataset.

referenceName String: Reference dataset name.
type String: Dataset reference type.
parameters Map<String,Object>: Arguments for dataset.

referenceName string: Reference dataset name.
type string: Dataset reference type.
parameters {[key: string]: any}: Arguments for dataset.

reference_name str: Reference dataset name.
type str: Dataset reference type.
parameters Mapping[str, Any]: Arguments for dataset.

referenceName String: Reference dataset name.
type String: Dataset reference type.
parameters Map<Any>: Arguments for dataset.

FlowletResponse

Annotations List<object>: List of tags that can be used for describing the data flow.
Description string: The description of the data flow.
Folder Pulumi.AzureNative.DataFactory.Inputs.DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
Script string: Flowlet script.
ScriptLines List<string>: Flowlet script lines.
Sinks List<Pulumi.AzureNative.DataFactory.Inputs.DataFlowSinkResponse>: List of sinks in Flowlet.
Sources List<Pulumi.AzureNative.DataFactory.Inputs.DataFlowSourceResponse>: List of sources in Flowlet.
Transformations List<Pulumi.AzureNative.DataFactory.Inputs.TransformationResponse>: List of transformations in Flowlet.

Annotations []interface{}: List of tags that can be used for describing the data flow.
Description string: The description of the data flow.
Folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
Script string: Flowlet script.
ScriptLines []string: Flowlet script lines.
Sinks []DataFlowSinkResponse: List of sinks in Flowlet.
Sources []DataFlowSourceResponse: List of sources in Flowlet.
Transformations []TransformationResponse: List of transformations in Flowlet.

annotations List<Object>: List of tags that can be used for describing the data flow.
description String: The description of the data flow.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script String: Flowlet script.
scriptLines List<String>: Flowlet script lines.
sinks List<DataFlowSinkResponse>: List of sinks in Flowlet.
sources List<DataFlowSourceResponse>: List of sources in Flowlet.
transformations List<TransformationResponse>: List of transformations in Flowlet.

annotations any[]: List of tags that can be used for describing the data flow.
description string: The description of the data flow.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script string: Flowlet script.
scriptLines string[]: Flowlet script lines.
sinks DataFlowSinkResponse[]: List of sinks in Flowlet.
sources DataFlowSourceResponse[]: List of sources in Flowlet.
transformations TransformationResponse[]: List of transformations in Flowlet.

annotations Sequence[Any]: List of tags that can be used for describing the data flow.
description str: The description of the data flow.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script str: Flowlet script.
script_lines Sequence[str]: Flowlet script lines.
sinks Sequence[DataFlowSinkResponse]: List of sinks in Flowlet.
sources Sequence[DataFlowSourceResponse]: List of sources in Flowlet.
transformations Sequence[TransformationResponse]: List of transformations in Flowlet.

annotations List<Any>: List of tags that can be used for describing the data flow.
description String: The description of the data flow.
folder Property Map: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script String: Flowlet script.
scriptLines List<String>: Flowlet script lines.
sinks List<Property Map>: List of sinks in Flowlet.
sources List<Property Map>: List of sources in Flowlet.
transformations List<Property Map>: List of transformations in Flowlet.

LinkedServiceReferenceResponse

ReferenceName string: Reference LinkedService name.
Type string: Linked service reference type.
Parameters Dictionary<string, object>: Arguments for LinkedService.

ReferenceName string: Reference LinkedService name.
Type string: Linked service reference type.
Parameters map[string]interface{}: Arguments for LinkedService.

referenceName String: Reference LinkedService name.
type String: Linked service reference type.
parameters Map<String,Object>: Arguments for LinkedService.

referenceName string: Reference LinkedService name.
type string: Linked service reference type.
parameters {[key: string]: any}: Arguments for LinkedService.

reference_name str: Reference LinkedService name.
type str: Linked service reference type.
parameters Mapping[str, Any]: Arguments for LinkedService.

referenceName String: Reference LinkedService name.
type String: Linked service reference type.
parameters Map<Any>: Arguments for LinkedService.

MappingDataFlowResponse

Annotations List<object>: List of tags that can be used for describing the data flow.
Description string: The description of the data flow.
Folder Pulumi.AzureNative.DataFactory.Inputs.DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
Script string: DataFlow script.
ScriptLines List<string>: Data flow script lines.
Sinks List<Pulumi.AzureNative.DataFactory.Inputs.DataFlowSinkResponse>: List of sinks in data flow.
Sources List<Pulumi.AzureNative.DataFactory.Inputs.DataFlowSourceResponse>: List of sources in data flow.
Transformations List<Pulumi.AzureNative.DataFactory.Inputs.TransformationResponse>: List of transformations in data flow.

Annotations []interface{}: List of tags that can be used for describing the data flow.
Description string: The description of the data flow.
Folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
Script string: DataFlow script.
ScriptLines []string: Data flow script lines.
Sinks []DataFlowSinkResponse: List of sinks in data flow.
Sources []DataFlowSourceResponse: List of sources in data flow.
Transformations []TransformationResponse: List of transformations in data flow.

annotations List<Object>: List of tags that can be used for describing the data flow.
description String: The description of the data flow.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script String: DataFlow script.
scriptLines List<String>: Data flow script lines.
sinks List<DataFlowSinkResponse>: List of sinks in data flow.
sources List<DataFlowSourceResponse>: List of sources in data flow.
transformations List<TransformationResponse>: List of transformations in data flow.

annotations any[]: List of tags that can be used for describing the data flow.
description string: The description of the data flow.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script string: DataFlow script.
scriptLines string[]: Data flow script lines.
sinks DataFlowSinkResponse[]: List of sinks in data flow.
sources DataFlowSourceResponse[]: List of sources in data flow.
transformations TransformationResponse[]: List of transformations in data flow.

annotations Sequence[Any]: List of tags that can be used for describing the data flow.
description str: The description of the data flow.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script str: DataFlow script.
script_lines Sequence[str]: Data flow script lines.
sinks Sequence[DataFlowSinkResponse]: List of sinks in data flow.
sources Sequence[DataFlowSourceResponse]: List of sources in data flow.
transformations Sequence[TransformationResponse]: List of transformations in data flow.

annotations List<Any>: List of tags that can be used for describing the data flow.
description String: The description of the data flow.
folder Property Map: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script String: DataFlow script.
scriptLines List<String>: Data flow script lines.
sinks List<Property Map>: List of sinks in data flow.
sources List<Property Map>: List of sources in data flow.
transformations List<Property Map>: List of transformations in data flow.

PowerQuerySourceResponse

Name string: Transformation name.
Dataset Pulumi.AzureNative.DataFactory.Inputs.DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet Pulumi.AzureNative.DataFactory.Inputs.DataFlowReferenceResponse: Flowlet Reference
LinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Linked service reference.
SchemaLinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Schema linked service reference.
Script string: source script.

Name string: Transformation name.
Dataset DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet DataFlowReferenceResponse: Flowlet Reference
LinkedService LinkedServiceReferenceResponse: Linked service reference.
SchemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.
Script string: source script.

name String: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description String: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.
schemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.
script String: source script.

name string: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description string: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.
schemaLinkedService LinkedServiceReferenceResponse: Schema linked service reference.
script string: source script.

name str: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description str: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linked_service LinkedServiceReferenceResponse: Linked service reference.
schema_linked_service LinkedServiceReferenceResponse: Schema linked service reference.
script str: source script.

name String: Transformation name.
dataset Property Map: Dataset reference.
description String: Transformation description.
flowlet Property Map: Flowlet Reference
linkedService Property Map: Linked service reference.
schemaLinkedService Property Map: Schema linked service reference.
script String: source script.

TransformationResponse

Name string: Transformation name.
Dataset Pulumi.AzureNative.DataFactory.Inputs.DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet Pulumi.AzureNative.DataFactory.Inputs.DataFlowReferenceResponse: Flowlet Reference
LinkedService Pulumi.AzureNative.DataFactory.Inputs.LinkedServiceReferenceResponse: Linked service reference.

Name string: Transformation name.
Dataset DatasetReferenceResponse: Dataset reference.
Description string: Transformation description.
Flowlet DataFlowReferenceResponse: Flowlet Reference
LinkedService LinkedServiceReferenceResponse: Linked service reference.

name String: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description String: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.

name string: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description string: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linkedService LinkedServiceReferenceResponse: Linked service reference.

name str: Transformation name.
dataset DatasetReferenceResponse: Dataset reference.
description str: Transformation description.
flowlet DataFlowReferenceResponse: Flowlet Reference
linked_service LinkedServiceReferenceResponse: Linked service reference.

name String: Transformation name.
dataset Property Map: Dataset reference.
description String: Transformation description.
flowlet Property Map: Flowlet Reference
linkedService Property Map: Linked service reference.

WranglingDataFlowResponse

Annotations List<object>: List of tags that can be used for describing the data flow.
Description string: The description of the data flow.
DocumentLocale string: Locale of the Power query mashup document.
Folder Pulumi.AzureNative.DataFactory.Inputs.DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
Script string: Power query mashup script.
Sources List<Pulumi.AzureNative.DataFactory.Inputs.PowerQuerySourceResponse>: List of sources in Power Query.

Annotations []interface{}: List of tags that can be used for describing the data flow.
Description string: The description of the data flow.
DocumentLocale string: Locale of the Power query mashup document.
Folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
Script string: Power query mashup script.
Sources []PowerQuerySourceResponse: List of sources in Power Query.

annotations List<Object>: List of tags that can be used for describing the data flow.
description String: The description of the data flow.
documentLocale String: Locale of the Power query mashup document.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script String: Power query mashup script.
sources List<PowerQuerySourceResponse>: List of sources in Power Query.

annotations any[]: List of tags that can be used for describing the data flow.
description string: The description of the data flow.
documentLocale string: Locale of the Power query mashup document.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script string: Power query mashup script.
sources PowerQuerySourceResponse[]: List of sources in Power Query.

annotations Sequence[Any]: List of tags that can be used for describing the data flow.
description str: The description of the data flow.
document_locale str: Locale of the Power query mashup document.
folder DataFlowResponseFolder: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script str: Power query mashup script.
sources Sequence[PowerQuerySourceResponse]: List of sources in Power Query.

annotations List<Any>: List of tags that can be used for describing the data flow.
description String: The description of the data flow.
documentLocale String: Locale of the Power query mashup document.
folder Property Map: The folder that this data flow is in. If not specified, Data flow will appear at the root level.
script String: Power query mashup script.
sources List<Property Map>: List of sources in Power Query.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0