az datafactory
Note
This reference is part of the datafactory extension for the Azure CLI (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
| Name | Description | Type | Status |
|---|---|---|---|
| az datafactory activity-run |
Manage activity run with datafactory. |
Extension | GA |
| az datafactory activity-run query-by-pipeline-run |
Query activity runs based on input filter conditions. |
Extension | GA |
| az datafactory configure-factory-repo |
Updates a factory's repo information. |
Extension | GA |
| az datafactory create |
Create a factory. |
Extension | GA |
| az datafactory data-flow |
Managing and configuring Data Flows in Azure Data Factory. |
Extension | GA |
| az datafactory data-flow create |
Creates a data flow within a factory. |
Extension | GA |
| az datafactory data-flow delete |
Delete a specific data flow in a given factory. |
Extension | GA |
| az datafactory data-flow list |
List data flows within a provided factory. |
Extension | GA |
| az datafactory data-flow show |
Show information about the specified data flow. |
Extension | GA |
| az datafactory data-flow update |
Updates a specified data flow within a factory. |
Extension | GA |
| az datafactory dataset |
Manage dataset with datafactory. |
Extension | GA |
| az datafactory dataset create |
Create a dataset. |
Extension | GA |
| az datafactory dataset delete |
Deletes a dataset. |
Extension | GA |
| az datafactory dataset list |
Lists datasets. |
Extension | GA |
| az datafactory dataset show |
Gets a dataset. |
Extension | GA |
| az datafactory dataset update |
Update a dataset. |
Extension | GA |
| az datafactory delete |
Deletes a factory. |
Extension | GA |
| az datafactory get-data-plane-access |
Get Data Plane access. |
Extension | GA |
| az datafactory get-git-hub-access-token |
Get GitHub Access Token. |
Extension | GA |
| az datafactory integration-runtime |
Manage integration runtime with datafactory. |
Extension | GA |
| az datafactory integration-runtime-node |
Manage integration runtime node with datafactory. |
Extension | GA |
| az datafactory integration-runtime-node delete |
Deletes a self-hosted integration runtime node. |
Extension | GA |
| az datafactory integration-runtime-node get-ip-address |
Get the IP address of self-hosted integration runtime node. |
Extension | GA |
| az datafactory integration-runtime-node show |
Gets a self-hosted integration runtime node. |
Extension | GA |
| az datafactory integration-runtime-node update |
Updates a self-hosted integration runtime node. |
Extension | GA |
| az datafactory integration-runtime delete |
Deletes an integration runtime. |
Extension | GA |
| az datafactory integration-runtime get-connection-info |
Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials. |
Extension | GA |
| 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. |
Extension | GA |
| az datafactory integration-runtime get-status |
Gets detailed status information for an integration runtime. |
Extension | GA |
| az datafactory integration-runtime linked-integration-runtime |
Manage integration runtime with datafactory sub group linked-integration-runtime. |
Extension | GA |
| az datafactory integration-runtime linked-integration-runtime create |
Create a linked integration runtime entry in a shared integration runtime. |
Extension | GA |
| az datafactory integration-runtime list |
Lists integration runtimes. |
Extension | GA |
| az datafactory integration-runtime list-auth-key |
Retrieves the authentication keys for an integration runtime. |
Extension | GA |
| az datafactory integration-runtime managed |
Manage integration runtime with datafactory sub group managed. |
Extension | GA |
| az datafactory integration-runtime managed create |
Create an integration runtime. |
Extension | GA |
| az datafactory integration-runtime regenerate-auth-key |
Regenerates the authentication key for an integration runtime. |
Extension | GA |
| az datafactory integration-runtime remove-link |
Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime. |
Extension | GA |
| az datafactory integration-runtime self-hosted |
Manage integration runtime with datafactory sub group self-hosted. |
Extension | GA |
| az datafactory integration-runtime self-hosted create |
Create an integration runtime. |
Extension | GA |
| az datafactory integration-runtime show |
Gets an integration runtime. |
Extension | GA |
| az datafactory integration-runtime start |
Starts a ManagedReserved type integration runtime. |
Extension | GA |
| az datafactory integration-runtime stop |
Stops a ManagedReserved type integration runtime. |
Extension | GA |
| 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. |
Extension | GA |
| az datafactory integration-runtime update |
Updates an integration runtime. |
Extension | GA |
| az datafactory integration-runtime upgrade |
Upgrade self-hosted integration runtime to latest version if availability. |
Extension | GA |
| az datafactory integration-runtime wait |
Place the CLI in a waiting state until a condition of the datafactory integration-runtime is met. |
Extension | GA |
| az datafactory linked-service |
Manage linked service with datafactory. |
Extension | GA |
| az datafactory linked-service create |
Create a linked service. |
Extension | GA |
| az datafactory linked-service delete |
Deletes a linked service. |
Extension | GA |
| az datafactory linked-service list |
Lists linked services. |
Extension | GA |
| az datafactory linked-service show |
Gets a linked service. |
Extension | GA |
| az datafactory linked-service update |
Update a linked service. |
Extension | GA |
| az datafactory list |
Lists factories. And Lists factories under the specified subscription. |
Extension | GA |
| az datafactory managed-private-endpoint |
Manage managed private endpoint with datafactory. |
Extension | Preview |
| az datafactory managed-private-endpoint create |
Create a managed private endpoint. |
Extension | Preview |
| az datafactory managed-private-endpoint delete |
Deletes a managed private endpoint. |
Extension | Preview |
| az datafactory managed-private-endpoint list |
Lists managed private endpoints. |
Extension | Preview |
| az datafactory managed-private-endpoint show |
Gets a managed private endpoint. |
Extension | Preview |
| az datafactory managed-private-endpoint update |
Update a managed private endpoint. |
Extension | Preview |
| az datafactory managed-virtual-network |
Manage managed virtual network with datafactory. |
Extension | Preview |
| az datafactory managed-virtual-network create |
Create a managed Virtual Network. |
Extension | Preview |
| az datafactory managed-virtual-network list |
Lists managed Virtual Networks. |
Extension | Preview |
| az datafactory managed-virtual-network show |
Gets a managed Virtual Network. |
Extension | Preview |
| az datafactory managed-virtual-network update |
Update a managed Virtual Network. |
Extension | Preview |
| az datafactory pipeline |
Manage pipeline with datafactory. |
Extension | GA |
| az datafactory pipeline-run |
Manage pipeline run with datafactory. |
Extension | GA |
| az datafactory pipeline-run cancel |
Cancel a pipeline run by its run ID. |
Extension | GA |
| az datafactory pipeline-run query-by-factory |
Query pipeline runs in the factory based on input filter conditions. |
Extension | GA |
| az datafactory pipeline-run show |
Get a pipeline run by its run ID. |
Extension | GA |
| az datafactory pipeline create |
Create a pipeline. |
Extension | GA |
| az datafactory pipeline create-run |
Creates a run of a pipeline. |
Extension | GA |
| az datafactory pipeline delete |
Deletes a pipeline. |
Extension | GA |
| az datafactory pipeline list |
Lists pipelines. |
Extension | GA |
| az datafactory pipeline show |
Gets a pipeline. |
Extension | GA |
| az datafactory pipeline update |
Update a pipeline. |
Extension | GA |
| az datafactory show |
Gets a factory. |
Extension | GA |
| az datafactory trigger |
Manage trigger with datafactory. |
Extension | GA |
| az datafactory trigger-run |
Manage trigger run with datafactory. |
Extension | GA |
| az datafactory trigger-run cancel |
Cancel a single trigger instance by runId. |
Extension | GA |
| az datafactory trigger-run query-by-factory |
Query trigger runs. |
Extension | GA |
| az datafactory trigger-run rerun |
Rerun single trigger instance by runId. |
Extension | GA |
| az datafactory trigger create |
Create a trigger. |
Extension | GA |
| az datafactory trigger delete |
Deletes a trigger. |
Extension | GA |
| az datafactory trigger get-event-subscription-status |
Get a trigger's event subscription status. |
Extension | GA |
| az datafactory trigger list |
Lists triggers. |
Extension | GA |
| az datafactory trigger query-by-factory |
Query triggers. |
Extension | GA |
| az datafactory trigger show |
Gets a trigger. |
Extension | GA |
| az datafactory trigger start |
Starts a trigger. |
Extension | GA |
| az datafactory trigger stop |
Stops a trigger. |
Extension | GA |
| az datafactory trigger subscribe-to-event |
Subscribe event trigger to events. |
Extension | GA |
| az datafactory trigger unsubscribe-from-event |
Unsubscribe event trigger from events. |
Extension | GA |
| az datafactory trigger update |
Update a trigger. |
Extension | GA |
| az datafactory trigger wait |
Place the CLI in a waiting state until a condition of the datafactory trigger is met. |
Extension | GA |
| az datafactory update |
Updates a factory. |
Extension | GA |
az datafactory configure-factory-repo
Updates a factory's repo information.
az datafactory configure-factory-repo [--factory-git-hub-configuration]
[--factory-resource-id]
[--factory-vsts-configuration]
[--ids]
[--location]
[--subscription]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"Optional Parameters
Factory's GitHub repo information.
Usage: --factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
host-name: GitHub Enterprise host name. For example: https://github.mydomain.com type: Required. Type of repo configuration. account-name: Required. Account name. repository-name: Required. Repository name. collaboration-branch: Required. Collaboration branch. root-folder: Required. Root folder. last-commit-id: Last commit id.
The factory resource id.
Factory's VSTS repo information.
Usage: --factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
project-name: Required. VSTS project name. tenant-id: VSTS tenant id. type: Required. Type of repo configuration. account-name: Required. Account name. repository-name: Required. Repository name. collaboration-branch: Required. Collaboration branch. root-folder: Required. Root folder. last-commit-id: Last commit id.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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]
[--public-network-access]
[--tags]Examples
Factories_CreateOrUpdate
az datafactory create --location "East US" --name "exampleFactoryName" --resource-group "exampleResourceGroup"Required Parameters
The factory name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Factory's GitHub repo information.
Usage: --factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
host-name: GitHub Enterprise host name. For example: https://github.mydomain.com type: Required. Type of repo configuration. account-name: Required. Account name. repository-name: Required. Repository name. collaboration-branch: Required. Collaboration branch. root-folder: Required. Root folder. last-commit-id: Last commit id.
Factory's VSTS repo information.
Usage: --factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX
project-name: Required. VSTS project name. tenant-id: VSTS tenant id. type: Required. Type of repo configuration. account-name: Required. Account name. repository-name: Required. Repository name. collaboration-branch: Required. Collaboration branch. root-folder: Required. Root folder. last-commit-id: Last commit id.
List of parameters for factory. Expected value: json-string/json-file/@json-file.
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. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Whether or not public network access is allowed for the data factory.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory delete
Deletes a factory.
az datafactory delete [--factory-name]
[--ids]
[--resource-group]
[--subscription]
[--yes]Examples
Factories_Delete
az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"Optional Parameters
The factory name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory get-data-plane-access
Get Data Plane access.
az datafactory get-data-plane-access [--access-resource-path]
[--expire-time]
[--factory-name]
[--ids]
[--permissions]
[--profile-name]
[--resource-group]
[--start-time]
[--subscription]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"Optional Parameters
The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource.
Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours.
The factory name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access.
The name of the profile. Currently only the default is supported. The default value is DefaultProfile.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Start time for the token. If not specified the current time will be used.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory get-git-hub-access-token
Get GitHub Access Token.
az datafactory get-git-hub-access-token --git-hub-access-code
--git-hub-access-token-base-url
[--factory-name]
[--git-hub-client-id]
[--ids]
[--resource-group]
[--subscription]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
GitHub access code.
GitHub access token base URL.
Optional Parameters
The factory name.
GitHub application client ID.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
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 listOptional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory show
Gets a factory.
az datafactory show [--factory-name]
[--ids]
[--if-none-match]
[--resource-group]
[--subscription]Examples
Factories_Get
az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"Optional Parameters
The factory name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory update
Updates a factory.
az datafactory update [--factory-name]
[--ids]
[--public-network-access]
[--resource-group]
[--subscription]
[--tags]Examples
Factories_Update
az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"Optional Parameters
The factory name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Whether or not public network access is allowed for the data factory.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
الملاحظات
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجع https://aka.ms/ContentUserFeedback.
إرسال الملاحظات وعرضها المتعلقة بـ