< Back
Set-AzureRmLogicApp
Post
NAME Set-AzureRmLogicApp
SYNOPSIS
Modifies a logic app in a resource group.
SYNTAX
Set-AzureRmLogicApp [-AppServicePlan <String>] [-DefaultProfile <IAzureContextContainer>] [-Definition <Object>] [-DefinitionFilePath <String>]
[-Force] [-IntegrationAccountId <String>] -Name <String> [-ParameterFilePath <String>] [-Parameters <Object>] -ResourceGroupName <String> [-State
{Enabled | Disabled}] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmLogicApp [-DefaultProfile <IAzureContextContainer>] [-Definition <Object>] [-DefinitionFilePath <String>] [-Force]
[-IntegrationAccountId <String>] -Name <String> [-ParameterFilePath <String>] [-Parameters <Object>] -ResourceGroupName <String> [-State {Enabled
| Disabled}] [-UseConsumptionModel] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmLogicApp cmdlet modifies 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 modify 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.
PARAMETERS
-AppServicePlan <String>
Specifies the name of a plan.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Definition <Object>
Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefinitionFilePath <String>
Specifies the definition of a logic app as the path of a definition file in JSON format.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-IntegrationAccountId <String>
Specifies an integration account ID for the logic app.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of a logic app.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ParameterFilePath <String>
Specifies the path of a JSON formatted parameter file.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Parameters <Object>
Specifies a parameters collection object for the Logic App. Specify a hash table, Dictionary<string>, or Dictionary<string, WorkflowParameter>.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <String>
Specifies the state of the logic app. The acceptable values for this parameter are: Enabled and Disabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseConsumptionModel [<SwitchParameter>]
Indicates that the logic app billing use the consumption based model.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Management.Logic.Models.Workflow
NOTES
Example 1: Modify a logic app
PS C:\\>Set-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp17" -State "Enabled" -AppServicePlan "ServicePlan01"
-DefinitionFilePath "d:\\workflows\\Definition17.json" -ParameterFilePath "d:\\workflows\\Parameters17.json"
Id :
/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp1
Name : LogicApp17
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/subs ... rceGroup11
/providers/Microsoft.Logic/workflows/LogicApp17
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/ServicePlan17
Version : 08587489107859952120
This command modifies a logic app.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rmlogicapp
Get-AzureRmLogicApp
New-AzureRmLogicApp
Remove-AzureRmLogicApp
Start-AzureRmLogicApp
SYNOPSIS
Modifies a logic app in a resource group.
SYNTAX
Set-AzureRmLogicApp [-AppServicePlan <String>] [-DefaultProfile <IAzureContextContainer>] [-Definition <Object>] [-DefinitionFilePath <String>]
[-Force] [-IntegrationAccountId <String>] -Name <String> [-ParameterFilePath <String>] [-Parameters <Object>] -ResourceGroupName <String> [-State
{Enabled | Disabled}] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmLogicApp [-DefaultProfile <IAzureContextContainer>] [-Definition <Object>] [-DefinitionFilePath <String>] [-Force]
[-IntegrationAccountId <String>] -Name <String> [-ParameterFilePath <String>] [-Parameters <Object>] -ResourceGroupName <String> [-State {Enabled
| Disabled}] [-UseConsumptionModel] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmLogicApp cmdlet modifies 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 modify 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.
PARAMETERS
-AppServicePlan <String>
Specifies the name of a plan.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Definition <Object>
Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefinitionFilePath <String>
Specifies the definition of a logic app as the path of a definition file in JSON format.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-IntegrationAccountId <String>
Specifies an integration account ID for the logic app.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of a logic app.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ParameterFilePath <String>
Specifies the path of a JSON formatted parameter file.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Parameters <Object>
Specifies a parameters collection object for the Logic App. Specify a hash table, Dictionary<string>, or Dictionary<string, WorkflowParameter>.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-State <String>
Specifies the state of the logic app. The acceptable values for this parameter are: Enabled and Disabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseConsumptionModel [<SwitchParameter>]
Indicates that the logic app billing use the consumption based model.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Management.Logic.Models.Workflow
NOTES
Example 1: Modify a logic app
PS C:\\>Set-AzureRmLogicApp -ResourceGroupName "ResourceGroup11" -Name "LogicApp17" -State "Enabled" -AppServicePlan "ServicePlan01"
-DefinitionFilePath "d:\\workflows\\Definition17.json" -ParameterFilePath "d:\\workflows\\Parameters17.json"
Id :
/subscriptions/57b7034d-72d4-433d-ace2-a7460aed6a99/resourceGroups/LogicAppCmdletTest/providers/Microsoft.Logic/workflows/LogicApp1
Name : LogicApp17
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/subs ... rceGroup11
/providers/Microsoft.Logic/workflows/LogicApp17
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/ServicePlan17
Version : 08587489107859952120
This command modifies a logic app.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rmlogicapp
Get-AzureRmLogicApp
New-AzureRmLogicApp
Remove-AzureRmLogicApp
Start-AzureRmLogicApp