Package version:

Interface LogicApps

Interface representing a LogicApps.

interface LogicApps {
    createOrUpdate(resourceGroupName: string, containerAppName: string, logicAppName: string, resource: LogicApp, options?: LogicAppsCreateOrUpdateOptionalParams): Promise<LogicApp>;
    delete(resourceGroupName: string, containerAppName: string, logicAppName: string, options?: LogicAppsDeleteOptionalParams): Promise<void>;
    deployWorkflowArtifacts(resourceGroupName: string, containerAppName: string, logicAppName: string, options?: LogicAppsDeployWorkflowArtifactsOptionalParams): Promise<void>;
    get(resourceGroupName: string, containerAppName: string, logicAppName: string, options?: LogicAppsGetOptionalParams): Promise<LogicApp>;
    getWorkflow(resourceGroupName: string, containerAppName: string, logicAppName: string, workflowName: string, options?: LogicAppsGetWorkflowOptionalParams): Promise<WorkflowEnvelope>;
    invoke(resourceGroupName: string, containerAppName: string, logicAppName: string, xMsLogicAppsProxyPath: string, xMsLogicAppsProxyMethod: string, options?: LogicAppsInvokeOptionalParams): Promise<LogicAppsInvokeResponse>;
    listWorkflows(resourceGroupName: string, containerAppName: string, logicAppName: string, options?: LogicAppsListWorkflowsOptionalParams): PagedAsyncIterableIterator<WorkflowEnvelope>;
    listWorkflowsConnections(resourceGroupName: string, containerAppName: string, logicAppName: string, options?: LogicAppsListWorkflowsConnectionsOptionalParams): Promise<WorkflowEnvelope>;
}

Methods

createOrUpdate delete deployWorkflowArtifacts get getWorkflow invoke listWorkflows listWorkflowsConnections

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName, containerAppName, logicAppName, resource, options?): Promise<LogicApp>

  • Create or update a Logic App extension resource

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the Logic App, the extension resource.

    • resource: LogicApp

      Logic app resource properties.

    • Optionaloptions: LogicAppsCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<LogicApp>

delete

  • delete(resourceGroupName, containerAppName, logicAppName, options?): Promise<void>

  • Deletes a Logic App extension resource

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the Logic App, the extension resource.

    • Optionaloptions: LogicAppsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

deployWorkflowArtifacts

  • deployWorkflowArtifacts(resourceGroupName, containerAppName, logicAppName, options?): Promise<void>

  • Creates or updates the artifacts for the logic app

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the Logic App, the extension resource.

    • Optionaloptions: LogicAppsDeployWorkflowArtifactsOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • get(resourceGroupName, containerAppName, logicAppName, options?): Promise<LogicApp>

  • Gets a logic app extension resource.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the Logic App, the extension resource.

    • Optionaloptions: LogicAppsGetOptionalParams

      The options parameters.

    Returns Promise<LogicApp>

getWorkflow

  • getWorkflow(resourceGroupName, containerAppName, logicAppName, workflowName, options?): Promise<WorkflowEnvelope>

  • Get workflow information by its name

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the Logic App, the extension resource.

    • workflowName: string

      Workflow name.

    • Optionaloptions: LogicAppsGetWorkflowOptionalParams

      The options parameters.

    Returns Promise<WorkflowEnvelope>

invoke

  • invoke(resourceGroupName, containerAppName, logicAppName, xMsLogicAppsProxyPath, xMsLogicAppsProxyMethod, options?): Promise<LogicAppsInvokeResponse>

  • Proxies a the API call to the logic app backed by the container app.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the LogicApp App, the extension resource.

    • xMsLogicAppsProxyPath: string

      The proxy path for the API call

    • xMsLogicAppsProxyMethod: string

      The proxy method for the API call

    • Optionaloptions: LogicAppsInvokeOptionalParams

      The options parameters.

    Returns Promise<LogicAppsInvokeResponse>

listWorkflows

  • listWorkflows(resourceGroupName, containerAppName, logicAppName, options?): PagedAsyncIterableIterator<WorkflowEnvelope>

  • List the workflows for a logic app.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • containerAppName: string

      Name of the Container App.

    • logicAppName: string

      Name of the Logic App, the extension resource.

    • Optionaloptions: LogicAppsListWorkflowsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<WorkflowEnvelope>

listWorkflowsConnections

Settings

Member Visibility