az datafactory factory
Datafactory factory.
Commands
az datafactory factory configure-factory-repo |
Updates a factory's repo information. |
az datafactory factory create |
Creates or updates a factory. |
az datafactory factory delete |
Deletes a factory. |
az datafactory factory get-data-plane-access |
Get Data Plane access. |
az datafactory factory get-git-hub-access-token |
Get GitHub Access Token. |
az datafactory factory list |
Lists factories under the specified subscription. |
az datafactory factory show |
Gets a factory. |
az datafactory factory update |
Updates a factory. |
az datafactory factory configure-factory-repo
Updates a factory's repo information.
az datafactory factory configure-factory-repo --location
[--factory-git-hub-configuration]
[--factory-resource-id]
[--factory-vsts-configuration]
Examples
Factories_ConfigureFactoryRepo
az datafactory factory configure-factory-repo --factory-resource-id "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/myResourceGroup/providers/Microsoft.DataFactory/factories/myFactoryName" --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. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Optional Parameters
Factory's GitHub repo information.
The factory resource id.
Factory's VSTS repo information.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory create
Creates or updates a factory.
az datafactory factory create --name
--resource-group
[--factory-git-hub-configuration]
[--factory-vsts-configuration]
[--global-parameters]
[--if-match]
[--location]
[--tags]
Examples
Factories_CreateOrUpdate
az datafactory factory create --location "East US" --name "myFactoryName" --resource-group "myResourceGroup"
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.
Factory's VSTS repo information.
List of parameters for factory. Expected value: json-string/@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>
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory delete
Deletes a factory.
az datafactory factory delete --name
--resource-group
Examples
Factories_Delete
az datafactory factory delete --name "myFactoryName" --resource-group "myResourceGroup"
Required Parameters
The factory name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory get-data-plane-access
Get Data Plane access.
az datafactory factory get-data-plane-access --name
--resource-group
[--access-resource-path]
[--expire-time]
[--permissions]
[--profile-name]
[--start-time]
Examples
Factories_GetDataPlaneAccess
az datafactory factory get-data-plane-access --name "myFactoryName" --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 "myResourceGroup"
Required Parameters
The factory name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 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.
Start time for the token. If not specified the current time will be used.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory get-git-hub-access-token
Get GitHub Access Token.
az datafactory factory get-git-hub-access-token --git-hub-access-code
--git-hub-access-token-base-url
--name
--resource-group
[--git-hub-client-id]
Examples
Factories_GetGitHubAccessToken
az datafactory factory get-git-hub-access-token --name "myFactoryName" --git-hub-access-code "some" --git-hub-access-token-base-url "some" --git-hub-client-id "some" --resource-group "myResourceGroup"
Required Parameters
GitHub access code.
GitHub access token base URL.
The factory name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
GitHub application client ID.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory list
Lists factories under the specified subscription.
az datafactory factory list [--resource-group]
Examples
Factories_ListByResourceGroup
az datafactory factory list --resource-group "myResourceGroup"
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory show
Gets a factory.
az datafactory factory show --name
--resource-group
[--if-none-match]
Examples
Factories_Get
az datafactory factory show --name "myFactoryName" --resource-group "myResourceGroup"
Required Parameters
The factory name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
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.
Increase logging verbosity. Use --debug for full debug logs.
az datafactory factory update
Updates a factory.
az datafactory factory update --name
--resource-group
[--tags]
Examples
Factories_Update
az datafactory factory update --name "myFactoryName" --tags exampleTag="exampleValue" --resource-group "myResourceGroup"
Required Parameters
The factory name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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.
Increase logging verbosity. Use --debug for full debug logs.