az datafactory

Note

This reference is part of the datafactory extension for Azure CLI and requires version 2.15.0 or higher. The extension will automatically install the first time you run an az datafactory command. Learn more about extensions.

Manage Data Factory.

Commands

az datafactory activity-run

Manage activity run with datafactory.

az datafactory activity-run query-by-pipeline-run

Query activity runs based on input filter conditions.

az datafactory configure-factory-repo

Updates a factory's repo information.

az datafactory create

Create a factory.

az datafactory dataset

Manage dataset with datafactory.

az datafactory dataset create

Create a dataset.

az datafactory dataset delete

Deletes a dataset.

az datafactory dataset list

Lists datasets.

az datafactory dataset show

Gets a dataset.

az datafactory dataset update

Update a dataset.

az datafactory delete

Deletes a factory.

az datafactory get-data-plane-access

Get Data Plane access.

az datafactory get-git-hub-access-token

Get GitHub Access Token.

az datafactory integration-runtime

Manage integration runtime with datafactory.

az datafactory integration-runtime delete

Deletes an integration runtime.

az datafactory integration-runtime get-connection-info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

az datafactory integration-runtime get-monitoring-data

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

az datafactory integration-runtime get-status

Gets detailed status information for an integration runtime.

az datafactory integration-runtime linked-integration-runtime

Manage integration runtime with datafactory sub group linked-integration-runtime.

az datafactory integration-runtime linked-integration-runtime create

Create a linked integration runtime entry in a shared integration runtime.

az datafactory integration-runtime list

Lists integration runtimes.

az datafactory integration-runtime list-auth-key

Retrieves the authentication keys for an integration runtime.

az datafactory integration-runtime managed

Manage integration runtime with datafactory sub group managed.

az datafactory integration-runtime managed create

Create an integration runtime.

az datafactory integration-runtime regenerate-auth-key

Regenerates the authentication key for an integration runtime.

az datafactory integration-runtime remove-link

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

az datafactory integration-runtime self-hosted

Manage integration runtime with datafactory sub group self-hosted.

az datafactory integration-runtime self-hosted create

Create an integration runtime.

az datafactory integration-runtime show

Gets an integration runtime.

az datafactory integration-runtime start

Starts a ManagedReserved type integration runtime.

az datafactory integration-runtime stop

Stops a ManagedReserved type integration runtime.

az datafactory integration-runtime sync-credentials

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

az datafactory integration-runtime update

Updates an integration runtime.

az datafactory integration-runtime upgrade

Upgrade self-hosted integration runtime to latest version if availability.

az datafactory integration-runtime wait

Place the CLI in a waiting state until a condition of the datafactory integration-runtime is met.

az datafactory integration-runtime-node

Manage integration runtime node with datafactory.

az datafactory integration-runtime-node delete

Deletes a self-hosted integration runtime node.

az datafactory integration-runtime-node get-ip-address

Get the IP address of self-hosted integration runtime node.

az datafactory integration-runtime-node show

Gets a self-hosted integration runtime node.

az datafactory integration-runtime-node update

Updates a self-hosted integration runtime node.

az datafactory linked-service

Manage linked service with datafactory.

az datafactory linked-service create

Create a linked service.

az datafactory linked-service delete

Deletes a linked service.

az datafactory linked-service list

Lists linked services.

az datafactory linked-service show

Gets a linked service.

az datafactory linked-service update

Update a linked service.

az datafactory list

Lists factories. And Lists factories under the specified subscription.

az datafactory managed-private-endpoint

Manage managed private endpoint with datafactory.

az datafactory managed-private-endpoint create

Create a managed private endpoint.

az datafactory managed-private-endpoint delete

Deletes a managed private endpoint.

az datafactory managed-private-endpoint list

Lists managed private endpoints.

az datafactory managed-private-endpoint show

Gets a managed private endpoint.

az datafactory managed-private-endpoint update

Update a managed private endpoint.

az datafactory managed-virtual-network

Manage managed virtual network with datafactory.

az datafactory managed-virtual-network create

Create a managed Virtual Network.

az datafactory managed-virtual-network list

Lists managed Virtual Networks.

az datafactory managed-virtual-network show

Gets a managed Virtual Network.

az datafactory managed-virtual-network update

Update a managed Virtual Network.

az datafactory pipeline

Manage pipeline with datafactory.

az datafactory pipeline create

Create a pipeline.

az datafactory pipeline create-run

Creates a run of a pipeline.

az datafactory pipeline delete

Deletes a pipeline.

az datafactory pipeline list

Lists pipelines.

az datafactory pipeline show

Gets a pipeline.

az datafactory pipeline update

Update a pipeline.

az datafactory pipeline-run

Manage pipeline run with datafactory.

az datafactory pipeline-run cancel

Cancel a pipeline run by its run ID.

az datafactory pipeline-run query-by-factory

Query pipeline runs in the factory based on input filter conditions.

