az datafactory
Note
このリファレンスは、Azure CLI (バージョン 2.15.0 以降) のデータファクトリ拡張機能の一部です。 拡張機能は、az datafactory コマンドを初めて実行 するときに自動的に インストールされます。 拡張機能の詳細をご覧ください。
Data Factory を管理します。
コマンド
az datafactory configure-factory-repo
ファクトリのリポジトリ情報を更新します。
az datafactory configure-factory-repo [--factory-git-hub-configuration]
[--factory-resource-id]
[--factory-vsts-configuration]
[--ids]
[--location]
[--subscription]
例
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"
省略可能のパラメーター
ファクトリの GitHub リポジトリ情報。
使用法: --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 ホスト名。 例: https://github.mydomain.com type: Required。 リポジトリ構成の種類。 account-name: 必須。 [アカウント名]。 repository-name: 必須。 リポジトリ名。 collaboration-branch: 必須。 コラボレーション ブランチ。 root-folder: 必須。 ルート フォルダー。 last-commit-id: 最後のコミット ID。
ファクトリ リソース ID。
ファクトリの VSTS リポジトリ情報。
使用法: --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: 必須。 VSTS プロジェクト名。 tenant-id: VSTS テナント ID。型: 必須。 リポジトリ構成の種類。 account-name: 必須。 [アカウント名]。 repository-name: 必須。 リポジトリ名。 collaboration-branch: 必須。 コラボレーション ブランチ。 root-folder: 必須。 ルート フォルダー。 last-commit-id: 最後のコミット ID。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
Location。 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory create
ファクトリを作成します。
az datafactory create --factory-name
--resource-group
[--factory-git-hub-configuration]
[--factory-vsts-configuration]
[--global-parameters]
[--if-match]
[--location]
[--public-network-access]
[--tags]
例
Factories_CreateOrUpdate
az datafactory create --location "East US" --name "exampleFactoryName" --resource-group "exampleResourceGroup"
必須のパラメーター
ファクトリ名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
ファクトリの GitHub リポジトリ情報。
使用法: --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 ホスト名。 例: https://github.mydomain.com type: Required。 リポジトリ構成の種類。 account-name: 必須。 [アカウント名]。 repository-name: 必須。 リポジトリ名。 collaboration-branch: 必須。 コラボレーション ブランチ。 root-folder: 必須。 ルート フォルダー。 last-commit-id: 最後のコミット ID。
ファクトリの VSTS リポジトリ情報。
使用法: --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: 必須。 VSTS プロジェクト名。 tenant-id: VSTS テナント ID。型: 必須。 リポジトリ構成の種類。 account-name: 必須。 [アカウント名]。 repository-name: 必須。 リポジトリ名。 collaboration-branch: 必須。 コラボレーション ブランチ。 root-folder: 必須。 ルート フォルダー。 last-commit-id: 最後のコミット ID。
ファクトリのパラメーターの一覧。 予期される値: json-string/json-file/@json-file。
ファクトリ エンティティの ETag。 更新に対してのみ指定する必要があります。更新対象は既存のエンティティと一致する必要があり、無条件更新の場合は * にすることができます。
Location。 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
データ ファクトリに対してパブリック ネットワーク アクセスが許可されているかどうか。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory delete
ファクトリを削除します。
az datafactory delete [--factory-name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
例
Factories_Delete
az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"
省略可能のパラメーター
ファクトリ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory 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]
例
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"
省略可能のパラメーター
ファクトリに対する相対アクセス権を取得するリソース パス。 現在、ファクトリ リソースに対応する空の文字列のみがサポートされています。
トークンの有効期限。 トークンの最大期間は 8 時間であり、既定ではトークンは 8 時間で期限切れになります。
ファクトリ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
データ プレーン アクセスのアクセス許可を持つ文字列。 現在、読み取り専用アクセス権を付与する 'r' のみがサポートされています。
プロファイルの名前。 現時点では、既定値のみがサポートされています。 既定値は DefaultProfile です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
トークンの開始時刻。 指定しない場合は、現在の時刻が使用されます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory get-git-hub-access-token
GitHub アクセス トークンを取得します。
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]
例
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"
必須のパラメーター
GitHub アクセス コード。
GitHub アクセス トークンのベース URL。
省略可能のパラメーター
ファクトリ名。
GitHub アプリケーション クライアント ID。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory list
ファクトリを一覧表示します。 指定したサブスクリプションの下にあるファクトリを一覧表示します。
az datafactory list [--resource-group]
例
Factories_ListByResourceGroup
az datafactory list --resource-group "exampleResourceGroup"
Factories_List
az datafactory list
省略可能のパラメーター
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory show
ファクトリを取得します。
az datafactory show [--factory-name]
[--ids]
[--if-none-match]
[--resource-group]
[--subscription]
例
Factories_Get
az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"
省略可能のパラメーター
ファクトリ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
ファクトリ エンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティ タグと一致する場合、または * が指定された場合、コンテンツは返されません。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory update
ファクトリを更新します。
az datafactory update [--factory-name]
[--ids]
[--public-network-access]
[--resource-group]
[--subscription]
[--tags]
例
Factories_Update
az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"
省略可能のパラメーター
ファクトリ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
データ ファクトリに対してパブリック ネットワーク アクセスが許可されているかどうか。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI