Microsoft Azure Custom APIs API

openapi: 3.2.0
info:
  title: Microsoft Azure LogicAppsManagementClient Custom APIs API
  version: '2016-06-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Custom APIs
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/customApis:
    get:
      tags:
      - Custom APIs
      summary: Microsoft Azure List Of Custom Apis
      operationId: microsoftAzureCustomapisList
      description: Gets a list of all custom APIs for a subscription id
      x-ms-examples:
        List all custom APIs:
          $ref: ./examples/customApisList.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      - $ref: '#/components/parameters/pageSizeParameter'
      - $ref: '#/components/parameters/skipTokenParameter'
      responses:
        '200':
          description: A list of custom APIs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApiDefinitionCollection'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis:
    get:
      tags:
      - Custom APIs
      summary: Microsoft Azure List Of Custom Apis
      operationId: microsoftAzureCustomapisListbyresourcegroup
      description: Gets a list of all custom APIs in a subscription for a specific resource group
      x-ms-examples:
        List all custom APIs:
          $ref: ./examples/customApisListByResourceGroup.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      - $ref: '#/components/parameters/pageSizeParameter'
      - $ref: '#/components/parameters/skipTokenParameter'
      responses:
        '200':
          description: A list of custom APIs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApiDefinitionCollection'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}:
    get:
      tags:
      - Custom APIs
      summary: Microsoft Azure Get A Custom Api
      operationId: microsoftAzureCustomapisGet
      description: Gets a custom API by name for a specific subscription and resource group
      x-ms-examples:
        Get a custom API:
          $ref: ./examples/customApisGet.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: A custom API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApiDefinition'
    put:
      tags:
      - Custom APIs
      summary: Microsoft Azure Replaces An Existing Custom Api
      operationId: microsoftAzureCustomapisCreateorupdate
      description: Creates or updates an existing custom API
      x-ms-examples:
        Replace a custom API:
          $ref: ./examples/customApisCreateOrUpdate.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiNameParameter'
      - $ref: '#/components/parameters/customApiParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The replacing custom API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApiDefinition'
    patch:
      tags:
      - Custom APIs
      summary: Microsoft Azure Update An Existing Custom Api
      operationId: microsoftAzureCustomapisUpdate
      description: Updates an existing custom API's tags
      x-ms-examples:
        Update a custom API's tags:
          $ref: ./examples/customApisUpdate.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiNameParameter'
      - $ref: '#/components/parameters/customApiParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The updated custom API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApiDefinition'
    delete:
      tags:
      - Custom APIs
      summary: Microsoft Azure Delete A Custom Api
      operationId: microsoftAzureCustomapisDelete
      description: Deletes a custom API from the resource group
      x-ms-examples:
        Delete a custom API:
          $ref: ./examples/customApisDelete.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the custom API
        '204':
          description: No custom API to delete
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}/move:
    post:
      tags:
      - Custom APIs
      summary: Microsoft Azure Moves The Custom Api
      operationId: microsoftAzureCustomapisMove
      description: Moves a specific custom API
      x-ms-examples:
        Move a custom API:
          $ref: ./examples/customApisMove.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/apiNameParameter'
      - $ref: '#/components/parameters/customApiReferenceParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: custom API successfully moved
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/listWsdlInterfaces:
    post:
      tags:
      - Custom APIs
      summary: Microsoft Azure Lists Wsdl Interfaces
      operationId: microsoftAzureCustomapisListwsdlinterfaces
      description: This returns the list of interfaces in the WSDL
      x-ms-examples:
        List the WSDL interfaces:
          $ref: ./examples/customApisListWsdlInterfaces.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/locationParameter'
      - $ref: '#/components/parameters/wsdlDefinitionParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: A list of interfaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WsdlServiceCollection'
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/extractApiDefinitionFromWsdl:
    post:
      tags:
      - Custom APIs
      summary: Microsoft Azure Returns Api Definition From Wsdl
      operationId: microsoftAzureCustomapisExtractapidefinitionfromwsdl
      description: Parses the specified WSDL and extracts the API definition
      x-ms-examples:
        Extract definition from WSDL:
          $ref: ./examples/customApisExtractApiDefinitionFromWsdl.json
      parameters:
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/locationParameter'
      - $ref: '#/components/parameters/wsdlDefinitionParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Swagger of the API extracted from the WSDL
          content:
            application/json:
              schema: {}
