New-AzLogicApp
Creates a logic app in a resource group.
Syntax
New-AzLogicApp
-ResourceGroupName <String>
-Name <String>
-Location <String>
[-State <String>]
-Definition <Object>
[-IntegrationAccountId <String>]
[-Parameters <Object>]
[-ParameterFilePath <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzLogicApp
-ResourceGroupName <String>
-Name <String>
-Location <String>
[-State <String>]
-DefinitionFilePath <String>
[-IntegrationAccountId <String>]
[-Parameters <Object>]
[-ParameterFilePath <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzLogicApp cmdlet creates a logic app by using the Logic Apps feature. A logic app is a collection of actions or triggers defined in Logic App definition. This cmdlet returns a Workflow object. You can create a logic app by specifying a name, location, Logic App definition, resource group, and plan. A Logic App definition and parameters are formatted in JavaScript Object Notation (JSON). You can use a logic app as a template for definition and 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. Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object.
Examples
Example 1: Create a logic app by using definition and parameter file paths
New-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\workflows\Definition03.json" -ParameterFilePath "d:\workflows\Parameters03.json"
Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp03
Name : LogicApp03
Type : Microsoft.Logic/workflows
Location : westus
ChangedTime : 1/13/2016 2:41:39 PM
CreatedTime : 1/13/2016 2:41:39 PM
AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup1/providers/Microsoft.Logic/workflows/LogicApp1
State : Enabled
DefinitionLinkUri :
DefinitionLinkContentVersion :
Definition : {$schema, contentVersion, parameters, triggers...}
ParametersLinkUri :
ParametersLinkContentVersion :
Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]}
SkuName : Standard
PlanName : ServicePlan01
PlanType : Microsoft.Web/ServerFarms
PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan1
Version : 08587489107859952120
This command creates a logic app in the specified resource group. The logic app includes the definition and parameters specified by file paths.
Example 2: Create a logic app by using definition and parameter objects
New-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp05" -Location "westus" -State "Enabled" -Definition ([IO.File]::ReadAllText("d:\Workflows\Definition.json")) -Parameters @{name1="value1";name2="value2"}
Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp05
Name : LogicApp05
Type : Microsoft.Logic/workflows
Location : westus
ChangedTime : 1/13/2016 2:41:39 PM
CreatedTime : 1/13/2016 2:41:39 PM
AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp05
State : Enabled
DefinitionLinkUri :
DefinitionLinkContentVersion :
Definition : {$schema, contentVersion, parameters, triggers...}
ParametersLinkUri :
ParametersLinkContentVersion :
Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]}
SkuName : Standard
PlanName : ServicePlan1
PlanType : Microsoft.Web/ServerFarms
PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan1
Version : 08587489107859952120
This command creates a logic app in the specified resource group resource group.
Example 3: Create a logic app by using the pipeline to specify the resource group
Get-AzResourceGroup -ResourceGroupName "ResourceGroup11" | New-AzLogicApp -Name "LogicApp11" -Location "westus" -State "Enabled" -DefinitionFilePath "d:\Workflow\Definition.json" -ParameterFilePath "d:\Workflow\Parameters.json"
Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp11
Name : LogicApp11
Type : Microsoft.Logic/workflows
Location : westus
ChangedTime : 1/13/2016 2:41:39 PM
CreatedTime : 1/13/2016 2:41:39 PM
AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp11
State : Enabled
DefinitionLinkUri :
DefinitionLinkContentVersion :
Definition : {$schema, contentVersion, parameters, triggers...}
ParametersLinkUri :
ParametersLinkContentVersion :
Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]}
SkuName : Standard
PlanName : ServicePlan01
PlanType : Microsoft.Web/ServerFarms
PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan01
Version : 08587489107859952120
This command gets the resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet. The command passes that resource group to the current cmdlet by using the pipeline operator. The current cmdlet creates a logic app in that resource group. The logic app includes the definition and parameters specified by file paths.
Example 4: Create a logic app based on an existing logic app
$Workflow = Get-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp03"
New-AzLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp13" -Location "westus" -State "Enabled" -Definition $Workflow.Definition -Parameters $Workflow.Parameters
Id : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp13
Name : LogicApp13
Type : Microsoft.Logic/workflows
Location : westus
ChangedTime : 1/13/2016 2:41:39 PM
CreatedTime : 1/13/2016 2:41:39 PM
AccessEndpoint : https://westus.logic.azure.com:443/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourcegroups/ResourceGroup11/providers/Microsoft.Logic/workflows/LogicApp13
State : Enabled
DefinitionLinkUri :
DefinitionLinkContentVersion :
Definition : {$schema, contentVersion, parameters, triggers...}
ParametersLinkUri :
ParametersLinkContentVersion :
Parameters : {[destinationUri, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]}
SkuName : Standard
PlanName : ServicePlan01
PlanType : Microsoft.Web/ServerFarms
PlanId : /subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/ResourceGroup11/providers/Microsoft.Web/serverfarms/ServicePlan01
Version : 08587489107859952120
The first command gets the logic app named LogicApp03 by using the Get-AzLogicApp cmdlet. The command stores the logic app in the $Workflow variable. The second command creates a new logic app that uses the definition and parameters of the logic app stored in $Workflow.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Definition
Specifies the definition for your logic app as an object or a string in JavaScript Object Notation (JSON) format.
Type: | Object |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefinitionFilePath
Specifies the definition of a logic app as the path of a definition file in JSON format.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 for the logic app.
Type: | String |
Aliases: | ResourceName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
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 for 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 the 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 |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |