Microsoft Azure IntegrationAccounts API

openapi: 3.2.0
info:
  title: Microsoft Azure LogicManagementClient Integration Accounts…
  description: REST API for Azure Logic Apps.
  version: 2018-07-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: IntegrationAccounts
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts:
    get:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsListbysubscription
      description: Gets a list of integration accounts by subscription.
      x-ms-examples:
        List integration accounts by subscription:
          $ref: ./examples/IntegrationAccounts_ListBySubscription.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/api-version'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccountListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Logic…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts:
    get:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsListbyresourcegroup
      description: Gets a list of integration accounts by resource group.
      x-ms-examples:
        List integration accounts by resource group name:
          $ref: ./examples/IntegrationAccounts_ListByResourceGroup.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      - name: $top
        description: The number of items to be included in the result.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccountListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
  : get:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsGet
      description: Gets an integration account.
      x-ms-examples:
        Get integration account by name:
          $ref: ./examples/IntegrationAccounts_Get.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccount'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsCreateorupdate
      description: Creates or updates an integration account.
      x-ms-examples:
        Create or update an integration account:
          $ref: ./examples/IntegrationAccounts_CreateOrUpdate.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccount'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccount'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationAccount'
        description: The integration account.
        required: true
    patch:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsUpdate
      description: Updates an integration account.
      x-ms-examples:
        Patch an integration account:
          $ref: ./examples/IntegrationAccounts_Update.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccount'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationAccount'
        description: The integration account.
        required: true
    delete:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsDelete
      description: Deletes an integration account.
      x-ms-examples:
        Delete an integration account:
          $ref: ./examples/IntegrationAccounts_Delete.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl
  : post:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsListcallbackurl
      description: Gets the integration account callback URL.
      x-ms-examples:
        List IntegrationAccount callback URL:
          $ref: ./examples/IntegrationAccounts_ListCallbackUrl.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallbackUrl'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCallbackUrlParameters'
        description: The callback URL parameters.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listKeyVaultKeys
  : post:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsListkeyvaultkeys
      description: Gets the integration account's Key Vault keys.
      x-ms-examples:
        Get Integration Account callback URL:
          $ref: ./examples/IntegrationAccounts_ListKeyVaultKeys.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultKeyCollection'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListKeyVaultKeysDefinition'
        description: The key vault parameters.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/logTrackingEvents
  : post:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsLogtrackingevents
      description: Logs the integration account's tracking events.
      x-ms-examples:
        Log a tracked event:
          $ref: ./examples/IntegrationAccounts_LogTrackingEvents.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackingEventsDefinition'
        description: The callback URL parameters.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/regenerateAccessKey
  : post:
      tags:
      - IntegrationAccounts
      operationId: microsoftAzureIntegrationaccountsRegenerateaccesskey
      description: Regenerates the integration account access key.
      x-ms-examples:
        Regenerate access key:
          $ref: ./examples/IntegrationAccounts_RegenerateAccessKey.json
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - name: resourceGroupName
        description: The resource group name.
        in: path
        required: true
        schema:
          type: string
      - name: integrationAccountName
        description: The integration account name.
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationAccount'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateActionParameter'
        description: The access key type.
        required: true
