This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

datafactory¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.datafactory.AwaitableGetFactoryResult(github_configurations=None, id=None, identities=None, location=None, name=None, resource_group_name=None, tags=None, vsts_configurations=None)¶

class pulumi_azure.datafactory.DatasetMysql(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, folder=None, linked_service_name=None, name=None, parameters=None, resource_group_name=None, schema_columns=None, table_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a MySQL Dataset inside a Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_mysql = azure.datafactory.LinkedServiceMysql("exampleLinkedServiceMysql",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test")
example_dataset_mysql = azure.datafactory.DatasetMysql("exampleDatasetMysql",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    linked_service_name=example_linked_service_mysql.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Dataset MySQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Dataset MySQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Dataset MySQL.
folder (pulumi.Input[str]) – The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
linked_service_name (pulumi.Input[str]) – The Data Factory Linked Service name in which to associate the Dataset with.
name (pulumi.Input[str]) – Specifies the name of the Data Factory Dataset MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Dataset MySQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Dataset MySQL. Changing this forces a new resource
schema_columns (pulumi.Input[list]) – A schema_column block as defined below.
table_name (pulumi.Input[str]) – The table name of the Data Factory Dataset MySQL.

The schema_columns object supports the following:

description (pulumi.Input[str]) - The description of the column.
name (pulumi.Input[str]) - The name of the column.
type (pulumi.Input[str]) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Dataset MySQL.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Dataset MySQL.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Dataset MySQL.

folder: pulumi.Output[str] = None¶: The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

linked_service_name: pulumi.Output[str] = None¶: The Data Factory Linked Service name in which to associate the Dataset with.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Dataset MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Dataset MySQL.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Dataset MySQL. Changing this forces a new resource

schema_columns: pulumi.Output[list] = None¶

A schema_column block as defined below.

description (str) - The description of the column.
name (str) - The name of the column.
type (str) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

table_name: pulumi.Output[str] = None¶: The table name of the Data Factory Dataset MySQL.

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, folder=None, linked_service_name=None, name=None, parameters=None, resource_group_name=None, schema_columns=None, table_name=None)¶

Get an existing DatasetMysql resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Dataset MySQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Dataset MySQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Dataset MySQL.
folder (pulumi.Input[str]) – The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
linked_service_name (pulumi.Input[str]) – The Data Factory Linked Service name in which to associate the Dataset with.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Dataset MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Dataset MySQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Dataset MySQL. Changing this forces a new resource
schema_columns (pulumi.Input[list]) – A schema_column block as defined below.
table_name (pulumi.Input[str]) – The table name of the Data Factory Dataset MySQL.

The schema_columns object supports the following:

description (pulumi.Input[str]) - The description of the column.
name (pulumi.Input[str]) - The name of the column.
type (pulumi.Input[str]) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.DatasetPostgresql(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, folder=None, linked_service_name=None, name=None, parameters=None, resource_group_name=None, schema_columns=None, table_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a PostgreSQL Dataset inside a Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_postgresql = azure.datafactory.LinkedServicePostgresql("exampleLinkedServicePostgresql",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example")
example_dataset_postgresql = azure.datafactory.DatasetPostgresql("exampleDatasetPostgresql",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    linked_service_name=example_linked_service_postgresql.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Dataset PostgreSQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Dataset PostgreSQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Dataset PostgreSQL.
folder (pulumi.Input[str]) – The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
linked_service_name (pulumi.Input[str]) – The Data Factory Linked Service name in which to associate the Dataset with.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Dataset PostgreSQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Dataset PostgreSQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Dataset PostgreSQL. Changing this forces a new resource
schema_columns (pulumi.Input[list]) – A schema_column block as defined below.
table_name (pulumi.Input[str]) – The table name of the Data Factory Dataset PostgreSQL.

The schema_columns object supports the following:

description (pulumi.Input[str]) - The description of the column.
name (pulumi.Input[str]) - The name of the column.
type (pulumi.Input[str]) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Dataset PostgreSQL.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Dataset PostgreSQL.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Dataset PostgreSQL.

folder: pulumi.Output[str] = None¶: The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

linked_service_name: pulumi.Output[str] = None¶: The Data Factory Linked Service name in which to associate the Dataset with.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Dataset PostgreSQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Dataset PostgreSQL.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Dataset PostgreSQL. Changing this forces a new resource

schema_columns: pulumi.Output[list] = None¶

A schema_column block as defined below.

description (str) - The description of the column.
name (str) - The name of the column.
type (str) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

table_name: pulumi.Output[str] = None¶: The table name of the Data Factory Dataset PostgreSQL.

Get an existing DatasetPostgresql resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Dataset PostgreSQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Dataset PostgreSQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Dataset PostgreSQL.
folder (pulumi.Input[str]) – The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
linked_service_name (pulumi.Input[str]) – The Data Factory Linked Service name in which to associate the Dataset with.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Dataset PostgreSQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Dataset PostgreSQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Dataset PostgreSQL. Changing this forces a new resource
schema_columns (pulumi.Input[list]) – A schema_column block as defined below.
table_name (pulumi.Input[str]) – The table name of the Data Factory Dataset PostgreSQL.

The schema_columns object supports the following:

description (pulumi.Input[str]) - The description of the column.
name (pulumi.Input[str]) - The name of the column.
type (pulumi.Input[str]) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.DatasetSqlServerTable(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, folder=None, linked_service_name=None, name=None, parameters=None, resource_group_name=None, schema_columns=None, table_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a SQL Server Table Dataset inside a Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_sql_server = azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")
example_dataset_sql_server_table = azure.datafactory.DatasetSqlServerTable("exampleDatasetSqlServerTable",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    linked_service_name=example_linked_service_sql_server.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Dataset SQL Server Table.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Dataset SQL Server Table.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Dataset SQL Server Table.
folder (pulumi.Input[str]) – The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
linked_service_name (pulumi.Input[str]) – The Data Factory Linked Service name in which to associate the Dataset with.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Dataset SQL Server Table. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Dataset SQL Server Table.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource
schema_columns (pulumi.Input[list]) – A schema_column block as defined below.
table_name (pulumi.Input[str]) – The table name of the Data Factory Dataset SQL Server Table.

The schema_columns object supports the following:

description (pulumi.Input[str]) - The description of the column.
name (pulumi.Input[str]) - The name of the column.
type (pulumi.Input[str]) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Dataset SQL Server Table.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Dataset SQL Server Table.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Dataset SQL Server Table.

folder: pulumi.Output[str] = None¶: The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.

linked_service_name: pulumi.Output[str] = None¶: The Data Factory Linked Service name in which to associate the Dataset with.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Dataset SQL Server Table. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Dataset SQL Server Table.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource

schema_columns: pulumi.Output[list] = None¶

A schema_column block as defined below.

description (str) - The description of the column.
name (str) - The name of the column.
type (str) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

table_name: pulumi.Output[str] = None¶: The table name of the Data Factory Dataset SQL Server Table.

Get an existing DatasetSqlServerTable resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Dataset SQL Server Table.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Dataset SQL Server Table.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Dataset with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Dataset SQL Server Table.
folder (pulumi.Input[str]) – The folder that this Dataset is in. If not specified, the Dataset will appear at the root level.
linked_service_name (pulumi.Input[str]) – The Data Factory Linked Service name in which to associate the Dataset with.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Dataset SQL Server Table. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Dataset SQL Server Table.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Dataset SQL Server Table. Changing this forces a new resource
schema_columns (pulumi.Input[list]) – A schema_column block as defined below.
table_name (pulumi.Input[str]) – The table name of the Data Factory Dataset SQL Server Table.

The schema_columns object supports the following:

description (pulumi.Input[str]) - The description of the column.
name (pulumi.Input[str]) - The name of the column.
type (pulumi.Input[str]) - Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.Factory(resource_name, opts=None, github_configuration=None, identity=None, location=None, name=None, resource_group_name=None, tags=None, vsts_configuration=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Data Factory (Version 2).

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
github_configuration (pulumi.Input[dict]) – A github_configuration block as defined below.
identity (pulumi.Input[dict]) – An identity block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vsts_configuration (pulumi.Input[dict]) – A vsts_configuration block as defined below.

The github_configuration object supports the following:

account_name (pulumi.Input[str]) - Specifies the GitHub account name.
branchName (pulumi.Input[str]) - Specifies the branch of the repository to get code from.
gitUrl (pulumi.Input[str]) - Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
repositoryName (pulumi.Input[str]) - Specifies the name of the git repository.
rootFolder (pulumi.Input[str]) - Specifies the root folder within the repository. Set to / for the top level.

The identity object supports the following:

principal_id (pulumi.Input[str]) - The ID of the Principal (Client) in Azure Active Directory
tenant_id (pulumi.Input[str]) - Specifies the Tenant ID associated with the VSTS account.
type (pulumi.Input[str]) - Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.

The vsts_configuration object supports the following:

account_name (pulumi.Input[str]) - Specifies the VSTS account name.
branchName (pulumi.Input[str]) - Specifies the branch of the repository to get code from.
projectName (pulumi.Input[str]) - Specifies the name of the VSTS project.
repositoryName (pulumi.Input[str]) - Specifies the name of the git repository.
rootFolder (pulumi.Input[str]) - Specifies the root folder within the repository. Set to / for the top level.
tenant_id (pulumi.Input[str]) - Specifies the Tenant ID associated with the VSTS account.

github_configuration: pulumi.Output[dict] = None¶

A github_configuration block as defined below.

account_name (str) - Specifies the GitHub account name.
branchName (str) - Specifies the branch of the repository to get code from.
gitUrl (str) - Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
repositoryName (str) - Specifies the name of the git repository.
rootFolder (str) - Specifies the root folder within the repository. Set to / for the top level.

identity: pulumi.Output[dict] = None¶

An identity block as defined below.

principal_id (str) - The ID of the Principal (Client) in Azure Active Directory
tenant_id (str) - Specifies the Tenant ID associated with the VSTS account.
type (str) - Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

vsts_configuration: pulumi.Output[dict] = None¶

A vsts_configuration block as defined below.

account_name (str) - Specifies the VSTS account name.
branchName (str) - Specifies the branch of the repository to get code from.
projectName (str) - Specifies the name of the VSTS project.
repositoryName (str) - Specifies the name of the git repository.
rootFolder (str) - Specifies the root folder within the repository. Set to / for the top level.
tenant_id (str) - Specifies the Tenant ID associated with the VSTS account.

static get(resource_name, id, opts=None, github_configuration=None, identity=None, location=None, name=None, resource_group_name=None, tags=None, vsts_configuration=None)¶

Get an existing Factory resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
github_configuration (pulumi.Input[dict]) – A github_configuration block as defined below.
identity (pulumi.Input[dict]) – An identity block as defined below.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vsts_configuration (pulumi.Input[dict]) – A vsts_configuration block as defined below.

The github_configuration object supports the following:

account_name (pulumi.Input[str]) - Specifies the GitHub account name.
branchName (pulumi.Input[str]) - Specifies the branch of the repository to get code from.
gitUrl (pulumi.Input[str]) - Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.
repositoryName (pulumi.Input[str]) - Specifies the name of the git repository.
rootFolder (pulumi.Input[str]) - Specifies the root folder within the repository. Set to / for the top level.

The identity object supports the following:

principal_id (pulumi.Input[str]) - The ID of the Principal (Client) in Azure Active Directory
tenant_id (pulumi.Input[str]) - Specifies the Tenant ID associated with the VSTS account.
type (pulumi.Input[str]) - Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.

The vsts_configuration object supports the following:

account_name (pulumi.Input[str]) - Specifies the VSTS account name.
branchName (pulumi.Input[str]) - Specifies the branch of the repository to get code from.
projectName (pulumi.Input[str]) - Specifies the name of the VSTS project.
repositoryName (pulumi.Input[str]) - Specifies the name of the git repository.
rootFolder (pulumi.Input[str]) - Specifies the root folder within the repository. Set to / for the top level.
tenant_id (pulumi.Input[str]) - Specifies the Tenant ID associated with the VSTS account.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.GetFactoryResult(github_configurations=None, id=None, identities=None, location=None, name=None, resource_group_name=None, tags=None, vsts_configurations=None)¶

A collection of values returned by getFactory.

github_configurations = None¶: A github_configuration block as defined below.

id = None¶: The provider-assigned unique ID for this managed resource.

identities = None¶: An identity block as defined below.

location = None¶: The Azure location where the resource exists.

tags = None¶

vsts_configurations = None¶: A vsts_configuration block as defined below.

class pulumi_azure.datafactory.IntegrationRuntimeManaged(resource_name, opts=None, catalog_info=None, custom_setup_script=None, data_factory_name=None, description=None, edition=None, license_type=None, location=None, max_parallel_executions_per_node=None, name=None, node_size=None, number_of_nodes=None, resource_group_name=None, vnet_integration=None, __props__=None, __name__=None, __opts__=None)¶

Manages an Azure Data Factory Managed Integration Runtime.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_integration_runtime_managed = azure.datafactory.IntegrationRuntimeManaged("exampleIntegrationRuntimeManaged",
    data_factory_name=example_factory.name,
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    node_size="Standard_D8_v3")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
catalog_info (pulumi.Input[dict]) – A catalog_info block as defined below.
custom_setup_script (pulumi.Input[dict]) – A custom_setup_script block as defined below.
data_factory_name (pulumi.Input[str]) – Specifies the name of the Data Factory the Managed Integration Runtime belongs to. Changing this forces a new resource to be created.
edition (pulumi.Input[str]) – The Managed Integration Runtime edition. Valid values are Standard and Enterprise. Defaults to Standard.
license_type (pulumi.Input[str]) – The type of the license that is used. Valid values are LicenseIncluded and BasePrize. Defaults to LicenseIncluded.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
max_parallel_executions_per_node (pulumi.Input[float]) – Defines the maximum parallel executions per node. Defaults to 1. Max is 16.
name (pulumi.Input[str]) –
Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
node_size (pulumi.Input[str]) – The size of the nodes on which the Managed Integration Runtime runs. Valid values are: Standard_D2_v3, Standard_D4_v3, Standard_D8_v3, Standard_D16_v3, Standard_D32_v3, Standard_D64_v3, Standard_E2_v3, Standard_E4_v3, Standard_E8_v3, Standard_E16_v3, Standard_E32_v3, Standard_E64_v3, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_A4_v2 and Standard_A8_v2
number_of_nodes (pulumi.Input[float]) – Number of nodes for the Managed Integration Runtime. Max is 10. Defaults to 1.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Managed Integration Runtime. Changing this forces a new resource to be created.
vnet_integration (pulumi.Input[dict]) – A vnet_integration block as defined below.

The catalog_info object supports the following:

administrator_login (pulumi.Input[str]) - Administrator login name for the SQL Server.
administratorPassword (pulumi.Input[str]) - Administrator login password for the SQL Server.
pricing_tier (pulumi.Input[str]) - Pricing tier for the database that will be created for the SSIS catalog. Valid values are: Basic, Standard, Premium and PremiumRS.
serverEndpoint (pulumi.Input[str]) - The endpoint of an Azure SQL Server that will be used to host the SSIS catalog.

The custom_setup_script object supports the following:

blobContainerUri (pulumi.Input[str]) - The blob endpoint for the container which contains a custom setup script that will be run on every node on startup. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.
sasToken (pulumi.Input[str]) - A container SAS token that gives access to the files. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.

The vnet_integration object supports the following:

subnetName (pulumi.Input[str]) - Name of the subnet to which the nodes of the Managed Integration Runtime will be added.
vnetId (pulumi.Input[str]) - ID of the virtual network to which the nodes of the Managed Integration Runtime will be added.

catalog_info: pulumi.Output[dict] = None¶

A catalog_info block as defined below.

administrator_login (str) - Administrator login name for the SQL Server.
administratorPassword (str) - Administrator login password for the SQL Server.
pricing_tier (str) - Pricing tier for the database that will be created for the SSIS catalog. Valid values are: Basic, Standard, Premium and PremiumRS.
serverEndpoint (str) - The endpoint of an Azure SQL Server that will be used to host the SSIS catalog.

custom_setup_script: pulumi.Output[dict] = None¶

A custom_setup_script block as defined below.

blobContainerUri (str) - The blob endpoint for the container which contains a custom setup script that will be run on every node on startup. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.
sasToken (str) - A container SAS token that gives access to the files. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.

data_factory_name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory the Managed Integration Runtime belongs to. Changing this forces a new resource to be created.

edition: pulumi.Output[str] = None¶: The Managed Integration Runtime edition. Valid values are Standard and Enterprise. Defaults to Standard.

license_type: pulumi.Output[str] = None¶: The type of the license that is used. Valid values are LicenseIncluded and BasePrize. Defaults to LicenseIncluded.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

max_parallel_executions_per_node: pulumi.Output[float] = None¶: Defines the maximum parallel executions per node. Defaults to 1. Max is 16.

name: pulumi.Output[str] = None¶: Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

node_size: pulumi.Output[str] = None¶: The size of the nodes on which the Managed Integration Runtime runs. Valid values are: Standard_D2_v3, Standard_D4_v3, Standard_D8_v3, Standard_D16_v3, Standard_D32_v3, Standard_D64_v3, Standard_E2_v3, Standard_E4_v3, Standard_E8_v3, Standard_E16_v3, Standard_E32_v3, Standard_E64_v3, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_A4_v2 and Standard_A8_v2

number_of_nodes: pulumi.Output[float] = None¶: Number of nodes for the Managed Integration Runtime. Max is 10. Defaults to 1.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Managed Integration Runtime. Changing this forces a new resource to be created.

vnet_integration: pulumi.Output[dict] = None¶

A vnet_integration block as defined below.

subnetName (str) - Name of the subnet to which the nodes of the Managed Integration Runtime will be added.
vnetId (str) - ID of the virtual network to which the nodes of the Managed Integration Runtime will be added.

static get(resource_name, id, opts=None, catalog_info=None, custom_setup_script=None, data_factory_name=None, description=None, edition=None, license_type=None, location=None, max_parallel_executions_per_node=None, name=None, node_size=None, number_of_nodes=None, resource_group_name=None, vnet_integration=None)¶

Get an existing IntegrationRuntimeManaged resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
catalog_info (pulumi.Input[dict]) – A catalog_info block as defined below.
custom_setup_script (pulumi.Input[dict]) – A custom_setup_script block as defined below.
data_factory_name (pulumi.Input[str]) – Specifies the name of the Data Factory the Managed Integration Runtime belongs to. Changing this forces a new resource to be created.
edition (pulumi.Input[str]) – The Managed Integration Runtime edition. Valid values are Standard and Enterprise. Defaults to Standard.
license_type (pulumi.Input[str]) – The type of the license that is used. Valid values are LicenseIncluded and BasePrize. Defaults to LicenseIncluded.
location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
max_parallel_executions_per_node (pulumi.Input[float]) – Defines the maximum parallel executions per node. Defaults to 1. Max is 16.
name (pulumi.Input[str]) –
Specifies the name of the Managed Integration Runtime. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
node_size (pulumi.Input[str]) – The size of the nodes on which the Managed Integration Runtime runs. Valid values are: Standard_D2_v3, Standard_D4_v3, Standard_D8_v3, Standard_D16_v3, Standard_D32_v3, Standard_D64_v3, Standard_E2_v3, Standard_E4_v3, Standard_E8_v3, Standard_E16_v3, Standard_E32_v3, Standard_E64_v3, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_A4_v2 and Standard_A8_v2
number_of_nodes (pulumi.Input[float]) – Number of nodes for the Managed Integration Runtime. Max is 10. Defaults to 1.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Managed Integration Runtime. Changing this forces a new resource to be created.
vnet_integration (pulumi.Input[dict]) – A vnet_integration block as defined below.

The catalog_info object supports the following:

administrator_login (pulumi.Input[str]) - Administrator login name for the SQL Server.
administratorPassword (pulumi.Input[str]) - Administrator login password for the SQL Server.
pricing_tier (pulumi.Input[str]) - Pricing tier for the database that will be created for the SSIS catalog. Valid values are: Basic, Standard, Premium and PremiumRS.
serverEndpoint (pulumi.Input[str]) - The endpoint of an Azure SQL Server that will be used to host the SSIS catalog.

The custom_setup_script object supports the following:

blobContainerUri (pulumi.Input[str]) - The blob endpoint for the container which contains a custom setup script that will be run on every node on startup. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.
sasToken (pulumi.Input[str]) - A container SAS token that gives access to the files. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.

The vnet_integration object supports the following:

subnetName (pulumi.Input[str]) - Name of the subnet to which the nodes of the Managed Integration Runtime will be added.
vnetId (pulumi.Input[str]) - ID of the virtual network to which the nodes of the Managed Integration Runtime will be added.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.IntegrationRuntimeSelfHosted(resource_name, opts=None, data_factory_name=None, description=None, name=None, rbac_authorizations=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Data Factory Self-host Integration Runtime.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_integration_runtime_self_hosted = azure.datafactory.IntegrationRuntimeSelfHosted("exampleIntegrationRuntimeSelfHosted",
    resource_group_name="example",
    data_factory_name="example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
data_factory_name (pulumi.Input[str]) – Changing this forces a new Data Factory to be created.
description (pulumi.Input[str]) – Integration runtime description.
name (pulumi.Input[str]) – The name which should be used for this Data Factory. Changing this forces a new Data Factory to be created.
rbac_authorizations (pulumi.Input[list]) – A rbac_authorization block as defined below.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Data Factory should exist. Changing this forces a new Data Factory to be created.

The rbac_authorizations object supports the following:

resource_id (pulumi.Input[str]) - The resource identifier of the integration runtime to be shared. Changing this forces a new Data Factory to be created.

auth_key1: pulumi.Output[str] = None¶: The primary integration runtime authentication key.

auth_key2: pulumi.Output[str] = None¶: The secondary integration runtime authentication key.

data_factory_name: pulumi.Output[str] = None¶: Changing this forces a new Data Factory to be created.

description: pulumi.Output[str] = None¶: Integration runtime description.

name: pulumi.Output[str] = None¶: The name which should be used for this Data Factory. Changing this forces a new Data Factory to be created.

rbac_authorizations: pulumi.Output[list] = None¶

A rbac_authorization block as defined below.

resource_id (str) - The resource identifier of the integration runtime to be shared. Changing this forces a new Data Factory to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group where the Data Factory should exist. Changing this forces a new Data Factory to be created.

static get(resource_name, id, opts=None, auth_key1=None, auth_key2=None, data_factory_name=None, description=None, name=None, rbac_authorizations=None, resource_group_name=None)¶

Get an existing IntegrationRuntimeSelfHosted resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
auth_key1 (pulumi.Input[str]) – The primary integration runtime authentication key.
auth_key2 (pulumi.Input[str]) – The secondary integration runtime authentication key.
data_factory_name (pulumi.Input[str]) – Changing this forces a new Data Factory to be created.
description (pulumi.Input[str]) – Integration runtime description.
name (pulumi.Input[str]) – The name which should be used for this Data Factory. Changing this forces a new Data Factory to be created.
rbac_authorizations (pulumi.Input[list]) – A rbac_authorization block as defined below.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group where the Data Factory should exist. Changing this forces a new Data Factory to be created.

The rbac_authorizations object supports the following:

resource_id (pulumi.Input[str]) - The resource identifier of the integration runtime to be shared. Changing this forces a new Data Factory to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.LinkedServiceDataLakeStorageGen2(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, service_principal_id=None, service_principal_key=None, tenant=None, url=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Linked Service (connection) between Data Lake Storage Gen2 and Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
current = azure.core.get_client_config()
example_linked_service_data_lake_storage_gen2 = azure.datafactory.LinkedServiceDataLakeStorageGen2("exampleLinkedServiceDataLakeStorageGen2",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    service_principal_id=current.client_id,
    service_principal_key="exampleKey",
    tenant="11111111-1111-1111-1111-111111111111",
    url="https://datalakestoragegen2")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service MySQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service MySQL.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service MySQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
service_principal_id (pulumi.Input[str]) – The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
service_principal_key (pulumi.Input[str]) – The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
tenant (pulumi.Input[str]) – The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
url (pulumi.Input[str]) – The endpoint for the Azure Data Lake Storage Gen2 service.

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Linked Service MySQL.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Linked Service MySQL.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Linked Service MySQL.

integration_runtime_name: pulumi.Output[str] = None¶: The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Linked Service MySQL.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource

service_principal_id: pulumi.Output[str] = None¶: The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.

service_principal_key: pulumi.Output[str] = None¶: The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.

tenant: pulumi.Output[str] = None¶: The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.

url: pulumi.Output[str] = None¶: The endpoint for the Azure Data Lake Storage Gen2 service.

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, service_principal_id=None, service_principal_key=None, tenant=None, url=None)¶

Get an existing LinkedServiceDataLakeStorageGen2 resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service MySQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service MySQL.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service MySQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource
service_principal_id (pulumi.Input[str]) – The service principal id in which to authenticate against the Azure Data Lake Storage Gen2 account.
service_principal_key (pulumi.Input[str]) – The service principal key in which to authenticate against the Azure Data Lake Storage Gen2 account.
tenant (pulumi.Input[str]) – The tenant id or name in which to authenticate against the Azure Data Lake Storage Gen2 account.
url (pulumi.Input[str]) – The endpoint for the Azure Data Lake Storage Gen2 service.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.LinkedServiceKeyVault(resource_name, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, key_vault_id=None, name=None, parameters=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Linked Service (connection) between Key Vault and Azure Data Factory.

import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="eastus")
example_key_vault = azure.keyvault.KeyVault("exampleKeyVault",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    tenant_id=current.tenant_id,
    sku_name="standard")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_key_vault = azure.datafactory.LinkedServiceKeyVault("exampleLinkedServiceKeyVault",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    key_vault_id=example_key_vault.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service Key Vault.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service Key Vault.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service Key Vault.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
key_vault_id (pulumi.Input[str]) – The ID the Azure Key Vault resource.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service Key Vault.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Linked Service Key Vault.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Linked Service Key Vault.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Linked Service Key Vault.

integration_runtime_name: pulumi.Output[str] = None¶: The integration runtime reference to associate with the Data Factory Linked Service Key Vault.

key_vault_id: pulumi.Output[str] = None¶: The ID the Azure Key Vault resource.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Linked Service Key Vault.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, data_factory_name=None, description=None, integration_runtime_name=None, key_vault_id=None, name=None, parameters=None, resource_group_name=None)¶

Get an existing LinkedServiceKeyVault resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service Key Vault.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service Key Vault.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service Key Vault.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service Key Vault.
key_vault_id (pulumi.Input[str]) – The ID the Azure Key Vault resource.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service Key Vault. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service Key Vault.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service Key Vault. Changing this forces a new resource

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.LinkedServiceMysql(resource_name, opts=None, additional_properties=None, annotations=None, connection_string=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Linked Service (connection) between MySQL and Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_mysql = azure.datafactory.LinkedServiceMysql("exampleLinkedServiceMysql",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Server=test;Port=3306;Database=test;User=test;SSLMode=1;UseSystemTrustStore=0;Password=test")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service MySQL.
connection_string (pulumi.Input[str]) – The connection string in which to authenticate with MySQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service MySQL.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service MySQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Linked Service MySQL.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Linked Service MySQL.

connection_string: pulumi.Output[str] = None¶: The connection string in which to authenticate with MySQL.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Linked Service MySQL.

integration_runtime_name: pulumi.Output[str] = None¶: The integration runtime reference to associate with the Data Factory Linked Service MySQL.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Linked Service MySQL.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource

static get(resource_name, id, opts=None, additional_properties=None, annotations=None, connection_string=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None)¶

Get an existing LinkedServiceMysql resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service MySQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service MySQL.
connection_string (pulumi.Input[str]) – The connection string in which to authenticate with MySQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service MySQL.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service MySQL.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service MySQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service MySQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service MySQL. Changing this forces a new resource

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.LinkedServicePostgresql(resource_name, opts=None, additional_properties=None, annotations=None, connection_string=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Linked Service (connection) between PostgreSQL and Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_postgresql = azure.datafactory.LinkedServicePostgresql("exampleLinkedServicePostgresql",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Host=example;Port=5432;Database=example;UID=example;EncryptionMethod=0;Password=example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
connection_string (pulumi.Input[str]) – The connection string in which to authenticate with PostgreSQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service PostgreSQL.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service PostgreSQL. Changing this forces a new resource

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.

connection_string: pulumi.Output[str] = None¶: The connection string in which to authenticate with PostgreSQL.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Linked Service PostgreSQL.

integration_runtime_name: pulumi.Output[str] = None¶: The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Linked Service PostgreSQL.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Linked Service PostgreSQL. Changing this forces a new resource

Get an existing LinkedServicePostgresql resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service PostgreSQL.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service PostgreSQL.
connection_string (pulumi.Input[str]) – The connection string in which to authenticate with PostgreSQL.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service PostgreSQL.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service PostgreSQL.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service PostgreSQL. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service PostgreSQL.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service PostgreSQL. Changing this forces a new resource

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.LinkedServiceSqlServer(resource_name, opts=None, additional_properties=None, annotations=None, connection_string=None, data_factory_name=None, description=None, integration_runtime_name=None, name=None, parameters=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Linked Service (connection) between a SQL Server and Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_linked_service_sql_server = azure.datafactory.LinkedServiceSqlServer("exampleLinkedServiceSqlServer",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name,
    connection_string="Integrated Security=False;Data Source=test;Initial Catalog=test;User ID=test;Password=test")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service SQL Server.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service SQL Server.
connection_string (pulumi.Input[str]) – The connection string in which to authenticate with the SQL Server.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service SQL Server.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service SQL Server. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service SQL Server.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service SQL Server. Changing this forces a new resource

additional_properties: pulumi.Output[dict] = None¶: A map of additional properties to associate with the Data Factory Linked Service SQL Server.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Linked Service SQL Server.

connection_string: pulumi.Output[str] = None¶: The connection string in which to authenticate with the SQL Server.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Linked Service SQL Server.

integration_runtime_name: pulumi.Output[str] = None¶: The integration runtime reference to associate with the Data Factory Linked Service SQL Server.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Linked Service SQL Server. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Linked Service SQL Server.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Linked Service SQL Server. Changing this forces a new resource

Get an existing LinkedServiceSqlServer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
additional_properties (pulumi.Input[dict]) – A map of additional properties to associate with the Data Factory Linked Service SQL Server.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Linked Service SQL Server.
connection_string (pulumi.Input[str]) – The connection string in which to authenticate with the SQL Server.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Linked Service with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Linked Service SQL Server.
integration_runtime_name (pulumi.Input[str]) – The integration runtime reference to associate with the Data Factory Linked Service SQL Server.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Linked Service SQL Server. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Linked Service SQL Server.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Linked Service SQL Server. Changing this forces a new resource

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.Pipeline(resource_name, opts=None, activities_json=None, annotations=None, data_factory_name=None, description=None, name=None, parameters=None, resource_group_name=None, variables=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Pipeline inside a Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_pipeline = azure.datafactory.Pipeline("examplePipeline",
    resource_group_name=example_resource_group.name,
    data_factory_name=example_factory.name)

import pulumi
import pulumi_azure as azure

test = azure.datafactory.Pipeline("test",
    resource_group_name=azurerm_resource_group["test"]["name"],
    data_factory_name=azurerm_data_factory["test"]["name"],
    variables={
        "bob": "item1",
    },
    activities_json="""[
        {
                "name": "Append variable1",
                "type": "AppendVariable",
                "dependsOn": [],
                "userProperties": [],
                "typeProperties": {
                        "variableName": "bob",
                        "value": "something"
                }
        }
]
""")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
activities_json (pulumi.Input[str]) – A JSON object that contains the activities that will be associated with the Data Factory Pipeline.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Pipeline.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Pipeline.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Pipeline.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource
variables (pulumi.Input[dict]) – A map of variables to associate with the Data Factory Pipeline.

activities_json: pulumi.Output[str] = None¶: A JSON object that contains the activities that will be associated with the Data Factory Pipeline.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Pipeline.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.

description: pulumi.Output[str] = None¶: The description for the Data Factory Pipeline.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

parameters: pulumi.Output[dict] = None¶: A map of parameters to associate with the Data Factory Pipeline.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource

variables: pulumi.Output[dict] = None¶: A map of variables to associate with the Data Factory Pipeline.

static get(resource_name, id, opts=None, activities_json=None, annotations=None, data_factory_name=None, description=None, name=None, parameters=None, resource_group_name=None, variables=None)¶

Get an existing Pipeline resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
activities_json (pulumi.Input[str]) – A JSON object that contains the activities that will be associated with the Data Factory Pipeline.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Pipeline.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Pipeline with. Changing this forces a new resource.
description (pulumi.Input[str]) – The description for the Data Factory Pipeline.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Pipeline. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
parameters (pulumi.Input[dict]) – A map of parameters to associate with the Data Factory Pipeline.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Pipeline. Changing this forces a new resource
variables (pulumi.Input[dict]) – A map of variables to associate with the Data Factory Pipeline.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.datafactory.TriggerSchedule(resource_name, opts=None, annotations=None, data_factory_name=None, end_time=None, frequency=None, interval=None, name=None, pipeline_name=None, pipeline_parameters=None, resource_group_name=None, start_time=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Trigger Schedule inside a Azure Data Factory.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
example_factory = azure.datafactory.Factory("exampleFactory",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
test_pipeline = azure.datafactory.Pipeline("testPipeline",
    resource_group_name=azurerm_resource_group["test"]["name"],
    data_factory_name=azurerm_data_factory["test"]["name"])
test_trigger_schedule = azure.datafactory.TriggerSchedule("testTriggerSchedule",
    data_factory_name=azurerm_data_factory["test"]["name"],
    resource_group_name=azurerm_resource_group["test"]["name"],
    pipeline_name=test_pipeline.name,
    interval=5,
    frequency="Day")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Schedule Trigger.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
end_time (pulumi.Input[str]) – The time the Schedule Trigger should end. The time will be represented in UTC.
frequency (pulumi.Input[str]) – The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
interval (pulumi.Input[float]) – The interval for how often the trigger occurs. This defaults to 1.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
pipeline_name (pulumi.Input[str]) – The Data Factory Pipeline name that the trigger will act on.
pipeline_parameters (pulumi.Input[dict]) – The pipeline parameters that the trigger will act upon.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
start_time (pulumi.Input[str]) – The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

annotations: pulumi.Output[list] = None¶: List of tags that can be used for describing the Data Factory Schedule Trigger.

data_factory_name: pulumi.Output[str] = None¶: The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.

end_time: pulumi.Output[str] = None¶: The time the Schedule Trigger should end. The time will be represented in UTC.

frequency: pulumi.Output[str] = None¶: The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.

interval: pulumi.Output[float] = None¶: The interval for how often the trigger occurs. This defaults to 1.

name: pulumi.Output[str] = None¶: Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.

pipeline_name: pulumi.Output[str] = None¶: The Data Factory Pipeline name that the trigger will act on.

pipeline_parameters: pulumi.Output[dict] = None¶: The pipeline parameters that the trigger will act upon.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource

start_time: pulumi.Output[str] = None¶: The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

static get(resource_name, id, opts=None, annotations=None, data_factory_name=None, end_time=None, frequency=None, interval=None, name=None, pipeline_name=None, pipeline_parameters=None, resource_group_name=None, start_time=None)¶

Get an existing TriggerSchedule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
annotations (pulumi.Input[list]) – List of tags that can be used for describing the Data Factory Schedule Trigger.
data_factory_name (pulumi.Input[str]) – The Data Factory name in which to associate the Schedule Trigger with. Changing this forces a new resource.
end_time (pulumi.Input[str]) – The time the Schedule Trigger should end. The time will be represented in UTC.
frequency (pulumi.Input[str]) – The trigger freqency. Valid values include Minute, Hour, Day, Week, Month. Defaults to Minute.
interval (pulumi.Input[float]) – The interval for how often the trigger occurs. This defaults to 1.
name (pulumi.Input[str]) –
Specifies the name of the Data Factory Schedule Trigger. Changing this forces a new resource to be created. Must be globally unique. See the Microsoft documentation for all restrictions.
pipeline_name (pulumi.Input[str]) – The Data Factory Pipeline name that the trigger will act on.
pipeline_parameters (pulumi.Input[dict]) – The pipeline parameters that the trigger will act upon.
resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Data Factory Schedule Trigger. Changing this forces a new resource
start_time (pulumi.Input[str]) – The time the Schedule Trigger will start. This defaults to the current time. The time will be represented in UTC.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.datafactory.get_factory(name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Azure Data Factory (Version 2).

import pulumi
import pulumi_azure as azure

example = azure.datafactory.get_factory(name=azurerm_data_factory["example"]["name"],
    resource_group_name=azurerm_data_factory["example"]["resource_group_name"])
pulumi.export("dataFactoryId", azurerm_data_factory["example"]["id"])

Parameters

name (str) – Specifies the name of the Data Factory to retrieve information about.
resource_group_name (str) – The name of the resource group where the Data Factory exists.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

datafactory¶

On This Page