Export-AMCard

Export-AMCard

Export-AMCard

SYNOPSIS

Exports an Adaptive Card as JSON.

SYNTAX

1

Export-AMCard [-Card] <Hashtable> [-Path <String>] [-Compress <SwitchParameter>] [-Verbose <SwitchParameter>] [-Debug <SwitchParameter>] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-InformationAction <ActionPreference>] [-ProgressAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-InformationVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>] [-PipelineVariable <String>] [<CommonParameters>]

DESCRIPTION

The Export-AMCard function converts an Adaptive Card object (hashtable) to JSON format for use in Actionable Messages. The function can output the JSON directly as a string or save it to a file. It provides options for compressed output (no whitespace) or formatted output (with indentation) for better readability.

This function does not modify the original card object. It is designed to handle deeply nested card structures and ensures proper serialization of all elements.

Use the -Compress switch for production environments to reduce the size of the JSON payload, especially when delivering cards via email where size constraints may apply.

EXAMPLES

EXAMPLE 1

1
2
3
4

# Export a card as a formatted JSON string
$card = New-AMCard -OriginatorId "1234567890" -Version "1.2"
Add-AMElement -Card $card -Element (New-AMTextBlock -Text "Hello World")
$json = Export-AMCard -Card $card

EXAMPLE 2

1
2
3

# Export a card as a compressed JSON string
$card = New-AMCard -OriginatorId "1234567890" -Version "1.2"
$json = Export-AMCard -Card $card -Compress

EXAMPLE 3

1
2
3

# Save a card to a file
$card = New-AMCard -OriginatorId "1234567890" -Version "1.2"
Export-AMCard -Card $card -Path "C:\Cards\mycard.json"

EXAMPLE 4

1
2
3

# Using pipeline input to export a card
$card = New-AMCard -OriginatorId "1234567890" -Version "1.2"
$card | Export-AMCard -Path "C:\Cards\mycard.json"

PARAMETERS

-Compress

(Optional) When specified, produces compressed JSON with no whitespace. This is useful for production environments to reduce message size. When omitted, the JSON will be formatted with indentation for better readability.

1
2
3
4
5
6
7
8
9

Type: Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: -2147483648
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

(Optional) The file path where the JSON should be saved. If not specified, the function will return the JSON as a string.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: -2147483648
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Card

The Adaptive Card object (hashtable) to convert to JSON. This should be created using New-AMCard and populated with elements using functions like Add-AMElement.

1
2
3
4
5
6
7
8
9

Type: Collections.Hashtable
Parameter Sets: (All)
Aliases: None

Required: True
Position: 0
Default value: None
Accept pipeline input: True
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Collections.Hashtable

Accepts an Adaptive Card object created using New-AMCard and populated with elements.

OUTPUTS

System.String

  • Returns the JSON representation of the card as a string when no Path is specified.
  • If Path is specified, writes the JSON to the file and does not return a value.

NOTES

  • When exporting cards for production use, consider using the -Compress switch to reduce the size of the JSON payload.
  • The function uses a high depth value (100) for JSON conversion to ensure that deeply nested card structures are properly serialized.
  • The JSON output is UTF-8 encoded when saved to a file.