components:
  schemas:
    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.
    IntegrationAccountSku:
      type: object
      required:
      - name
      properties:
        name:
          $ref: '#/components/schemas/IntegrationAccountSkuName'
          description: The sku name.
      description: The integration account sku.
    KeyVaultKeyCollection:
      type: object
      description: Collection of key vault keys.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/KeyVaultKey'
          description: The key vault keys.
        skipToken:
          type: string
          description: The skip token.
    TrackingEventErrorInfo:
      type: object
      additionalProperties: false
      properties:
        message:
          type: string
        code:
          type: string
    KeyVaultReference:
      type: object
      description: The key vault reference.
      additionalProperties: false
      properties:
        name:
          type: string
          description: The key vault name.
      allOf:
      - $ref: '#/components/schemas/ResourceReference'
    GetCallbackUrlParameters:
      type: object
      properties:
        notAfter:
          type: string
          format: date-time
          description: The expiry time.
        keyType:
          $ref: '#/components/schemas/KeyType'
          description: The key type.
      description: The callback url parameters.
    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.
    KeyVaultKey:
      type: object
      description: The key vault key.
      properties:
        kid:
          type: string
          description: The key id.
        attributes:
          type: object
          description: The key attributes.
          properties:
            enabled:
              type: boolean
              description: Whether the key is enabled or not.
            created:
              type: integer
              format: int64
              description: When the key was created.
            updated:
              type: integer
              format: int64
              description: When the key was updated.
    IntegrationAccountListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationAccount'
          description: The list of integration accounts.
        nextLink:
          type: string
          description: The URL to get the next set of results.
      description: The list of integration accounts.
    RegenerateActionParameter:
      type: object
      properties:
        keyType:
          $ref: '#/components/schemas/KeyType'
          description: The key type.
      description: The access key regenerate action content.
    TrackEventsOperationOptions:
      type: string
      enum:
      - None
      - DisableSourceInfoEnrich
      x-ms-enum:
        name: TrackEventsOperationOptions
        modelAsString: true
      description: The track events operation options.
    ListKeyVaultKeysDefinition:
      type: object
      description: The list key vault keys definition.
      additionalProperties: false
      required:
      - keyVault
      properties:
        keyVault:
          $ref: '#/components/schemas/KeyVaultReference'
          description: The key vault reference.
        skipToken:
          type: string
          description: The skip token.
    EventLevel:
      type: string
      enum:
      - LogAlways
      - Critical
      - Error
      - Warning
      - Informational
      - Verbose
      x-ms-enum:
        name: EventLevel
        modelAsString: false
      description: The event level.
    IntegrationAccountProperties:
      type: object
      properties: {}
    IntegrationAccountSkuName:
      type: string
      enum:
      - NotSpecified
      - Free
      - Basic
      - Standard
      x-ms-enum:
        name: IntegrationAccountSkuName
        modelAsString: true
    TrackingEvent:
      type: object
      additionalProperties: false
      required:
      - eventLevel
      - eventTime
      - recordType
      properties:
        eventLevel:
          $ref: '#/components/schemas/EventLevel'
        eventTime:
          type: string
          format: date-time
        recordType:
          $ref: '#/components/schemas/TrackingRecordType'
        error:
          $ref: '#/components/schemas/TrackingEventErrorInfo'
    KeyType:
      type: string
      enum:
      - NotSpecified
      - Primary
      - Secondary
      x-ms-enum:
        name: KeyType
        modelAsString: true
    CallbackUrl:
      type: object
      properties:
        value:
          type: string
          description: The URL value.
      description: The callback url.
    TrackingEventsDefinition:
      type: object
      additionalProperties: false
      required:
      - sourceType
      - events
      properties:
        sourceType:
          type: string
        trackEventsOptions:
          $ref: '#/components/schemas/TrackEventsOperationOptions'
        events:
          type: array
          items:
            $ref: '#/components/schemas/TrackingEvent'
    IntegrationAccount:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/IntegrationAccountProperties'
          description: The integration account properties.
        sku:
          $ref: '#/components/schemas/IntegrationAccountSku'
          description: The sku.
      description: The integration account.
      allOf:
      - $ref: '#/components/schemas/Resource'
    TrackingRecordType:
      type: string
      enum:
      - NotSpecified
      - Custom
      - AS2Message
      - AS2MDN
      - X12Interchange
      - X12FunctionalGroup
      - X12TransactionSet
      - X12InterchangeAcknowledgment
      - X12FunctionalGroupAcknowledgment
      - X12TransactionSetAcknowledgment
      - EdifactInterchange
      - EdifactFunctionalGroup
      - EdifactTransactionSet
      - EdifactInterchangeAcknowledgment
      - EdifactFunctionalGroupAcknowledgment
      - EdifactTransactionSetAcknowledgment
      x-ms-enum:
        name: TrackingRecordType
        modelAsString: true
      description: The tracking record type.
  parameters:
    api-version:
      name: api-version
      description: The API version.
      in: query
      required: true
      schema:
        type: string
    subscriptionId:
      name: subscriptionId
      description: The subscription id.
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.