components:
  schemas:
    WsdlServiceCollection:
      description: A list of custom API WSDL interfaces
      type: object
      properties:
        value:
          description: Collection of WSDL interfaces
          type: array
          items:
            $ref: '#/components/schemas/WsdlService'
    ConnectionParameter:
      description: Connection provider parameters
      type: object
      properties:
        type:
          description: Type of the parameter
          enum:
          - string
          - securestring
          - secureobject
          - int
          - bool
          - object
          - array
          - oauthSetting
          - connection
          type: string
          x-ms-enum:
            name: ConnectionParameterType
            modelAsString: false
        oAuthSettings:
          $ref: '#/components/schemas/ApiOAuthSettings'
    ResourceReference:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        id:
          description: Resource reference id
          type: string
        type:
          description: Resource reference type
          type: string
    WsdlService:
      type: object
      description: The service with name and endpoint names
      additionalProperties: false
      required:
      - qualifiedName
      properties:
        qualifiedName:
          description: The service's qualified name
          type: string
        endpointQualifiedNames:
          type: array
          description: List of the endpoints' qualified names
          items:
            type: string
    ApiResourceDefinitions:
      type: object
      description: API Definitions
      additionalProperties: false
      properties:
        originalSwaggerUrl:
          type: string
          description: The original swagger URL
        modifiedSwaggerUrl:
          type: string
          description: The modified swagger URL
    ApiOAuthSettingsParameter:
      description: OAuth settings for the API
      type: object
      properties:
        value:
          description: Value of the setting
          type: string
        options:
          type: object
          description: Options available to this parameter
        uiDefinition:
          type: object
          description: UI definitions per culture as caller can specify the culture
    CustomApiDefinitionCollection:
      description: A list of custom API definitions
      type: object
      properties:
        value:
          description: Collection of custom APIs
          type: array
          items:
            $ref: '#/components/schemas/CustomApiDefinition'
    ApiReference:
      type: object
      x-abstract: true
      additionalProperties: false
      properties:
        swagger:
          type: object
          description: The JSON representation of the swagger
        brandColor:
          type: string
          description: Brand color
        description:
          type: string
          description: The custom API description
        displayName:
          type: string
          description: The display name
        iconUri:
          type: string
          description: The icon URI
        name:
          type: string
          description: The name of the API
      allOf:
      - $ref: '#/components/schemas/ResourceReference'
    CustomApiReference:
      type: object
      description: The custom API reference
      additionalProperties: false
      properties:
        name:
          type: string
      allOf:
      - $ref: '#/components/schemas/ApiReference'
    WsdlDefinition:
      type: object
      description: The WSDL definition
      additionalProperties: false
      properties:
        url:
          type: string
          description: The WSDL URL
        content:
          type: string
          description: The WSDL content
        service:
          $ref: '#/components/schemas/WsdlService'
        importMethod:
          $ref: '#/components/schemas/WsdlImportMethod'
    ApiOAuthSettings:
      description: OAuth settings for the connection provider
      type: object
      properties:
        identityProvider:
          description: Identity provider
          type: string
        clientId:
          description: Resource provider client id
          type: string
        clientSecret:
          description: Client Secret needed for OAuth
          type: string
        scopes:
          description: OAuth scopes
          type: array
          items:
            type: string
        redirectUrl:
          description: Url
          type: string
        properties:
          type: object
          description: Read only properties for this oauth setting.
        customParameters:
          description: OAuth parameters key is the name of parameter
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ApiOAuthSettingsParameter'
    ResourceDefinition:
      description: A resource
      type: object
      additionalProperties: false
      properties:
        id:
          description: Resource id
          type: string
          readOnly: true
        name:
          description: Resource name
          type: string
          readOnly: true
        type:
          description: Resource type
          type: string
          readOnly: true
        location:
          description: Resource location
          type: string
        etag:
          description: Resource ETag
          type: string
        tags:
          $ref: '#/components/schemas/TagsDictionary'
      x-ms-azure-resource: true
    CustomApiDefinition:
      type: object
      description: A custom API
      additionalProperties: false
      properties:
        properties:
          $ref: '#/components/schemas/CustomApiPropertiesDefinition'
      allOf:
      - $ref: '#/components/schemas/ResourceDefinition'
    ApiType:
      type: string
      description: The API type
      enum:
      - NotSpecified
      - Rest
      - Soap
      x-ms-enum:
        name: ApiType
        modelAsString: true
    TagsDictionary:
      type: object
      description: Resource tags
      additionalProperties:
        type: string
      example:
        SampleTagName: SampleTagValue
    ApiResourceBackendService:
      type: object
      description: The API backend service
      additionalProperties: false
      properties:
        serviceUrl:
          type: string
          description: The service URL
    WsdlImportMethod:
      type: string
      description: The WSDL import method
      enum:
      - NotSpecified
      - SoapToRest
      - SoapPassThrough
      x-ms-enum:
        name: WsdlImportMethod
        modelAsString: true
    CustomApiPropertiesDefinition:
      type: object
      description: Custom API properties
      additionalProperties: false
      properties:
        connectionParameters:
          description: Connection parameters
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ConnectionParameter'
        runtimeUrls:
          type: array
          description: Runtime URLs
          items:
            type: string
        capabilities:
          type: array
          description: The custom API capabilities
          items:
            type: string
        swagger:
          type: object
          description: The JSON representation of the swagger
        brandColor:
          type: string
          description: Brand color
        description:
          type: string
          description: The custom API description
        displayName:
          type: string
          description: The display name
        iconUri:
          type: string
          description: The icon URI
        backendService:
          $ref: '#/components/schemas/ApiResourceBackendService'
        apiDefinitions:
          $ref: '#/components/schemas/ApiResourceDefinitions'
        apiType:
          $ref: '#/components/schemas/ApiType'
        wsdlDefinition:
          $ref: '#/components/schemas/WsdlDefinition'
  parameters:
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Subscription Id
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    wsdlDefinitionParameter:
      name: wsdlDefinition
      description: WSDL definition
      in: body
      required: true
      schema:
        $ref: '#/components/schemas/WsdlDefinition'
      x-ms-parameter-location: method
    customApiReferenceParameter:
      name: customApiReference
      description: The custom API reference
      in: body
      required: true
      schema:
        $ref: '#/components/schemas/CustomApiReference'
      x-ms-parameter-location: method
    pageSizeParameter:
      name: $top
      description: The number of items to be included in the result
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
    resourceGroupNameParameter:
      name: resourceGroupName
      description: The resource group
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    skipTokenParameter:
      name: skiptoken
      description: Skip Token
      in: query
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    locationParameter:
      name: location
      description: The location
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    apiVersionParameter:
      name: api-version
      in: query
      description: API Version
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    customApiParameter:
      name: customApi
      description: The custom API
      in: body
      required: true
      schema:
        $ref: '#/components/schemas/CustomApiDefinition'
      x-ms-parameter-location: method
    apiNameParameter:
      name: apiName
      description: API name
      in: path
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate a user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow