ConvertFrom-AMJson

ConvertFrom-AMJson

ConvertFrom-AMJson

SYNOPSIS

Converts an Adaptive Card JSON to PowerShell commands using the ActionableMessages module.

SYNTAX

1

ConvertFrom-AMJson [-Json] <String> [-OutputPath <String>] [-GenerateId <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

Takes an Adaptive Card JSON string and generates the equivalent PowerShell commands that would create the same card using the ActionableMessages module functions.

This function is useful for:

  • Converting existing Adaptive Cards to PowerShell code
  • Learning by example how to create complex cards
  • Migrating from other platforms that export Adaptive Cards as JSON
  • Generating scripts from designer-created cards

The generated code follows best practices for the ActionableMessages module and maintains proper nesting of elements within containers and column sets.

EXAMPLES

EXAMPLE 1

1
2
3

# Convert JSON from a file and display the PowerShell commands
$jsonContent = Get-Content -Path ".\myAdaptiveCard.json" -Raw
ConvertFrom-AMJson -Json $jsonContent

EXAMPLE 2

1
2
3

# Convert JSON and save the PowerShell commands to a file
$jsonContent = Get-Content -Path ".\designerCard.json" -Raw
ConvertFrom-AMJson -Json $jsonContent -OutputPath ".\createCard.ps1"

EXAMPLE 3

1
2
3

# Convert JSON from a web response
$response = Invoke-RestMethod -Uri "https://myapi.example.com/cards/template"
$response.cardJson | ConvertFrom-AMJson

EXAMPLE 4

1
2
3
4
5

# Convert and immediately execute the generated script
$json = '{"type":"AdaptiveCard","version":"1.2","body":[{"type":"TextBlock","text":"Hello World"}]}'
$script = ConvertFrom-AMJson -Json $json
Invoke-Expression $script
$cardJson # Access the card created by the script

PARAMETERS

-GenerateId

Optional switch. When specified, generates new IDs for elements that don’t have them, which can be useful when you need to reference elements later in your code.

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

-Json

The Adaptive Card JSON string to convert to PowerShell commands. This can be a complete Adaptive Card JSON object with schema, type, version, etc.

1
2
3
4
5
6
7
8
9

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

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

-OutputPath

Optional. If specified, writes the generated PowerShell script to this file path instead of returning it as a string.

1
2
3
4
5
6
7
8
9

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

Required: False
Position: 1
Default value: None
Accept pipeline input: False
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.String

OUTPUTS

System.String or None

Returns the generated PowerShell script as a string if no OutputPath is specified. If OutputPath is specified, writes to the file and returns a confirmation message.

NOTES

This function will attempt to handle all standard Adaptive Card elements and actions, including TextBlocks, Images, ImageSets, Containers, ColumnSets, FactSets, Input elements, and various action types.

If the JSON contains unsupported element types, they will be commented in the output script.

Variable names in the generated script are based on element types and IDs when available.