Microsoft Azure API Management API Gateway API

openapi: 3.2.0
info:
  title: ApiManagementClient API Gateway API
  description: Use these REST APIs to manage Azure API Management gateway deployments.
  version: '2024-05-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ApiGateway
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
  : put:
      tags:
      - ApiGateway
      operationId: ApiGateway_CreateOrUpdate
      description: Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/GatewayNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The gateway was successfully set up.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayResource'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayResource'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiManagementGatewayResource'
        description: Parameters supplied to the CreateOrUpdate API Management gateway operation.
        required: true
      summary: Api gateway create or update
      x-summary-source: derived
    patch:
      tags:
      - ApiGateway
      operationId: ApiGateway_Update
      description: Updates an existing API Management gateway.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/GatewayNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The gateway was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayResource'
        '202':
          description: The gateway update request was Accepted.
          headers:
            location:
              description: Location header
              schema:
                type: string
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiManagementGatewayUpdateParameters'
        description: Parameters supplied to the CreateOrUpdate API Management gateway operation.
        required: true
      summary: Api gateway update
      x-summary-source: derived
    get:
      tags:
      - ApiGateway
      operationId: ApiGateway_Get
      description: Gets an API Management gateway resource description.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/GatewayNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Successfully got the API Management gateway Resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayResource'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Api gateway get
      x-summary-source: derived
    delete:
      tags:
      - ApiGateway
      operationId: ApiGateway_Delete
      description: Deletes an existing API Management gateway.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/GatewayNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '202':
          description: The gateway delete request was accepted.
          headers:
            location:
              description: Location header
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayResource'
        '204':
          description: The gateway does not exist.
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Api gateway delete
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways:
    get:
      tags:
      - ApiGateway
      operationId: ApiGateway_ListByResourceGroup
      description: List all API Management gateways within a resource group.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The API Management gateways list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Api gateway list by resource group
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/gateways:
    get:
      tags:
      - ApiGateway
      operationId: ApiGateway_List
      description: List all API Management gateways within a subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The API Management gateways list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiManagementGatewayListResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Api gateway list
      x-summary-source: derived
