다음을 통해 공유

매개 변수 특성 선언

  • 아티클

매개 변수 특성은 cmdlet 클래스의 public 속성을 cmdlet 매개 변수로 식별합니다.

통사론

[Parameter()]
[Parameter(Named Parameters...)]

매개 변수

Mandatory(System.Boolean) 선택적 명명된 매개 변수입니다. True cmdlet 매개 변수가 필요했음을 나타냅니다. cmdlet을 호출할 때 필수 매개 변수가 제공되지 않으면 Windows PowerShell에서 사용자에게 매개 변수 값을 묻는 메시지를 표시합니다. 기본값은 false.

ParameterSetName(System.String) 선택적 명명된 매개 변수입니다. 이 cmdlet 매개 변수가 속한 매개 변수 집합을 지정합니다. 매개 변수 집합이 지정되지 않은 경우 매개 변수는 모든 매개 변수 집합에 속합니다.

Position(System.Int32) 선택적 명명된 매개 변수입니다. Windows PowerShell 명령 내에서 매개 변수의 위치를 지정합니다.

ValueFromPipeline(System.Boolean) 선택적 명명된 매개 변수입니다. True cmdlet 매개 변수가 파이프라인 개체에서 해당 값을 사용한다는 것을 나타냅니다. cmdlet이 개체의 속성이 아니라 전체 개체에 액세스하는 경우 이 키워드를 지정합니다. 기본값은 false.

ValueFromPipelineByPropertyName(System.Boolean) 선택적 명명된 매개 변수입니다. True cmdlet 매개 변수가 이 매개 변수와 이름이 같거나 별칭이 같은 파이프라인 개체의 속성에서 해당 값을 사용한다는 것을 나타냅니다. 예를 들어 cmdlet에 Name 매개 변수가 있고 파이프라인 개체에도 Name 속성이 있는 경우 Name 속성의 값은 cmdlet의 Name 매개 변수에 할당됩니다. 기본값은 false.

ValueFromRemainingArguments(System.Boolean) 선택적 명명된 매개 변수입니다. True cmdlet 매개 변수가 cmdlet에 전달된 나머지 인수를 모두 허용한다는 것을 나타냅니다. 기본값은 false.

HelpMessage(System.String) 선택적 명명된 매개 변수입니다. 매개 변수에 대한 간단한 설명을 지정합니다. cmdlet이 실행되고 필수 매개 변수가 지정되지 않은 경우 Windows PowerShell에서 이 메시지를 표시합니다.

HelpMessageBaseName(System.String) 선택적 명명된 매개 변수입니다. 리소스 식별자가 있는 위치를 지정합니다. 예를 들어 이 매개 변수는 지역화하려는 도움말 메시지를 포함하는 리소스 어셈블리를 지정할 수 있습니다.

HelpMessageResourceId(System.String) 선택적 명명된 매개 변수입니다. 도움말 메시지의 리소스 식별자를 지정합니다.

DontShow(System.Boolean) 선택적 명명된 매개 변수입니다. True 탭 확장 및 IntelliSense를 위해 매개 변수가 사용자에게 숨겨져 있음을 나타냅니다. 기본값은 false.

발언

  • 이 특성을 선언하는 방법에 대한 자세한 내용은 Cmdlet 매개 변수선언하는 방법을 참조하세요.

  • cmdlet에는 여러 매개 변수가 있을 수 있습니다. 그러나 더 나은 사용자 환경을 위해 매개 변수 수를 제한합니다.

  • 매개 변수는 비정적 공용 필드 또는 속성에서 선언해야 합니다. 속성에 매개 변수를 선언해야 합니다. 속성에는 public set 접근자가 있어야 하며 ValueFromPipeline 또는 ValueFromPipelineByPropertyName 키워드가 지정된 경우 속성에 public get 접근자가 있어야 합니다.

  • 위치 매개 변수를 지정할 때 매개 변수 집합의 위치 매개 변수 수를 5개 미만으로 제한합니다. 또한 위치 매개 변수는 연속될 필요가 없습니다. 위치 5, 100 및 250은 위치 0, 1 및 2와 동일하게 작동합니다.

  • Position 키워드를 지정하지 않으면 cmdlet 매개 변수를 해당 이름으로 참조해야 합니다.

  • 매개 변수 집합을 사용하는 경우 다음 사항에 유의하세요.

    • 각 매개 변수 집합에는 하나 이상의 고유 매개 변수가 있어야 합니다. cmdlet 디자인이 좋습니다. 가능한 경우 이 고유 매개 변수도 필수여야 합니다. cmdlet이 매개 변수 없이 실행되도록 설계된 경우 고유 매개 변수는 필수가 될 수 없습니다.

    • 매개 변수 집합에는 동일한 위치를 가진 둘 이상의 위치 매개 변수가 포함되어서는 안 됩니다.

    • 매개 변수 집합의 매개 변수 하나만 ValueFromPipeline = true선언해야 합니다.

    • 여러 매개 변수는 ValueFromPipelineByPropertyName = true정의할 수 있습니다.

  • 매개 변수 이름에 대한 지침에 대한 자세한 내용은 Cmdlet 매개 변수 이름참조하세요.

  • 매개 변수 특성은 System.Management.Automation.ParameterAttribute 클래스에 의해 정의됩니다.

  • DontShow 매개 변수에는 다음과 같은 부작용이 있습니다.

    • DontShow 사용되지 않는 매개 변수 집합이 있더라도 연결된 매개 변수의 모든 매개 변수 집합에 영향을 줍니다.
    • 탭 완성 및 IntelliSense에서 일반적인 매개 변수를 숨깁니다. 선택적 공통 매개 변수인 WhatIf, 확인 또는 useTransaction숨기지 않습니다.

참고 항목