swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Workflows API
schemes:
- https
tags:
- name: Workflows
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/workflows:
    get:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsListbysubscription
      description: Gets a list of workflows by subscription.
      x-ms-examples:
        List all workflows in a subscription:
          $ref: ./examples/Workflows_ListBySubscription.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/api-version'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        type: integer
        format: int32
      - name: $filter
        description: 'The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.'
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/WorkflowFilter'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Logic Workflows
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows:
    get:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsListbyresourcegroup
      description: Gets a list of workflows by resource group.
      x-ms-examples:
        List all workflows in a resource group:
          $ref: ./examples/Workflows_ListByResourceGroup.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        type: integer
        format: int32
      - name: $filter
        description: 'The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.'
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/WorkflowFilter'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}:
    get:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsGet
      description: Gets a workflow.
      x-ms-examples:
        Get a workflow:
          $ref: ./examples/Workflows_Get.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Workflow'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname
    put:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsCreateorupdate
      description: Creates or updates a workflow.
      x-ms-examples:
        Create or update a workflow:
          $ref: ./examples/Workflows_CreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: workflow
        description: The workflow.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Workflow'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Workflow'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Workflow'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname
    patch:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsUpdate
      description: Updates a workflow.
      x-ms-examples:
        Patch a workflow:
          $ref: ./examples/Workflows_Update.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: workflow
        description: The workflow.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Workflow'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Workflow'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname
    delete:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsDelete
      description: Deletes a workflow.
      x-ms-examples:
        Delete a workflow:
          $ref: ./examples/Workflows_Delete.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/disable
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsDisable
      description: Disables a workflow.
      x-ms-examples:
        Disable a workflow:
          $ref: ./examples/Workflows_Disable.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Disable
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/enable
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsEnable
      description: Enables a workflow.
      x-ms-examples:
        Enable a workflow:
          $ref: ./examples/Workflows_Enable.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Enable
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/generateUpgradedDefinition
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsGenerateupgradeddefinition
      description: Generates the upgraded definition for a workflow.
      x-ms-examples:
        Generate an upgraded definition:
          $ref: ./examples/Workflows_GenerateUpgradedDefinition.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: parameters
        description: Parameters for generating an upgraded definition.
        in: body
        required: true
        schema:
          $ref: '#/definitions/GenerateUpgradedDefinitionParameters'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Generateupgradeddefinition
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listCallbackUrl
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsListcallbackurl
      description: Get the workflow callback Url.
      x-ms-examples:
        Get callback url:
          $ref: ./examples/Workflows_ListCallbackUrl.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: listCallbackUrl
        description: Which callback url to list.
        in: body
        required: true
        schema:
          $ref: '#/definitions/GetCallbackUrlParameters'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowTriggerCallbackUrl'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Listcallbackurl
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsListswagger
      description: Gets an OpenAPI definition for the workflow.
      x-ms-examples:
        Get the swagger for a workflow:
          $ref: ./examples/Workflows_ListSwagger.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Object'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Listswagger
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/move:
    post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsMove
      description: Moves an existing workflow.
      x-ms-examples:
        Move a workflow:
          $ref: ./examples/Workflows_Move.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: move
        description: The workflow to move.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Workflow'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '202':
          description: No Content
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Move
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsRegenerateaccesskey
      description: Regenerates the callback URL access key for request triggers.
      x-ms-examples:
        Regenerate the callback URL access key for request triggers:
          $ref: ./examples/Workflows_RegenerateAccessKey.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: keyType
        description: The access key type.
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegenerateActionParameter'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Regenerateaccesskey
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/validate
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsValidatebyresourcegroup
      description: Validates the workflow.
      x-ms-examples:
        Validate a workflow:
          $ref: ./examples/Workflows_ValidateByResourceGroup.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: validate
        description: The workflow.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Workflow'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Workflows Workflowname Validate
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsValidatebylocation
      description: Validates the workflow definition.
      x-ms-examples:
        Validate a workflow:
          $ref: ./examples/Workflows_ValidateByLocation.json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        type: string
      - name: location
        description: The workflow location.
        in: path
        required: true
        type: string
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - name: workflow
        description: The workflow definition.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Workflow'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Logic Locations Location Workflows Workflowname Validate
  /workflows:
    get:
      tags:
      - Workflows
      description: List all workflows.
      operationId: microsoftAzureListworkflows
      x-ms-examples:
        Workflows_List:
          $ref: ./examples/ListWorkflows.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WorkflowMetadataList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Workflows
  /workflows/{workflowId}:
    get:
      tags:
      - Workflows
      description: Get a specific workflow.
      operationId: microsoftAzureGetworkflow
      x-ms-examples:
        Workflow_Get:
          $ref: ./examples/GetWorkflow.json
      parameters:
      - $ref: '#/parameters/workflowId'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Workflow_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Workflows Workflowid
    put:
      tags:
      - Workflows
      description: Create or replace a workflow.
      operationId: microsoftAzureCreateorreplaceworkflow
      x-ms-examples:
        Workflow_CreateOrUpdate:
          $ref: ./examples/CreateOrReplaceWorkflow.json
      parameters:
      - $ref: '#/parameters/workflowId'
      - name: workflowCreateOrUpdateCommand
        in: body
        required: true
        description: Create or update workflow payload.
        schema:
          $ref: '#/definitions/WorkflowCreateOrUpdateCommand'
      - $ref: '#/parameters/api-version_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Workflow_2'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Workflows Workflowid
    delete:
      tags:
      - Workflows
      description: Delete a workflow.
      operationId: microsoftAzureDeleteworkflow
      x-ms-examples:
        Workflow_Delete:
          $ref: ./examples/DeleteWorkflow.json
      parameters:
      - $ref: '#/parameters/workflowId'
      - $ref: '#/parameters/api-version_2'
      responses:
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Workflows Workflowid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsRegenerateaccesskey
      description: Regenerates the callback URL access key for request triggers.
      x-ms-examples:
        Regenerate the callback URL access key for request triggers:
          $ref: ./examples/Workflows_RegenerateAccessKey.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: keyType
        description: The access key type.
        in: body
        required: true
        schema:
          $ref: '#/definitions/RegenerateActionParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Regenerateaccesskey
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate
  : post:
      tags:
      - Workflows
      operationId: microsoftAzureWorkflowsValidate
      description: Validates the workflow definition.
      x-ms-examples:
        Validate a workflow:
          $ref: ./examples/Workflows_Validate.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/siteNameParameter'
      - name: workflowName
        description: The workflow name.
        in: path
        required: true
        type: string
      - name: validate
        description: The workflow.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Workflow_3'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Validate
