次の方法で共有

az datafactory linked-service

  • リファレンス

注

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の datafactory 拡張機能の一部です。 az datafactory linked-service コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

データ ファクトリを使用してリンクされたサービスを管理します。

コマンド

名前 説明 型 状態
az datafactory linked-service create

リンクされたサービスを作成します。

 拡張 GA
az datafactory linked-service delete

リンクされたサービスを削除します。

 拡張 GA
az datafactory linked-service list

リンクされたサービスを一覧表示します。

 拡張 GA
az datafactory linked-service show

リンクされたサービスを取得します。

 拡張 GA
az datafactory linked-service update

リンクされたサービスを更新します。

 拡張 GA

az datafactory linked-service create

リンクされたサービスを作成します。

az datafactory linked-service create --factory-name
                                     --linked-service-name
                                     --properties
                                     --resource-group
                                     [--if-match]

例

LinkedServices_Create

az datafactory linked-service create --factory-name "exampleFactoryName" --properties "{\"type\":\"AzureStorage\",\"typeProperties\":{\"connectionString\":{\"type\":\"SecureString\",\"value\":\"DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>\"}}}" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

必須のパラメーター

--factory-name

ファクトリ名。

--linked-service-name --name -n

リンクされたサービス名。

--properties

リンクされたサービスのプロパティ。 予期される値: json-string/json-file/@json-file。

--resource-group -g

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

省略可能のパラメーター

--if-match

linkedService エンティティの 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 linked-service delete

リンクされたサービスを削除します。

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

例

LinkedServices_Delete

az datafactory linked-service delete --factory-name "exampleFactoryName" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

省略可能のパラメーター

--factory-name

ファクトリ名。

--ids

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

--linked-service-name --name -n

リンクされたサービス名。

--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 linked-service list

リンクされたサービスを一覧表示します。

az datafactory linked-service list --factory-name
                                   --resource-group

例

LinkedServices_ListByFactory

az datafactory linked-service 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 linked-service show

リンクされたサービスを取得します。

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

例

LinkedServices_Get

az datafactory linked-service show --factory-name "exampleFactoryName" --name "exampleLinkedService" --resource-group "exampleResourceGroup"

省略可能のパラメーター

--factory-name

ファクトリ名。

--ids

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

--if-none-match

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

--linked-service-name --name -n

リンクされたサービス名。

--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 linked-service update

リンクされたサービスを更新します。

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

省略可能のパラメーター

--add

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

規定値: []
--annotations

リンクされたサービスの説明に使用できるタグの一覧。 予期される値: json-string/json-file/@json-file。

--connect-via

統合ランタイムリファレンス。 予期される値: json-string/json-file/@json-file。

--description

リンクされたサービスの説明。

--factory-name

ファクトリ名。

--force-string

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

規定値: False
--ids

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

--if-match

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

--if-none-match

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

--linked-service-name --name -n

リンクされたサービス名。

--parameters

リンクされたサービスのパラメーター。 予期される値: json-string/json-file/@json-file。

--remove

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

規定値: []
--resource-group -g

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

--set

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

規定値: []
--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 を使用します。