az datafactory pipeline-run show

Get a pipeline run by its run ID.

az datafactory show

Gets a factory.

az datafactory trigger

Manage trigger with datafactory.

az datafactory trigger create

Create a trigger.

az datafactory trigger delete

Deletes a trigger.

az datafactory trigger get-event-subscription-status

Get a trigger's event subscription status.

az datafactory trigger list

Lists triggers.

az datafactory trigger query-by-factory

Query triggers.

az datafactory trigger show

Gets a trigger.

az datafactory trigger start

Starts a trigger.

az datafactory trigger stop

Stops a trigger.

az datafactory trigger subscribe-to-event

Subscribe event trigger to events.

az datafactory trigger unsubscribe-from-event

Unsubscribe event trigger from events.

az datafactory trigger update

Update a trigger.

az datafactory trigger wait

Place the CLI in a waiting state until a condition of the datafactory trigger is met.

az datafactory trigger-run

Manage trigger run with datafactory.

az datafactory trigger-run cancel

Cancel a single trigger instance by runId.

az datafactory trigger-run query-by-factory

Query trigger runs.

az datafactory trigger-run rerun

Rerun single trigger instance by runId.

az datafactory update

Updates a factory.

az datafactory configure-factory-repo

Updates a factory's repo information.

az datafactory configure-factory-repo --location
                                      [--factory-git-hub-configuration]
                                      [--factory-resource-id]
                                      [--factory-vsts-configuration]

Examples

Factories_ConfigureFactoryRepo

az datafactory configure-factory-repo --factory-resource-id "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName" --factory-vsts-configuration account-name="ADF" collaboration-branch="master" last-commit-id="" project-name="project" repository-name="repo" root-folder="/" tenant-id="" --location "East US"

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Optional Parameters

--factory-git-hub-configuration --github-config

Factory's GitHub repo information.

--factory-resource-id

The factory resource id.

--factory-vsts-configuration --vsts-config

Factory's VSTS repo information.

az datafactory create

Create a factory.

az datafactory create --factory-name
                      --resource-group
                      [--factory-git-hub-configuration]
                      [--factory-vsts-configuration]
                      [--global-parameters]
                      [--if-match]
                      [--location]
                      [--tags]

Examples

Factories_CreateOrUpdate

az datafactory create --location "East US" --name "exampleFactoryName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name --name -n

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--factory-git-hub-configuration --github-config

Factory's GitHub repo information.

--factory-vsts-configuration --vsts-config

Factory's VSTS repo information.

--global-parameters

List of parameters for factory. Expected value: json-string/json-file/@json-file.

--if-match

ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az datafactory delete

Deletes a factory.

az datafactory delete --factory-name
                      --resource-group
                      [--yes]

Examples

Factories_Delete

az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name --name -n

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--yes -y

Do not prompt for confirmation.

az datafactory get-data-plane-access

Get Data Plane access.

az datafactory get-data-plane-access --factory-name
                                     --resource-group
                                     [--access-resource-path]
                                     [--expire-time]
                                     [--permissions]
                                     [--profile-name]
                                     [--start-time]

Examples

Factories_GetDataPlaneAccess

az datafactory get-data-plane-access --name "exampleFactoryName" --access-resource-path "" --expire-time "2018-11-10T09:46:20.2659347Z" --permissions "r" --profile-name "DefaultProfile" --start-time "2018-11-10T02:46:20.2659347Z" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name --name -n

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--access-resource-path

The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource.

--expire-time

Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours.

--permissions

The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access.

--profile-name

The name of the profile. Currently only the default is supported. The default value is DefaultProfile.

--start-time

Start time for the token. If not specified the current time will be used.

az datafactory get-git-hub-access-token

Get GitHub Access Token.

az datafactory get-git-hub-access-token --factory-name
                                        --git-hub-access-code
                                        --git-hub-access-token-base-url
                                        --resource-group
                                        [--git-hub-client-id]

Examples

Factories_GetGitHubAccessToken

az datafactory get-git-hub-access-token --name "exampleFactoryName" --git-hub-access-code "some" --git-hub-access-token-base-url "some" --git-hub-client-id "some" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name --name -n

The factory name.

--git-hub-access-code

GitHub access code.

--git-hub-access-token-base-url

GitHub access token base URL.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--git-hub-client-id

GitHub application client ID.

az datafactory list

Lists factories. And Lists factories under the specified subscription.

az datafactory list [--resource-group]

Examples

Factories_ListByResourceGroup

az datafactory list --resource-group "exampleResourceGroup"

Factories_List

az datafactory list

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az datafactory show

Gets a factory.

az datafactory show --factory-name
                    --resource-group
                    [--if-none-match]

Examples

Factories_Get

az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name --name -n

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--if-none-match

ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

az datafactory update

Updates a factory.

az datafactory update --factory-name
                      --resource-group
                      [--tags]

Examples

Factories_Update

az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name --name -n

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.