definitions:
  FlowAccessControlConfiguration:
    type: object
    description: The access control configuration.
    properties:
      triggers:
        $ref: '#/definitions/FlowAccessControlConfigurationPolicy'
        description: The access control configuration for invoking workflow triggers.
      contents:
        $ref: '#/definitions/FlowAccessControlConfigurationPolicy'
        description: The access control configuration for accessing workflow run contents.
      actions:
        $ref: '#/definitions/FlowAccessControlConfigurationPolicy'
        description: The access control configuration for workflow actions.
      workflowManagement:
        $ref: '#/definitions/FlowAccessControlConfigurationPolicy'
        description: The access control configuration for workflow management.
  ErrorModel:
    description: Default error model
    type: object
    properties:
      code:
        description: Gets or sets the code.
        type: string
      details:
        description: Gets or sets the details.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
        x-ms-identifiers:
        - code
      message:
        description: Gets or sets the messages.
        type: string
      target:
        description: Gets or sets the target.
        type: string
    required:
    - code
    - message
  Sku:
    type: object
    required:
    - name
    properties:
      name:
        $ref: '#/definitions/SkuName'
        description: The name.
      plan:
        $ref: '#/definitions/ResourceReference'
        description: The reference to plan.
    description: The sku type.
  WorkflowSku:
    type: object
    description: The sku type.
    required:
    - name
    properties:
      name:
        $ref: '#/definitions/WorkflowSkuName'
        description: The name.
      plan:
        $ref: '#/definitions/ResourceReference'
        description: The reference to plan.
  WorkflowProvisioningState_2:
    type: string
    description: The workflow provisioning state.
    enum:
    - NotSpecified
    - Accepted
    - Running
    - Ready
    - Creating
    - Created
    - Deleting
    - Deleted
    - Canceled
    - Failed
    - Succeeded
    - Moving
    - Updating
    - Registering
    - Registered
    - Unregistering
    - Unregistered
    - Completed
    - Renewing
    - Pending
    - Waiting
    - InProgress
    x-ms-enum:
      name: WorkflowProvisioningState
      modelAsString: true
  GetCallbackUrlParameters:
    type: object
    properties:
      notAfter:
        type: string
        format: date-time
        description: The expiry time.
      keyType:
        $ref: '#/definitions/KeyType'
        description: The key type.
    description: The callback url parameters.
  SkuName:
    type: string
    enum:
    - NotSpecified
    - Free
    - Shared
    - Basic
    - Standard
    - Premium
    x-ms-enum:
      name: SkuName
      modelAsString: true
    description: The sku name.
  WorkflowParameter:
    type: object
    properties:
      type:
        $ref: '#/definitions/ParameterType'
        description: The type.
      value:
        $ref: '#/definitions/Object'
        description: The value.
      metadata:
        $ref: '#/definitions/Object'
        description: The metadata.
      description:
        type: string
        description: The description.
    description: The workflow parameters.
  WorkflowSkuName:
    type: string
    enum:
    - NotSpecified
    - Free
    - Shared
    - Basic
    - Standard
    - Premium
    x-ms-enum:
      name: WorkflowSkuName
      modelAsString: true
    description: The sku name.
  Resource:
    properties:
      id:
        type: string
        readOnly: true
        description: The resource id.
      name:
        type: string
        readOnly: true
        description: Gets the resource name.
      type:
        type: string
        readOnly: true
        description: Gets the resource type.
      location:
        type: string
        description: The resource location.
      tags:
        type: object
        additionalProperties:
          type: string
        description: The resource tags.
    x-ms-azure-resource: true
    description: The base resource type.
  ErrorResponse_2:
    description: Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorProperties'
        description: The error properties.
  WorkflowProvisioningState:
    type: string
    enum:
    - NotSpecified
    - Accepted
    - Running
    - Ready
    - Creating
    - Created
    - Deleting
    - Deleted
    - Canceled
    - Failed
    - Succeeded
    - Moving
    - Updating
    - Registering
    - Registered
    - Unregistering
    - Unregistered
    - Completed
    x-ms-enum:
      name: WorkflowProvisioningState
      modelAsString: true
  IpAddress:
    type: object
    description: The ip address.
    properties:
      address:
        type: string
        description: The address.
  WorkflowState_2:
    type: string
    description: The workflow state.
    enum:
    - NotSpecified
    - Completed
    - Enabled
    - Disabled
    - Deleted
    - Suspended
    x-ms-enum:
      name: WorkflowState
      modelAsString: true
  WorkflowTriggerCallbackUrl:
    type: object
    properties:
      value:
        type: string
        readOnly: true
        description: Gets the workflow trigger callback URL.
      method:
        type: string
        readOnly: true
        description: Gets the workflow trigger callback URL HTTP method.
      basePath:
        type: string
        readOnly: true
        description: Gets the workflow trigger callback URL base path.
      relativePath:
        type: string
        readOnly: true
        description: Gets the workflow trigger callback URL relative path.
      relativePathParameters:
        type: array
        items:
          type: string
        description: Gets the workflow trigger callback URL relative path parameters.
      queries:
        $ref: '#/definitions/WorkflowTriggerListCallbackUrlQueries'
        description: Gets the workflow trigger callback URL query parameters.
    description: The workflow trigger callback URL.
  WorkflowProperties_2:
    type: object
    properties:
      provisioningState:
        $ref: '#/definitions/WorkflowProvisioningState_2'
        readOnly: true
        description: Gets the provisioning state.
      createdTime:
        type: string
        format: date-time
        readOnly: true
        description: Gets the created time.
      changedTime:
        type: string
        format: date-time
        readOnly: true
        description: Gets the changed time.
      state:
        $ref: '#/definitions/WorkflowState_2'
        description: The state.
      version:
        type: string
        readOnly: true
        description: Gets the version.
      accessEndpoint:
        type: string
        readOnly: true
        description: Gets the access endpoint.
      endpointsConfiguration:
        $ref: '#/definitions/FlowEndpointsConfiguration'
        description: The endpoints configuration.
      accessControl:
        $ref: '#/definitions/FlowAccessControlConfiguration'
        description: The access control configuration.
      sku:
        $ref: '#/definitions/WorkflowSku'
        readOnly: true
        description: The sku.
      integrationAccount:
        $ref: '#/definitions/ResourceReference'
        description: The integration account.
      integrationServiceEnvironment:
        $ref: '#/definitions/ResourceReference'
        description: The integration service environment.
      definition:
        $ref: '#/definitions/Object'
        description: The definition.
      parameters:
        type: object
        additionalProperties:
          $ref: '#/definitions/WorkflowParameter'
        description: The parameters.
      kind:
        $ref: '#/definitions/Kind'
        description: The workflow kind.
    description: The workflow properties.
  FlowEndpoints:
    type: object
    description: The flow endpoints configuration.
    properties:
      outgoingIpAddresses:
        type: array
        description: The outgoing ip address.
        items:
          $ref: '#/definitions/IpAddress'
          description: The ip address.
        x-ms-identifiers:
        - address
      accessEndpointIpAddresses:
        type: array
        description: The access endpoint ip address.
        items:
          $ref: '#/definitions/IpAddress'
          description: The ip address.
        x-ms-identifiers:
        - address
  ParameterType:
    type: string
    enum:
    - NotSpecified
    - String
    - SecureString
    - Int
    - Float
    - Bool
    - Array
    - Object
    - SecureObject
    x-ms-enum:
      name: ParameterType
      modelAsString: true
  Workflow_2:
    description: The workflow properties. It includes the triggers, actual flow and other properties of a workflow.
    allOf:
    - $ref: '#/definitions/WorkflowMetadata'
    - type: object
      properties:
        actionDag:
          type: object
          description: The action DAG(Directed Acyclic Graph), it defines steps to be executed in a workflow run and their order.
      required:
      - actionDag
  RegenerateActionParameter:
    type: object
    properties:
      keyType:
        $ref: '#/definitions/KeyType'
        description: The key type.
    description: The access key regenerate action content.
  GenerateUpgradedDefinitionParameters:
    type: object
    properties:
      targetSchemaVersion:
        type: string
        description: The target schema version.
    description: The parameters to generate upgraded definition.
  FlowEndpointsConfiguration:
    type: object
    description: The endpoints configuration.
    properties:
      workflow:
        $ref: '#/definitions/FlowEndpoints'
        description: The workflow endpoints.
      connector:
        $ref: '#/definitions/FlowEndpoints'
        description: The connector endpoints.
  Triggers:
    type: array
    description: 'It describes under what condition a workflow will run.  '
    items:
      $ref: '#/definitions/Trigger'
  OpenAuthenticationPolicyClaim:
    type: object
    description: Open authentication policy claim.
    properties:
      name:
        type: string
        description: The name of the claim.
      value:
        type: string
        description: The value of the claim.
  OpenAuthenticationProviderType:
    type: string
    description: Open authentication policy provider type.
    enum:
    - AAD
    x-ms-enum:
      name: OpenAuthenticationProviderType
      modelAsString: true
  WorkflowMetadataList:
    type: object
    description: The workflow list.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/WorkflowMetadata'
        description: The value of workflow list.
      nextLink:
        type: string
        description: The URL to get the next set of results.
    required:
    - value
  IpAddressRange:
    type: object
    description: The ip address range.
    properties:
      addressRange:
        type: string
        description: The IP address range.
  WorkflowListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Workflow'
        description: The list of workflows.
      nextLink:
        type: string
        description: The URL to get the next set of results.
    description: The list of workflows.
  WorkflowState:
    type: string
    enum:
    - NotSpecified
    - Completed
    - Enabled
    - Disabled
    - Deleted
    - Suspended
    x-ms-enum:
      name: WorkflowState
      modelAsString: true
  ErrorProperties:
    description: Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      code:
        description: Error code.
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  Workflow_3:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/WorkflowProperties_2'
        description: The workflow properties.
      identity:
        $ref: ./CommonDefinitions.json#/definitions/ManagedServiceIdentity
    description: The workflow type.
    allOf:
    - $ref: '#/definitions/WorkflowResource'
  WorkflowResource:
    type: object
    properties:
      id:
        type: string
        readOnly: true
        description: The resource id.
      name:
        type: string
        readOnly: true
        description: Gets the resource name.
      type:
        type: string
        readOnly: true
        description: Gets the resource type.
      location:
        type: string
        description: The resource location.
      tags:
        type: object
        additionalProperties:
          type: string
        description: The resource tags.
    x-ms-azure-resource: true
    description: The base resource type.
  WorkflowMetadata:
    description: The workflow metadata, action DAGs are not included.
    type: object
    properties:
      id:
        type: string
        format: uuid
        description: The id of workflow.
      triggers:
        $ref: '#/definitions/Triggers'
      createdTime:
        type: string
        format: date-time
        description: The created time of workflow.
      createdBy:
        type: string
        description: The person who created the workflow.
      lastUpdateTime:
        type: string
        format: date-time
        description: The last update time.
      updatedBy:
        type: string
        description: The person who updated the workflow.
      name:
        type: string
        description: The name of a workflow.
      isEnabled:
        type: boolean
        description: Whether the workflow is enabled or not.
      description:
        type: string
        description: Description of a workflow.
    required:
    - id
    - triggers
    - name
    - isEnabled
    - description
  ResourceReference:
    type: object
    properties:
      id:
        type: string
        description: The resource id.
      name:
        type: string
        readOnly: true
        description: Gets the resource name.
      type:
        type: string
        readOnly: true
        description: Gets the resource type.
    description: The resource reference.
  WorkflowTriggerListCallbackUrlQueries:
    type: object
    properties:
      api-version:
        type: string
        description: The api version.
      sp:
        type: string
        description: The SAS permissions.
      sv:
        type: string
        description: The SAS version.
      sig:
        type: string
        description: The SAS signature.
      se:
        type: string
        description: The SAS timestamp.
    description: Gets the workflow trigger callback URL query parameters.
  ErrorResponse:
    description: Default error response model
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
    required:
    - error
  OpenAuthenticationAccessPolicy:
    type: object
    description: Open authentication access policy defined by user.
    properties:
      type:
        $ref: '#/definitions/OpenAuthenticationProviderType'
        description: Type of provider for OAuth.
      claims:
        type: array
        description: The access policy claims.
        items:
          $ref: '#/definitions/OpenAuthenticationPolicyClaim'
          description: The access policy claim.
        x-ms-identifiers:
        - name
  WorkflowProperties:
    type: object
    properties:
      provisioningState:
        $ref: '#/definitions/WorkflowProvisioningState'
        readOnly: true
        description: Gets the provisioning state.
      createdTime:
        type: string
        format: date-time
        readOnly: true
        description: Gets the created time.
      changedTime:
        type: string
        format: date-time
        readOnly: true
        description: Gets the changed time.
      state:
        $ref: '#/definitions/WorkflowState'
        description: The state.
      version:
        type: string
        readOnly: true
        description: Gets the version.
      accessEndpoint:
        type: string
        readOnly: true
        description: Gets the access endpoint.
      sku:
        $ref: '#/definitions/Sku'
        description: The sku.
      integrationAccount:
        $ref: '#/definitions/ResourceReference'
        description: The integration account.
      definition:
        $ref: '#/definitions/Object'
        description: The definition. See [Schema reference for Workflow Definition Language in Azure Logic Apps](https://aka.ms/logic-apps-workflow-definition-language).
      parameters:
        type: object
        additionalProperties:
          $ref: '#/definitions/WorkflowParameter'
        description: The parameters.
    description: The workflow properties.
  Trigger:
    type: object
    description: Describes under what condition a workflow will run.
    properties:
      type:
        type: string
        enum:
        - when_term_creation_is_requested
        - when_term_deletion_is_requested
        - when_term_update_is_requested
        - when_terms_import_is_requested
        - when_data_access_grant_is_requested
        - when_asset_update_is_requested
        x-ms-enum:
          name: TriggerType
          modelAsString: true
      underGlossaryHierarchy:
        type: string
        description: Glossary term hierarchy path.
      underCollection:
        type: string
        description: The collection name.
      underGlossary:
        type: string
        description: The glossary guid.
    required:
    - type
  KeyType:
    type: string
    enum:
    - NotSpecified
    - Primary
    - Secondary
    x-ms-enum:
      name: KeyType
      modelAsString: true
  WorkflowCreateOrUpdateCommand:
    type: object
    description: Create or update workflow payload.
    properties:
      triggers:
        $ref: '#/definitions/Triggers'
      name:
        type: string
        description: The workflow name.
      isEnabled:
        type: boolean
        description: Whether the workflow enabled or not.
      description:
        type: string
        description: Description of a workflow.
      actionDag:
        type: object
        description: The action DAG(Directed Acyclic Graph), it defines actual flow.
    required:
    - triggers
    - name
    - isEnabled
    - description
  Workflow:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/WorkflowProperties'
        description: The workflow properties.
    description: The workflow type.
    allOf:
    - $ref: '#/definitions/Resource'
  Kind:
    type: string
    enum:
    - Stateful
    - Stateless
    x-ms-enum:
      name: Kind
      modelAsString: true
    description: The workflow kind.
  OpenAuthenticationAccessPolicies:
    type: object
    description: AuthenticationPolicy of type Open.
    properties:
      policies:
        type: object
        additionalProperties:
          $ref: '#/definitions/OpenAuthenticationAccessPolicy'
        description: Open authentication policies.
  Object:
    type: object
    properties: {}
  FlowAccessControlConfigurationPolicy:
    type: object
    description: The access control configuration policy.
    properties:
      allowedCallerIpAddresses:
        type: array
        description: The allowed caller IP address ranges.
        items:
          $ref: '#/definitions/IpAddressRange'
          description: The ip address range.
        x-ms-identifiers: []
      openAuthenticationPolicies:
        $ref: '#/definitions/OpenAuthenticationAccessPolicies'
        description: The authentication policies for workflow.
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: Name of the resource group to which the resource belongs.
    required: true
    type: string
    maxLength: 90
    minLength: 1
    pattern: ^[-\w\._\(\)]+[^\.]$
    x-ms-parameter-location: method
  api-version:
    name: api-version
    description: The API version.
    in: query
    required: true
    type: string
  subscriptionId:
    name: subscriptionId
    description: The subscription id.
    in: path
    required: true
    type: string
  workflowId:
    name: workflowId
    in: path
    required: true
    type: string
    format: uuid
    description: The workflow id.
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
    x-ms-parameter-location: client
  api-version_2:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    required: true
    type: string
    x-ms-parameter-location: client
  siteNameParameter:
    name: name
    in: path
    description: Site name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'