Azure Front Door Experiments API

openapi: 3.2.0
info:
  title: WebApplicationFirewallManagement Experiments API
  version: '2026-04-01'
  description: APIs to manage web application firewall rules.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Experiments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments
  : get:
      operationId: Experiments_ListByProfile
      tags:
      - Experiments
      summary: Gets a list of Experiments
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The Profile identifier associated with the Tenant and Partner
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
  : get:
      operationId: Experiments_Get
      tags:
      - Experiments
      summary: Gets an Experiment by ExperimentName
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The Profile identifier associated with the Tenant and Partner
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      - name: experimentName
        in: path
        description: The Experiment identifier associated with the Experiment
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Experiments_CreateOrUpdate
      tags:
      - Experiments
      summary: Creates or updates an Experiment
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The Profile identifier associated with the Tenant and Partner
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      - name: experimentName
        in: path
        description: The Experiment identifier associated with the Experiment
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      responses:
        '200':
          description: Resource 'Experiment' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        '201':
          description: Resource 'Experiment' create operation succeeded
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Experiment'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Experiment'
        description: The Experiment resource
        required: true
    patch:
      operationId: Experiments_Update
      tags:
      - Experiments
      summary: Updates an Experiment by Experiment id
      description: Updates an Experiment
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The Profile identifier associated with the Tenant and Partner
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      - name: experimentName
        in: path
        description: The Experiment identifier associated with the Experiment
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Experiment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Experiment'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperimentUpdateModel'
        description: The Experiment Update Model
        required: true
    delete:
      operationId: Experiments_Delete
      tags:
      - Experiments
      summary: Deletes an Experiment
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: profileName
        in: path
        description: The Profile identifier associated with the Tenant and Partner
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      - name: experimentName
        in: path
        description: The Experiment identifier associated with the Experiment
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
components:
  schemas:
    ExperimentUpdateModel:
      type: object
      description: Defines modifiable attributes of an Experiment
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/ExperimentUpdateProperties'
          description: The properties of a Profile
          x-ms-client-flatten: true
    Resource:
      type: object
      description: Common resource representation.
      properties:
        id:
          type: string
          description: Resource ID.
          readOnly: true
        name:
          type: string
          description: Resource name.
          readOnly: true
        type:
          type: string
          description: Resource type.
          readOnly: true
        location:
          type: string
          description: Resource location.
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
      x-ms-azure-resource: true
    ExperimentProperties:
      type: object
      description: Defines the properties of an experiment
      properties:
        description:
          type: string
          description: The description of the details or intents of the Experiment
        endpointA:
          $ref: '#/components/schemas/Endpoint'
          description: The endpoint A of an experiment
        endpointB:
          $ref: '#/components/schemas/Endpoint'
          description: The endpoint B of an experiment
        enabledState:
          $ref: '#/components/schemas/State'
          description: The state of the Experiment
        resourceState:
          $ref: '#/components/schemas/NetworkExperimentResourceState'
          description: Resource status.
          readOnly: true
        status:
          type: string
          description: The description of Experiment status from the server side
          readOnly: true
        scriptFileUri:
          type: string
          description: The uri to the Script used in the Experiment
          readOnly: true
    Endpoint:
      type: object
      description: Defines the endpoint properties
      properties:
        name:
          type: string
          description: The name of the endpoint
        endpoint:
          type: string
          description: The endpoint URL
    Experiment:
      type: object
      description: Defines the properties of an Experiment
      properties:
        properties:
          $ref: '#/components/schemas/ExperimentProperties'
          description: The properties of an Experiment
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/Resource'
    NetworkExperimentResourceState:
      type: string
      description: Defines the server side resource status
      enum:
      - Creating
      - Enabling
      - Enabled
      - Disabling
      - Disabled
      - Deleting
      x-ms-enum:
        name: NetworkExperimentResourceState
        modelAsString: true
        values:
        - name: Creating
          value: Creating
          description: Creating
        - name: Enabling
          value: Enabling
          description: Enabling
        - name: Enabled
          value: Enabled
          description: Enabled
        - name: Disabling
          value: Disabling
          description: Disabling
        - name: Disabled
          value: Disabled
          description: Disabled
        - name: Deleting
          value: Deleting
          description: Deleting
    ErrorResponse:
      type: object
      description: Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
      properties:
        code:
          type: string
          description: Error code.
          readOnly: true
        message:
          type: string
          description: Error message indicating why the operation failed.
          readOnly: true
    State:
      type: string
      description: The state of the Experiment
      enum:
      - Enabled
      - Disabled
      x-ms-enum:
        name: State
        modelAsString: true
        values:
        - name: Enabled
          value: Enabled
          description: Enabled
        - name: Disabled
          value: Disabled
          description: Disabled
    ExperimentList:
      type: object
      description: Defines a list of Experiments. It contains a list of Experiment objects and a URL link to get the next set of results.
      properties:
        value:
          type: array
          description: The Experiment items on this page
          items:
            $ref: '#/components/schemas/Experiment'
          readOnly: true
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExperimentUpdateProperties:
      type: object
      description: Defines the properties of an experiment
      properties:
        description:
          type: string
          description: The description of the intent or details of the Experiment
        enabledState:
          $ref: '#/components/schemas/State'
          description: The state of the Experiment
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    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
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription.
      required: true
      schema:
        type: string
        minLength: 1
  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.