-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding Example
- Loading branch information
StartAutomating
authored and
StartAutomating
committed
Mar 9, 2024
1 parent
530a563
commit 457064f
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
Out-JSON | ||
-------- | ||
|
||
### Synopsis | ||
Outputs objects as JSON | ||
|
||
--- | ||
|
||
### Description | ||
|
||
Outputs objects in JSON. | ||
|
||
If only one object is outputted, it will not be in a list. | ||
If multiple objects are outputted, they will be in a list. | ||
|
||
--- | ||
|
||
### Related Links | ||
* [@{ | ||
a = 'b' | ||
} | Out-JSON](@{ | ||
a = 'b' | ||
} | Out-JSON.md) | ||
|
||
--- | ||
|
||
### Parameters | ||
#### **InputObject** | ||
The input object. This will form the majority of the JSON. | ||
|
||
|Type |Required|Position|PipelineInput | | ||
|------------|--------|--------|--------------| | ||
|`[PSObject]`|false |named |true (ByValue)| | ||
|
||
#### **ArgumentList** | ||
Any arguments. These will be appended to the input. | ||
|
||
|Type |Required|Position|PipelineInput| | ||
|--------------|--------|--------|-------------| | ||
|`[PSObject[]]`|false |named |false | | ||
|
||
#### **Depth** | ||
The depth of the JSON. By default, this is the FormatEnumerationLimit. | ||
|
||
|Type |Required|Position|PipelineInput| | ||
|---------|--------|--------|-------------| | ||
|`[Int32]`|false |named |false | | ||
|
||
--- | ||
|
||
### Syntax | ||
```PowerShell | ||
Out-JSON [-InputObject <PSObject>] [-ArgumentList <PSObject[]>] [-Depth <Int32>] [<CommonParameters>] | ||
``` |