dsc リソースの一覧
概要
オプションのフィルターを使用して、使用可能な DSC リソースの一覧を返します。
構文
dsc resource list [Options] <RESOURCE_NAME>
説明
サブコマンドは list 、使用可能な DSC リソースを検索し、その情報を返します。 DSC は、まず、 または DSC_RESOURCE_PATH 環境変数で 、、.dsc.resource.ymlおよび ファイルをPATH検索してリソースを.dsc.resource.jsondsc.resource.yaml検出します。 DSC で使用される環境変数の詳細については、「環境変数」を参照してください。
検出されたリソースのいずれかがリソース プロバイダーである場合、DSC はプロバイダーを呼び出してリソースも一覧表示します。
DSC は、検出されたリソースの一覧とその実装情報とメタデータを返します。 コマンドに 引数が RESOURCE_NAME 含まれている場合、DSC は検出されたリソースの一覧をフィルター処理してから、それらを返します。 説明とタグのオプションは、リソースの説明とタグによって結果をフィルター処理します。
例
例 1 - すべてのリソースを一覧表示する
フィルターがない場合、コマンドは検出されたすべての DSC リソースを返します。
dsc resource list
Type Version Methods Requires Description
----------------------------------------------------------------------------------------------------------------------------------------------------
DSC.PackageManagement/Brew 0.1.0 get, set, export DSC resource to manage Homebrew packages
DSC/AssertionGroup 0.1.0 get, set, test `test` will be invoked for all resources in the supplied configuration.
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
DSC/ParallelGroup 0.1.0 get, set, test All resources in the supplied configuration run concurrently.
DSC/PowerShellGroup 0.1.0 get, set, test, export Resource provider to classic DSC Powershell resources.
Microsoft.Windows/Registry 0.1.0 get, set, test Registry configuration provider for the Windows Registry
Microsoft/OSInfo 0.1.0 get, export Returns information about the operating system.
Microsoft/Process 0.1.0 get, set, test, export Returns information about running processes.
Test/Echo 0.1.0 get, set, test
Test/Sleep 0.1.0 get, set, test
Test/TestGroup 0.1.0 get
Test/TestResource1 1.0.0 get Test/TestGroup This is a test resource.
Test/TestResource2 1.0.1 get Test/TestGroup This is a test resource.
例 2 - 特定のリソースを一覧表示する
引数に RESOURCE_NAME ワイルドカードが含まれていない場合、コマンドは指定された型名を持つリソースのみを返します。
dsc resource list DSC/Group
Type Version Methods Requires Description
----------------------------------------------------------------------------------------------------------------
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
例 3 - 型名が一致するリソースを一覧表示する
引数にワイルドカードが RESOURCE_NAME 含まれている場合、コマンドは型名が一致するすべてのリソースを返します。
dsc resource list DSC/*
Type Version Methods Requires Description
---------------------------------------------------------------------------------------------------------------------------------------
DSC/AssertionGroup 0.1.0 get, set, test `test` will be invoked for all resources in the supplied configuration.
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
DSC/ParallelGroup 0.1.0 get, set, test All resources in the supplied configuration run concurrently.
DSC/PowerShellGroup 0.1.0 get, set, test, export Resource provider to classic DSC Powershell resources.
例 4 - 一致する説明を含むリソースを一覧表示する
コマンドに description オプションが含まれている場合、結果には、指定された値を含む説明を含むリソースが含まれます。
dsc resource list --description 'supplied configuration'
Type Version Methods Requires Description
------------------------------------------------------------------------------------------------------------------------------
DSC/AssertionGroup 0.1.0 get, set, test `test` will be invoked for all resources in the supplied configuration.
DSC/Group 0.1.0 get, set, test All resources in the supplied configuration is treated as a group.
DSC/ParallelGroup 0.1.0 get, set, test All resources in the supplied configuration run concurrently.
例 5 - タグが一致するリソースを一覧表示する
コマンドに tags オプションの複数のインスタンスが含まれている場合、結果には、指定されたタグのいずれかを持つリソースが含まれます。
dsc resource list --tags Windows --tags Linux
Type Version Methods Requires Description
-----------------------------------------------------------------------------------------------------------------------
Microsoft.Windows/Registry 0.1.0 get, set, test Registry configuration provider for the Windows Registry
Microsoft/OSInfo 0.1.0 get, export Returns information about the operating system.
引数
RESOURCE_NAME
検出された DSC リソースの型名に適用するオプションのフィルターを指定します。 フィルターにはワイルドカード (*) を含めることができます。 フィルターでは大文字と小文字は区別されません。
この引数を指定すると、DSC は結果をフィルター処理して、リソースの種類名がフィルターと一致するリソースのみを含めます。
たとえば、フィルター Microsoft.* を指定すると、Microsoft によって発行されたリソースのみが返されます。
フィルター *Sql* を指定すると、大文字と小文字に関係なく、名前に文字列 Sql を含む任意のリソースが返されます。
Type: String
Mandatory: false
オプション
-d、--description
リソースの説明で一致する文字列を指定します。 このオプションを指定すると、DSC はリソースを説明文字列でフィルター処理します。 フィルターでは大文字と小文字が区別されず、説明文字列内の任意の場所の値と一致します。 ワイルドカードは使用できません。
Type: String
Mandatory: false
-t、--tags
フィルター処理するリソース タグを指定します。 このオプションを指定すると、DSC はリソースをフィルター処理し、一致するタグを持つリソースのみを含めます。 フィルターでは大文字と小文字が区別されません。 ワイルドカードは使用できません。
このオプションを複数回指定すると、一連のタグでフィルター処理できます。 結果には、このオプションで指定されたタグの少なくとも 1 つを含むリソースが含まれます。
Type: String
Mandatory: false
-f、--format
オプションは --format 、コマンドのコンソール出力形式を制御します。 コマンド出力がリダイレクトされるか、変数としてキャプチャされる場合、出力は常に、返される各リソースを表す一連の JSON 行になります。 このオプションを指定しない場合、コマンドの出力には、返されたリソースの概要を表すテーブルが表示されます。 詳細については、「 出力」を参照してください。
Type: String
Mandatory: false
DefaultValue: yaml
ValidValues: [json, pretty-json, yaml]
-h, --help
現在のコマンドまたはサブコマンドのヘルプを表示します。 このオプションを指定すると、アプリケーションはこの後のすべてのオプションと引数を無視します。
Type: Boolean
Mandatory: false
出力
このコマンドは、リソースの種類、バージョン、マニフェスト設定、およびその他のメタデータを含む各リソースの JSON オブジェクトを返します。 詳細については、「 dsc リソース リストの結果スキーマ」を参照してください。
コマンドの出力がキャプチャまたはリダイレクトされない場合、返されるリソースの概要テーブルとして既定でコンソールに表示されます。 概要テーブルには、一覧表示された順序で表示される次の列が含まれています。
- 型 - リソースの完全修飾型名。
- Version - リソースのセマンティック バージョン。
- メソッド - リソースに実装されているメソッドのコンマ区切りの一覧。 有効なメソッドは、
get、、settest、およびexportです。 実装testされていないリソースは、DSC の合成テスト機能に依存します。 - 必須 - 返されたリソースを呼び出すために DSC が使用するプロバイダー リソースの完全修飾型名。
- 説明 - リソースの目的と使用状況の簡単な説明。
出力オブジェクトを JSON オブジェクトまたは YAML オブジェクトとしてコンソールに表示するには、 --format オプションを使用します。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示