az datafactory dataset
Note
This reference is part of the datafactory extension for the Azure CLI (version 2.15.0 or higher). az datafactory dataset コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 Learn more about extensions.
データ ファクトリを使用してデータセットを管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az datafactory dataset create |
データセットを作成します。 |
Extension | GA |
az datafactory dataset delete |
データセットを削除します。 |
Extension | GA |
az datafactory dataset list |
Lists datasets. |
Extension | GA |
az datafactory dataset show |
データセットを取得します。 |
Extension | GA |
az datafactory dataset update |
データセットを更新します。 |
Extension | GA |
az datafactory dataset create
データセットを作成します。
az datafactory dataset create --dataset-name --name
--factory-name
--properties
--resource-group
[--if-match]
例
Datasets_Create
az datafactory dataset create --properties "{\"type\":\"AzureBlob\",\"linkedServiceName\":{\"type\":\"LinkedServiceReference\",\"referenceName\":\"exampleLinkedService\"},\"parameters\":{\"MyFileName\":{\"type\":\"String\"},\"MyFolderPath\":{\"type\":\"String\"}},\"typeProperties\":{\"format\":{\"type\":\"TextFormat\"},\"fileName\":{\"type\":\"Expression\",\"value\":\"@dataset().MyFileName\"},\"folderPath\":{\"type\":\"Expression\",\"value\":\"@dataset().MyFolderPath\"}}}" --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
必須のパラメーター
データセット名。
ファクトリ名。
Dataset properties. 予期される値: json-string/json-file/@json-file。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
データセット エンティティの ETag。 更新に対してのみ指定する必要があります。更新対象は既存のエンティティと一致する必要があり、無条件更新の場合は * にすることができます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az datafactory dataset delete
データセットを削除します。
az datafactory dataset delete [--dataset-name --name]
[--factory-name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
例
Datasets_Delete
az datafactory dataset delete --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
データセット名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
ファクトリ名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
確認を求めないでください。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az datafactory dataset list
Lists datasets.
az datafactory dataset list --factory-name
--resource-group
例
Datasets_ListByFactory
az datafactory dataset list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
必須のパラメーター
ファクトリ名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az datafactory dataset show
データセットを取得します。
az datafactory dataset show [--dataset-name --name]
[--factory-name]
[--ids]
[--if-none-match]
[--resource-group]
[--subscription]
例
Datasets_Get
az datafactory dataset show --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
データセット名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
ファクトリ名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
データセット エンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティ タグと一致する場合、または * が指定された場合、コンテンツは返されません。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az datafactory dataset update
データセットを更新します。
az datafactory dataset update --linked-service-name
[--add]
[--annotations]
[--dataset-name --name]
[--description]
[--factory-name]
[--folder]
[--force-string]
[--ids]
[--if-match]
[--if-none-match]
[--parameters]
[--remove]
[--resource-group]
[--schema]
[--set]
[--structure]
[--subscription]
必須のパラメーター
リンクされたサービス参照。 予期される値: json-string/json-file/@json-file。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
データセットの記述に使用できるタグの一覧。 予期される値: json-string/json-file/@json-file。
データセット名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
Dataset description.
ファクトリ名。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
このデータセットが存在するフォルダー。 指定しない場合、データセットはルート レベルで表示されます。
使用法: --folder name=XX
name: このデータセットが存在するフォルダーの名前。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
データセット エンティティの ETag。 更新に対してのみ指定する必要があります。更新対象は既存のエンティティと一致する必要があり、無条件更新の場合は * にすることができます。
データセット エンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティ タグと一致する場合、または * が指定された場合、コンテンツは返されません。 既定値は None です。
データセットのパラメーター。 予期される値: json-string/json-file/@json-file。
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
データセットの物理型スキーマを定義する列。 型: 配列 (または resultType 配列を持つ式)、itemType: DatasetSchemaDataElement。 予期される値: json-string/json-file/@json-file。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
データセットの構造を定義する列。 型: 配列 (または resultType 配列を持つ式)、itemType: DatasetDataElement。 予期される値: json-string/json-file/@json-file。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |