Edit

Share via

Test-AzureRmLogicApp

  • Reference
Module:
AzureRM.LogicApp

Validates a logic app definition.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Test-AzureRmLogicApp
    -ResourceGroupName <String>
    -Name <String>
    -Location <String>
    [-State <String>]
    [-Definition <Object>]
    [-IntegrationAccountId <String>]
    [-Parameters <Object>]
    [-ParameterFilePath <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzureRmLogicApp
    -ResourceGroupName <String>
    -Name <String>
    -Location <String>
    [-State <String>]
    [-DefinitionFilePath <String>]
    [-IntegrationAccountId <String>]
    [-Parameters <Object>]
    [-ParameterFilePath <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzureRmLogicApp cmdlet validates a logic app definition in a resource group. Specify the logic app name, resource group name, location, state, integration account ID, or parameters. This module supports dynamic parameters. To use a dynamic parameter, type it in the command. To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. If you omit a required template parameter, the cmdlet prompts you for the value.

Examples

Example 1: Validate a logic app by using file paths

PS C:\>Test-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\workflows\Definition.json" -ParameterFilePath "d:\workflows\Parameters.json"

This command validates a logic app named LogicApp01 in the specified resource group. The command specifies definition and parameter file paths.

Example 2: Validate a logic app by using objects

PS C:\>Test-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp01" -Location "westus" -State "Enabled" -Definition [IO.File]::ReadAllText("d:\Workflows\Definition.json") -Parameters @{name1="value1", name2="value2"}

This command validates a logic app named LogicApp01 in the specified resource group. The command specifies definition and parameter objects.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Definition

Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefinitionFilePath

Specifies the definition of your logic app as the path of a definition file in JSON format.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IntegrationAccountId

Specifies an integration account ID for the logic app.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Specifies the location of the logic app. Enter an Azure data center location, such as West US or Southeast Asia. You can place a logic app in any location.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the logic app.

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ParameterFilePath

Specifies the path of a JSON formatted parameter file.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Parameters

Specifies a parameters collection object of the logic app. Specify a hash table, Dictionary<string>, or Dictionary<string, WorkflowParameter>.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-State

Specifies a state of the logic app. The acceptable values for this parameter are: Enabled and Disabled.

Type:String
Accepted values:Enabled, Disabled
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

Void