You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This function takes an object that has the format of a Schema Definition and converts it into the schemaDefinition class. It can also return as either the schemaDefinition class or a json string.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
This is a JSON Schema definition as defined by the json-schema.org (see related
68
+
links below). This object is then converted into a PowerShell object that can be
69
+
used like any other PowerShell object.
70
+
71
+
{
72
+
"type": [
73
+
"object"
74
+
],
75
+
"properties": {
76
+
"Id": {
77
+
"type": "string"
78
+
},
79
+
"Regions": {
80
+
"type": "array",
81
+
"items": {
82
+
"$ref": "#/definitions/Region"
83
+
}
84
+
}
85
+
},
86
+
"required": [
87
+
"Id",
88
+
"Regions"
89
+
]
90
+
}
91
+
92
+
```yaml
93
+
Type: System.Object
94
+
Parameter Sets: (All)
95
+
Aliases:
96
+
97
+
Required: True
98
+
Position: 0
99
+
Default value: None
100
+
Accept pipeline input: False
101
+
Accept wildcard characters: False
102
+
```
103
+
104
+
### CommonParameters
105
+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
106
+
107
+
## INPUTS
108
+
109
+
### None
110
+
## OUTPUTS
111
+
112
+
### schemaDefinition
113
+
This class is really modified object that contains the $schema attribute as well as validation on what values can be present for that attribute. Schema Definition (https://json-schema.org/understanding-json-schema/structuring.html#defs) Schema Keyword (https://json-schema.org/understanding-json-schema/reference/schema.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
111
127
112
128
## INPUTS
113
129
114
130
### None
115
-
116
131
## OUTPUTS
117
132
118
133
### schemaDocument
119
-
120
-
This class is really modified object that contains the $schema attribute as well
121
-
as validation on what values can be present for that attribute.
This class is really modified object that contains the $schema attribute as well as validation on what values can be present for that attribute. Schema Object (https://json-schema.org/understanding-json-schema/reference/object.html) Schema Keyword (https://json-schema.org/understanding-json-schema/reference/schema.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
128
135
129
136
### schemaString
130
-
131
-
The string type is used for strings of text. It may contain Unicode characters.
The string type is used for strings of text. It may contain Unicode characters. Schema String (https://json-schema.org/understanding-json-schema/reference/string.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
136
138
137
139
### schemaInteger
138
-
139
-
The integer type is used for integral numbers. In PowerShell this is an int32
The integer type is used for integral numbers. In PowerShell this is an int32 Schema Integer (http://json-schema.org/understanding-json-schema/reference/numeric.html#integer) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
144
141
145
142
### schemaNumber
146
-
147
-
The number type is used for any numeric type, either integers or floating point
The number type is used for any numeric type, either integers or floating point numbers. In PowerShell this is a double. Schema Number (http://json-schema.org/understanding-json-schema/reference/numeric.html#number) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
153
144
154
145
### schemaBoolean
155
-
156
-
The boolean type matches only two special values: true and false. Note that
157
-
values that evaluate to true or false, such as 1 and 0, are not accepted by the
The boolean type matches only two special values: true and false. Note that values that evaluate to true or false, such as 1 and 0, are not accepted by the schema. Schema Boolean (http://json-schema.org/understanding-json-schema/reference/boolean.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
163
147
164
148
### schemaObject
165
-
166
-
Objects are the mapping type in JSON. They map "keys" to "values". In JSON, the
167
-
"keys" must always be strings. Each of these pairs is conventionally referred
Objects are the mapping type in JSON. They map "keys" to "values". In JSON, the "keys" must always be strings. Each of these pairs is conventionally referred to as a "property". Schema Object (https://json-schema.org/understanding-json-schema/reference/object.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
173
150
174
151
### schemaArray
175
-
176
-
Arrays are used for ordered elements. In JSON, each element in an array may be
Arrays are used for ordered elements. In JSON, each element in an array may be of a different type. Schema Array (https://json-schema.org/understanding-json-schema/reference/array.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
0 commit comments