ActivityParameter interface

套件:

@azure/arm-automation

活動參數的定義。

屬性

description	取得或設定活動參數的描述。
isDynamic	取得或設定布林值，指出參數為動態時為 true。
isMandatory	取得或設定布林值，指出如果需要參數，則為 true。 如果值為 false，則參數為選擇性。
name	取得或設定活動參數的名稱。
position	取得或設定活動參數的位置。
type	取得或設定活動參數的類型。
validationSet	取得或設定活動參數的驗證集。
valueFromPipeline	取得或設定 Boolean 值，指出參數是否可以從傳入管線物件取得值，則為 true。 如果 Cmdlet 必須存取完整的輸入物件，則會使用此設定。 false 表示參數無法從完整的輸入物件取得值。
valueFromPipelineByPropertyName	取得或設定 Boolean 值，指出是否可以從與此參數同名之傳入管線物件的 屬性填入參數時，這個值會指出 true。 false 表示無法從相同名稱的傳入管線物件屬性填入參數。
valueFromRemainingArguments	取得或設定 Boolean 值，如果 Cmdlet 參數接受陣列形式與此參數相關聯的所有剩餘命令列引數，則表示 true。 如果 Cmdlet 參數不接受所有剩餘的引數值，則為 false。

屬性詳細資料

description

取得或設定活動參數的描述。

description?: string

屬性值

string

isDynamic

取得或設定布林值，指出參數為動態時為 true。

isDynamic?: boolean

屬性值

boolean

isMandatory

取得或設定布林值，指出如果需要參數，則為 true。 如果值為 false，則參數為選擇性。

isMandatory?: boolean

屬性值

boolean

name

取得或設定活動參數的名稱。

name?: string

屬性值

string

position

取得或設定活動參數的位置。

position?: number

屬性值

number

type

取得或設定活動參數的類型。

type?: string

屬性值

string

validationSet

取得或設定活動參數的驗證集。

validationSet?: ActivityParameterValidationSet[]

屬性值

ActivityParameterValidationSet[]

valueFromPipeline

取得或設定 Boolean 值，指出參數是否可以從傳入管線物件取得值，則為 true。 如果 Cmdlet 必須存取完整的輸入物件，則會使用此設定。 false 表示參數無法從完整的輸入物件取得值。

valueFromPipeline?: boolean

屬性值

boolean

valueFromPipelineByPropertyName

取得或設定 Boolean 值，指出是否可以從與此參數同名之傳入管線物件的 屬性填入參數時，這個值會指出 true。 false 表示無法從相同名稱的傳入管線物件屬性填入參數。

valueFromPipelineByPropertyName?: boolean

屬性值

boolean

valueFromRemainingArguments

取得或設定 Boolean 值，如果 Cmdlet 參數接受陣列形式與此參數相關聯的所有剩餘命令列引數，則表示 true。 如果 Cmdlet 參數不接受所有剩餘的引數值，則為 false。

valueFromRemainingArguments?: boolean

屬性值

boolean