Azure Logic Apps integrationServiceEnvironmentManagedApis API

The integrationServiceEnvironmentManagedApis API from Azure Logic Apps — 2 operation(s) for integrationserviceenvironmentmanagedapis.

OpenAPI Specification

azure-logic-apps-integrationserviceenvironmentmanagedapis-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  description: REST API for Azure Logic Apps.
  title: LogicManagementClient IntegrationAccountAgreements integrationServiceEnvironmentManagedApis API
  version: '2.0'
  x-apisguru-categories:
  - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
  - format: swagger
    url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/logic/resource-manager/Microsoft.Logic/stable/2019-05-01/logic.json
  x-preferred: true
  x-providerName: azure.com
  x-serviceName: logic
  x-tags:
  - Azure
  - Microsoft
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
  - user_impersonation
tags:
- name: integrationServiceEnvironmentManagedApis
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis
  : get:
      description: Gets the integration service environment managed Apis.
      operationId: IntegrationServiceEnvironmentManagedApis_List
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - description: The resource group.
        in: path
        name: resourceGroup
        required: true
        type: string
        example: my-resource-group
      - description: The integration service environment name.
        in: path
        name: integrationServiceEnvironmentName
        required: true
        type: string
        example: example-value
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ManagedApiListResult'
        default:
          description: Logic error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - integrationServiceEnvironmentManagedApis
      x-ms-examples:
        Gets the integration service environment managed Apis:
          parameters:
            api-version: '2019-05-01'
            integrationServiceEnvironmentName: testIntegrationServiceEnvironment
            resourceGroup: testResourceGroup
            subscriptionId: f34b22a3-2202-4fb1-b040-1332bd928c84
          responses:
            '200':
              body:
                value:
                - id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment/managedApis/azurefile
                  location: brazilsouth
                  name: azurefile
                  properties:
                    capabilities:
                    - blob
                    connectionParameters:
                      accessKey:
                        type: securestring
                        uiDefinition:
                          constraints:
                            required: 'true'
                          description: Specify a valid primary/secondary storage account access key.
                          displayName: Azure Storage Account Access Key
                          tooltip: Specify a valid primary/secondary storage account access key.
                      accountName:
                        type: string
                        uiDefinition:
                          constraints:
                            required: 'true'
                          description: Name of the storage account the connector should use.
                          displayName: Azure Storage Account name
                          tooltip: Provide the storage account name
                    generalInformation:
                      description: Microsoft Azure Storage provides a massively scalable, durable, and highly available storage for data on the cloud, and serves as the data storage solution for modern applications. Connect to File Storage to perform various operations such as create, update, get and delete on files in your Azure Storage account.
                      displayName: Azure File Storage
                      iconUrl: https://powerappsconnectorsdf.blob.core.windows.net/officialicons/azurefile/icon_1.0.1216.1605.png
                      releaseTag: Preview
                      tier: Standard
                    integrationServiceEnvironment:
                      id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment
                      name: tes-ise-ga
                      type: Microsoft.Logic/integrationServiceEnvironments
                    metadata:
                      brandColor: '#804998'
                      source: marketplace
                    name: azurefile
                    provisioningState: Succeeded
                    runtimeUrls:
                    - https://flow-yticlpbiumhig-cqsn-apim-runtime.brazilus.environments.microsoftazurelogicapps.net/apim/azurefile
                  type: Microsoft.Logic/integrationServiceEnvironments/managedApis
                - id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment/managedApis/azuretables
                  location: brazilsouth
                  name: azuretables
                  properties:
                    capabilities:
                    - actions
                    connectionParameters:
                      sharedkey:
                        type: securestring
                        uiDefinition:
                          constraints:
                            required: 'true'
                          description: The shared storage key of your storage account
                          displayName: Shared Storage Key
                          tooltip: Provide a shared storage key for the storage account used for tables as it appears in the Azure portal
                      storageaccount:
                        type: string
                        uiDefinition:
                          constraints:
                            required: 'true'
                          description: The name of your storage account
                          displayName: Storage Account Name
                          tooltip: Provide the name of the storage account used for tables as it appears in the Azure portal
                    generalInformation:
                      description: Azure Table storage is a service that stores structured NoSQL data in the cloud, providing a key/attribute store with a schemaless design. Sign into your Storage account to create, update, and query tables and more.
                      displayName: Azure Table Storage
                      iconUrl: https://powerappsconnectorsdf.blob.core.windows.net/officialicons/azuretables/icon_1.0.1216.1605.png
                      releaseTag: Production
                      tier: Standard
                    integrationServiceEnvironment:
                      id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment
                      name: testIntegrationServiceEnvironment
                      type: Microsoft.Logic/integrationServiceEnvironments
                    metadata:
                      brandColor: '#804998'
                      source: marketplace
                    name: azuretables
                    provisioningState: Succeeded
                    runtimeUrls:
                    - https://flow-yticlpbiumhig-cqsn-apim-runtime.brazilus.environments.microsoftazurelogicapps.net/apim/azuretables
                  type: Microsoft.Logic/integrationServiceEnvironments/managedApis
                - id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment/managedApis/eventhubs
                  location: brazilsouth
                  name: eventhubs
                  properties:
                    capabilities:
                    - actions
                    connectionParameters:
                      connectionString:
                        type: securestring
                        uiDefinition:
                          constraints:
                            required: 'true'
                          description: Azure Event Hubs Connection String
                          displayName: Connection String
                          tooltip: Provide Azure Event Hubs Connection String
                    generalInformation:
                      description: Connect to Azure Event Hubs to send and receive events.
                      displayName: Event Hubs
                      iconUrl: https://connectoricons-df.azureedge.net/eventhubs/icon_1.0.1228.1637.png
                      releaseTag: Production
                      tier: Standard
                    integrationServiceEnvironment:
                      id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment
                      name: testIntegrationServiceEnvironment
                      type: Microsoft.Logic/integrationServiceEnvironments
                    metadata:
                      brandColor: '#c4d5ff'
                      source: marketplace
                    name: eventhubs
                    provisioningState: Succeeded
                    runtimeUrls:
                    - https://flow-yticlpbiumhig-cqsn-apim-runtime.brazilus.environments.microsoftazurelogicapps.net/apim/eventhubs
                  type: Microsoft.Logic/integrationServiceEnvironments/managedApis
                - id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment/managedApis/mq
                  location: brazilsouth
                  name: mq
                  properties:
                    capabilities:
                    - actions
                    - cloud
                    connectionParameters:
                      authType:
                        allowedValues:
                        - value: basic
                        - value: anonymous
                        type: string
                        uiDefinition:
                          constraints:
                            allowedValues:
                            - text: Basic
                              value: basic
                            - text: Anonymous
                              value: anonymous
                            capability: []
                            required: 'true'
                            tabIndex: 6
                          description: Authentication type to connect to your Queue Manager
                          displayName: Authentication
                          tooltip: Authentication type to connect to your Queue Manager
                      channel:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            required: 'true'
                            tabIndex: 3
                          description: The channel to connect to the Queue Manager on.
                          displayName: Channel name
                          tooltip: Channel name
                      effectiveUserName:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            clearText: true
                            required: 'true'
                            tabIndex: 5
                          description: The user name to use when connecting to MQ.
                          displayName: Connect As
                          tooltip: Connect As
                      enableSSL:
                        type: bool
                        uiDefinition:
                          constraints:
                            capability: []
                            required: 'false'
                            tabIndex: 9
                          description: Enable SSL? (True/False)
                          displayName: Enable SSL?
                          tooltip: Specify if SSL needs to be enabled
                      password:
                        type: securestring
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            required: 'false'
                            tabIndex: 8
                          description: Password credential
                          displayName: Password
                          tooltip: Password credential
                      queue:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            required: 'true'
                            tabIndex: 4
                          description: The name of the default queue, may be overriden.
                          displayName: Default queue name
                          tooltip: Default queue name
                      queueManager:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            required: 'true'
                            tabIndex: 2
                          description: The name of the Queue Manager to connect to.
                          displayName: Queue Manager name
                          tooltip: Queue Manager name
                      server:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            required: 'true'
                            tabIndex: 1
                          description: The host name and port the MQ server is running on (host:port).
                          displayName: Server
                          tooltip: Server:Port
                      username:
                        type: securestring
                        uiDefinition:
                          constraints:
                            capability:
                            - cloud
                            clearText: true
                            required: 'false'
                            tabIndex: 7
                          description: Username credential
                          displayName: Username
                          tooltip: Username credential
                    generalInformation:
                      description: Microsoft Connector for MQ integrates Azure applications with resources stored in an IBM WebSphere MQ server. Supports message send and receive operations.
                      displayName: MQ
                      iconUrl: https://powerappsconnectorsdf.blob.core.windows.net/officialicons/mq/icon_1.0.1216.1605.png
                      releaseTag: Production
                      tier: Enterprise
                    integrationServiceEnvironment:
                      id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment
                      name: testIntegrationServiceEnvironment
                      type: Microsoft.Logic/integrationServiceEnvironments
                    metadata:
                      brandColor: '#466BB0'
                      source: marketplace
                    name: mq
                    provisioningState: Succeeded
                    runtimeUrls:
                    - https://flow-yticlpbiumhig-cqsn-apim-runtime.brazilus.environments.microsoftazurelogicapps.net/apim/mq
                  type: Microsoft.Logic/integrationServiceEnvironments/managedApis
                - id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationServiceEnvironments/testIntegrationServiceEnvironment/managedApis/sap
                  location: brazilsouth
                  name: sap
                  properties:
                    capabilities:
                    - actions
                    - triggers
                    - integrationServiceEnvironment
                    connectionParameters:
                      appServerHost:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - ApplicationServer
                            required: 'false'
                            tabIndex: 7
                          description: 'The hostname of the SAP Application Server. '
                          displayName: AS Host
                          tooltip: The hostname of the specific SAP Application Server to connect to.
                      appServerService:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - ApplicationServer
                            required: 'false'
                            tabIndex: 8
                          description: The service name or port number of the SAP Application Server.
                          displayName: AS Service
                          tooltip: The service name or port numbe of the specific SAP Application Server to connect to (Optional for connection type (Logon) A - Application Server).
                      authType:
                        allowedValues:
                        - value: basic
                        defaultValue: basic
                        type: string
                        uiDefinition:
                          constraints:
                            allowedValues:
                            - text: Basic
                              value: basic
                            capability:
                            - integrationServiceEnvironment
                            required: 'true'
                            tabIndex: 3
                          description: Authentication type to connect to the SAP System. Must be basic (username and password).
                          displayName: Authentication Type
                          tooltip: Authentication type to connect to the SAP System.
                      client:
                        type: int
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            required: 'true'
                            tabIndex: 2
                          description: The SAP client ID to connect to the SAP system.
                          displayName: Client
                          tooltip: The SAP backend's client (or 'Mandant') into which to log in. It is a number ranging from 000 to 999.
                      logonGroup:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - Group
                            required: 'false'
                            tabIndex: 13
                          description: The Logon Group for the SAP System.
                          displayName: MS Logon Group
                          tooltip: The Logon Group for the SAP System, from which the Message Server shall select an Application Server (Only available if connection type (Logon) is B - Message Server (Group))
                      logonType:
                        allowedValues:
                        - uiDefinition:
                            description: Application Server Logon (Type A)
                            displayName: Application Server (Type A)
                          value: ApplicationServer
                        - uiDefinition:
                            description: Group Logon (Type B aka Message Server)
                            displayName: Group (Type B aka Message Server)
                          value: Group
                        defaultValue: Group
                        type: string
                        uiDefinition:
                          constraints:
                            allowedValues:
                            - text: Application Server
                              value: ApplicationServer
                            - text: Group
                              value: Group
                            capability:
                            - integrationServiceEnvironment
                            required: 'true'
                            tabIndex: 6
                          description: The type of logon to the SAP System, either Application Server Logon (Type A) or Group Logon (Type B aka Message Server).
                          displayName: Logon Type
                          tooltip: The type of logon to the SAP System.
                      messageServerHost:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - Group
                            required: 'false'
                            tabIndex: 10
                          description: The hostname of the SAP Message Server aka R3 System Name.
                          displayName: MS Server Host
                          tooltip: The hostname of the SAP System’s Message Server (central instance) aka R3 System Name (Mandatory if connection type (Logon) is B - Message Server (Group)).
                      messageServerService:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - Group
                            required: 'false'
                            tabIndex: 11
                          description: The service name or port number of the Message Server.
                          displayName: MS Service Name or Port Number
                          tooltip: The Service Name (as defined in etc/services) or the Port Number under which the Message Server is listening for load-balancing requests (Mandatory if connection type (Logon) is B - Message Server (Group) and System ID is not present)
                      password:
                        type: securestring
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            clearText: false
                            required: 'false'
                            tabIndex: 5
                          description: The password to be used for log in to the SAP System.
                          displayName: SAP Password
                          tooltip: The password to be used for log in to the SAP System.
                      safeTyping:
                        type: bool
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            required: 'false'
                            tabIndex: 14
                          description: Use strong types if false, otherwise use string as safe type.
                          displayName: Safe Typing
                          tooltip: Enables safe typing, which treats types as string instead of strong types (e.g. Date, Time, Datetime), relaxing type and value validations.
                      sncLibraryPath:
                        type: string
                        uiDefinition:
                          constraints:
                            capability: []
                            dependencies:
                              UseSnc:
                                values:
                                - 'true'
                            required: 'false'
                            tabIndex: 16
                          description: Name or path of the SNC library to be used.
                          displayName: SNC Library
                          tooltip: Name or path of the SNC library to be used. Path can be absolute path or relative to the NCo library
                      sncMyName:
                        type: string
                        uiDefinition:
                          constraints:
                            capability: []
                            dependencies:
                              UseSnc:
                                values:
                                - 'true'
                            required: 'false'
                            tabIndex: 18
                          description: Identity to be used for this particular destination/server (optional).
                          displayName: SNC My Name
                          tooltip: The installed SNC solution usually knows its own SNC name. Only for solutions supporting 'multiple identities', you may need to specify the identity to be used for this particular destination/server (optional)
                      sncPartnerName:
                        type: string
                        uiDefinition:
                          constraints:
                            capability: []
                            dependencies:
                              UseSnc:
                                values:
                                - 'true'
                            required: 'false'
                            tabIndex: 19
                          description: The backend's SNC name (Required when Logon Type is Application Server).
                          displayName: SNC Partner Name
                          tooltip: The backend's SNC name (Required when Logon Type is Application Server)
                      sncQop:
                        allowedValues:
                        - value: Authentication
                        - value: Integrity
                        - value: Privacy
                        - value: Default
                        - value: Maximum
                        defaultValue: Default
                        type: string
                        uiDefinition:
                          constraints:
                            allowedValues:
                            - text: Authentication only
                              value: Authentication
                            - text: Authentication and integrity protection
                              value: Integrity
                            - text: Authentication, integrity and privacy protection (encryption)
                              value: Privacy
                            - text: Default protection
                              value: Default
                            - text: Maximum protection
                              value: Maximum
                            capability: []
                            dependencies:
                              UseSnc:
                                values:
                                - 'true'
                            required: 'false'
                            tabIndex: 20
                          description: Quality of Service to be used for SNC communication of this particular destination/server.
                          displayName: SNC Quality of Protection
                          tooltip: Quality of Service to be used for SNC communication of this particular destination/server
                      sncSso:
                        allowedValues:
                        - value: true
                        - value: false
                        defaultValue: true
                        type: string
                        uiDefinition:
                          constraints:
                            allowedValues:
                            - text: Logon using the SNC identity
                              value: true
                            - text: Logon with the username/password information provided on RFC level
                              value: false
                            capability: []
                            dependencies:
                              UseSnc:
                                values:
                                - 'true'
                            required: 'false'
                            tabIndex: 17
                          description: The SNC SSO specifies whether to use SNC identity or credentials provided on RFC level.
                          displayName: SNC SSO
                          tooltip: The SNC SSO specifies whether to use SNC identity or credentials provided on RFC level.
                      systemID:
                        type: string
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - Group
                            required: 'false'
                            tabIndex: 12
                          description: The System ID of the SAP system.
                          displayName: MS System ID
                          tooltip: The SAP system’s three-letter system ID (Mandatory if connection type (Logon) is B - Message Server (Group) and Message Server Service is not present)
                      systemNumber:
                        type: int
                        uiDefinition:
                          constraints:
                            capability:
                            - integrationServiceEnvironment
                            dependencies:
                              LogonType:
                                values:
                                - ApplicationServer
                            required: 'false'
                            tabIndex: 9
                          description: The SAP System’s System Number. It is a number ranging from 00 to 99.
                          displayName: AS System Number
                          tooltip: The SAP System’s System Number. It is a number ranging from 00 to 99 (Mandatory if connection type (Logon) is A - Application Server).
                      useSnc:
                        defaultValue: 'false'
                        type: bool
                        uiDefinition:
                          constraints:
                            capability: []
                            tabIndex: 15
                          description: When selected, the connections will be secured with SNC.
                          displayName: Use SNC
                          tooltip: When selected, the connections

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-logic-apps/refs/heads/main/openapi/azure-logic-apps-integrationserviceenvironmentmanagedapis-api-openapi.yml