components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    GatewayNameParameter:
      name: gatewayName
      in: path
      required: true
      description: The name of the API Management gateway.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 45
        minLength: 1
        pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
  schemas:
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    FrontendConfiguration:
      type: object
      properties:
        defaultHostname:
          readOnly: true
          type: string
          description: The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
      description: Information regarding how the gateway should be exposed.
    GatewayConfigurationApi:
      type: object
      properties:
        hostname:
          readOnly: true
          type: string
          description: Hostname to which the agent connects to propagate configuration to the cloud.
      description: Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
    ApiManagementGatewayListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ApiManagementGatewayResource'
          description: Result of the List API Management gateway operation.
        nextLink:
          type: string
          description: Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
      required:
      - value
      description: The response of the List API Management gateway operation.
    ApiManagementGatewaySkuPropertiesForPatch:
      type: object
      properties:
        name:
          type: string
          description: Name of the Sku.
          externalDocs:
            url: https://azure.microsoft.com/en-us/pricing/details/api-management/
          enum:
          - Standard
          - WorkspaceGatewayStandard
          - WorkspaceGatewayPremium
          x-ms-enum:
            name: ApiGatewaySkuType
            modelAsString: true
            values:
            - value: Standard
              description: Standard SKU of the API gateway.
            - value: WorkspaceGatewayStandard
              description: Standard SKU of the API gateway to be used in Workspaces.
            - value: WorkspaceGatewayPremium
              description: Premium SKU of the API gateway to be used in Workspaces.
        capacity:
          type: integer
          format: int32
          description: Capacity of the SKU (number of deployed units of the SKU)
      description: API Management gateway resource SKU properties for PATCH operations given nothing should be required.
    BackendConfiguration:
      type: object
      properties:
        subnet:
          $ref: '#/components/schemas/BackendSubnetConfiguration'
          description: The default hostname of the data-plane gateway to which requests can be sent.
      description: Information regarding how the gateway should integrate with backend systems.
    ApiManagementGatewaySkuProperties:
      type: object
      properties:
        name:
          type: string
          description: Name of the Sku.
          externalDocs:
            url: https://azure.microsoft.com/en-us/pricing/details/api-management/
          enum:
          - Standard
          - WorkspaceGatewayStandard
          - WorkspaceGatewayPremium
          x-ms-enum:
            name: ApiGatewaySkuType
            modelAsString: true
            values:
            - value: Standard
              description: Standard SKU of the API gateway.
            - value: WorkspaceGatewayStandard
              description: Standard SKU of the API gateway to be used in Workspaces.
            - value: WorkspaceGatewayPremium
              description: Premium SKU of the API gateway to be used in Workspaces.
        capacity:
          type: integer
          format: int32
          description: Capacity of the SKU (number of deployed units of the SKU)
      required:
      - name
      description: API Management gateway resource SKU properties.
    ApiManagementGatewayResource:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ApiManagementGatewayProperties'
          description: Properties of the API Management gateway.
        sku:
          $ref: '#/components/schemas/ApiManagementGatewaySkuProperties'
          description: SKU properties of the API Management gateway.
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Metadata pertaining to creation and last modification of the resource.
          readOnly: true
        location:
          type: string
          description: Resource location.
          x-ms-mutability:
          - read
          - create
        etag:
          type: string
          description: ETag of the resource.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/ApimResource'
      required:
      - location
      - sku
      - properties
      description: A single API Management gateway resource in List or Get response.
    BackendSubnetConfiguration:
      type: object
      properties:
        id:
          type: string
          description: The ARM ID of the subnet in which the backend systems are hosted.
      description: Information regarding how the subnet to which the gateway should be injected.
    ApiManagementGatewayBaseProperties:
      type: object
      properties:
        provisioningState:
          type: string
          description: 'The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.'
          readOnly: true
        targetProvisioningState:
          type: string
          description: The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
          readOnly: true
        createdAtUtc:
          type: string
          format: date-time
          description: 'Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.'
          readOnly: true
        frontend:
          $ref: '#/components/schemas/FrontendConfiguration'
          description: Information regarding how the gateway should be exposed.
        backend:
          $ref: '#/components/schemas/BackendConfiguration'
          description: Information regarding how the gateway should integrate with backend systems.
        configurationApi:
          $ref: '#/components/schemas/GatewayConfigurationApi'
          description: Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
        virtualNetworkType:
          type: string
          description: 'The type of VPN in which API Management gateway needs to be configured in. '
          enum:
          - None
          - External
          - Internal
          x-ms-enum:
            name: VirtualNetworkType
            modelAsString: true
            values:
            - value: None
              description: The API Management gateway is not part of any Virtual Network.
            - value: External
              description: The API Management gateway is part of Virtual Network and it is accessible from Internet.
            - value: Internal
              description: The API Management gateway is part of Virtual Network and it is only accessible from within the virtual network.
      description: Base Properties of an API Management gateway resource description.
    ApiManagementGatewayUpdateProperties:
      type: object
      properties: {}
      allOf:
      - $ref: '#/components/schemas/ApiManagementGatewayBaseProperties'
      description: Properties of an API Management gateway resource description.
    ApimResource:
      type: object
      description: The Resource definition.
      properties:
        id:
          readOnly: true
          type: string
          description: Resource ID.
        name:
          type: string
          description: Resource name.
          readOnly: true
        type:
          readOnly: true
          type: string
          description: Resource type for API Management resource is set to Microsoft.ApiManagement.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Resource tags.
      x-ms-azure-resource: true
    ApiManagementGatewayUpdateParameters:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/ApiManagementGatewayUpdateProperties'
          description: Properties of the API Management gateway.
        sku:
          $ref: '#/components/schemas/ApiManagementGatewaySkuPropertiesForPatch'
          description: SKU properties of the API Management gateway.
        etag:
          type: string
          description: ETag of the resource.
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/ApimResource'
      description: Parameter supplied to Update API Management gateway.
    systemData:
      type: object
      description: Metadata pertaining to creation and last modification of the resource.
      properties:
        createdBy:
          type: string
          description: The identity that created the resource.
        createdByType:
          type: string
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC).
        lastModifiedBy:
          type: string
          description: The identity that last modified the resource.
        lastModifiedByType:
          type: string
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
      readOnly: true
    ApiManagementGatewayProperties:
      type: object
      properties: {}
      allOf:
      - $ref: '#/components/schemas/ApiManagementGatewayBaseProperties'
      description: Properties of an API Management gateway resource description.
  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.