@@ -29,7 +29,7 @@ Parameters are defined as key-value pairs in the `parameters` property of a conf
29
29
The key is the parameter's name, which is used to reference the parameter in the [resources][01]
30
30
property of the configuration document. The value is an object that defines the parameter.
31
31
32
- Every parameter defines its data type. Parameters may also define a default value, validation
32
+ Every parameter defines its data type. Parameters can also define a default value, validation
33
33
checks, a description of their purpose, and arbitrary metadata.
34
34
35
35
To reference parameters in resource instances, use the [parameters() configuration function][02].
@@ -42,7 +42,7 @@ To reference parameters in resource instances, use the [parameters() configurati
42
42
43
43
# ## description
44
44
45
- Parameters may define a short explanation of their purpose and usage with the `description`
45
+ Parameters can define a short explanation of their purpose and usage with the `description`
46
46
property. To define a longer explanation in YAML, use the folded block syntax or literal block
47
47
syntax.
48
48
@@ -68,8 +68,8 @@ data type for every passed parameter before executing a configuration operation.
68
68
69
69
The `secure*` data types indicate that DSC and integrating tools shouldn't log or record the
70
70
values. If a secure data type parameter is used for a resource instance property that doesn't
71
- expect a secure value, the resource may still log or record the value. If the resource has
72
- independent logging or recording that isn't handled by DSC, the value may be stored insecurely.
71
+ expect a secure value, the resource might still log or record the value. If the resource has
72
+ independent logging or recording that isn't handled by DSC, the value might be stored insecurely.
73
73
74
74
Use secure strings for passwords and secrets.
75
75
@@ -84,7 +84,7 @@ ValidValues: [string, securestring, int, bool, object, secureobject, array]
84
84
85
85
# ## defaultValue
86
86
87
- Parameters may define a default value with the `defaultValue` property. If the parameter isn't
87
+ Parameters can define a default value with the `defaultValue` property. If the parameter isn't
88
88
passed at runtime, DSC uses the default value for the parameter. If the parameter isn't passed at
89
89
runtime and no default value is defined, DSC raises an error. The value must be valid for the
90
90
parameter's `type`.
@@ -96,7 +96,7 @@ ValidJSONTypes: [string, integer, object, array, boolean]
96
96
97
97
# ## allowedValues
98
98
99
- Parameters may limit the set of valid values for the parameter by defining the `allowedValues`
99
+ Parameters can limit the set of valid values for the parameter by defining the `allowedValues`
100
100
property. DSC validates parameters passed at runtime and defined as `defaultValue` against this
101
101
list of values. If any of the values is invalid, DSC raises an error.
102
102
0 commit comments