az datafactory dataset

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) のデータファクトリ拡張機能の一部です。拡張機能は、az datafactory dataset コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

データファクトリを使用してデータセットを管理します。

コマンド

名前	説明	型	状態
az datafactory dataset create	データセットを作成します。	拡張子	GA
az datafactory dataset delete	データセットを削除します。	拡張子	GA
az datafactory dataset list	データセットを一覧表示します。	拡張子	GA
az datafactory dataset show	データセットを取得します。	拡張子	GA
az datafactory dataset update	データセットを更新します。	拡張子	GA

az datafactory dataset create

データセットを作成します。

az datafactory dataset create --dataset-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-name --name -n

データセットの名前。

--factory-name

ファクトリ名。

--properties

データセットのプロパティ。予期される値: json-string/json-file/@json-file。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--if-match

データセットエンティティの ETag。更新に対してのみ指定する必要があります。更新対象は既存のエンティティと一致する必要があり、無条件更新の場合は * にすることができます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az datafactory dataset delete

データセットを削除します。

az datafactory dataset delete [--dataset-name]
                              [--factory-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]
                              [--yes]

例

Datasets_Delete

az datafactory dataset delete --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

省略可能のパラメーター

--dataset-name --name -n

データセットの名前。

--factory-name

ファクトリ名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az datafactory dataset list

データセットを一覧表示します。

az datafactory dataset list --factory-name
                            --resource-group

例

Datasets_ListByFactory

az datafactory dataset list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

必須のパラメーター

--factory-name

ファクトリ名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az datafactory dataset show

データセットを取得します。

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

例

Datasets_Get

az datafactory dataset show --name "exampleDataset" --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

省略可能のパラメーター

--dataset-name --name -n

データセットの名前。

--factory-name

ファクトリ名。

--ids

--if-none-match

データセットエンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティタグと一致する場合、または * が指定された場合、コンテンツは返されません。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az datafactory dataset update

データセットを更新します。

az datafactory dataset update --linked-service-name
                              [--add]
                              [--annotations]
                              [--dataset-name]
                              [--description]
                              [--factory-name]
                              [--folder]
                              [--force-string]
                              [--ids]
                              [--if-match]
                              [--if-none-match]
                              [--parameters]
                              [--remove]
                              [--resource-group]
                              [--schema]
                              [--set]
                              [--structure]
                              [--subscription]

必須のパラメーター

--linked-service-name

リンクされたサービス参照。予期される値: json-string/json-file/@json-file。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

規定値: []

--annotations

データセットの記述に使用できるタグの一覧。予期される値: json-string/json-file/@json-file。

--dataset-name --name -n

データセットの名前。

--description

データセットの説明。

--factory-name

ファクトリ名。

--folder

このデータセットが存在するフォルダー。指定しない場合、データセットはルートレベルで表示されます。

使用法: --folder name=XX

name: このデータセットが存在するフォルダーの名前。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False

--ids

--if-match

--if-none-match

データセットエンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティタグと一致する場合、または * が指定された場合、コンテンツは返されません。既定値は None です。

--parameters

データセットのパラメーター。予期される値: json-string/json-file/@json-file。

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

規定値: []

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--schema

データセットの物理型スキーマを定義する列。型: 配列 (または resultType 配列を持つ式)、itemType: DatasetSchemaDataElement。予期される値: json-string/json-file/@json-file。

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

規定値: []

--structure

データセットの構造を定義する列。型: 配列 (または resultType 配列を持つ式)、itemType: DatasetDataElement。予期される値: json-string/json-file/@json-file。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az datafactory dataset

コマンド

az datafactory dataset create

例

必須のパラメーター

省略可能のパラメーター

az datafactory dataset delete

例

省略可能のパラメーター

az datafactory dataset list

例

必須のパラメーター

az datafactory dataset show

例

省略可能のパラメーター

az datafactory dataset update

必須のパラメーター

省略可能のパラメーター

その他のリソース