Microsoft Playwright Quotas API

openapi: 3.2.0
info:
  title: Microsoft Playwright Quotas API
  version: '2024-12-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Quotas across 2 of this provider''s published API definitions: microsoft-playwright-azure-playwright-service-2024-12-01.json, microsoft-playwright-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Quotas
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/locations/{location}/quotas:
    get:
      operationId: Quotas_ListBySubscription
      tags:
      - Quotas
      description: List quotas for a given subscription Id.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: location
        in: path
        description: The location of quota in ARM Normalized format like eastus, southeastasia etc.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Quotas_ListBySubscription:
          $ref: ./examples/Quotas_ListBySubscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Quotas list by subscription
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.AzurePlaywrightService/locations/{location}/quotas/{quotaName}:
    get:
      operationId: Quotas_Get
      tags:
      - Quotas
      description: Get subscription quota by name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - name: location
        in: path
        description: The location of quota in ARM Normalized format like eastus, southeastasia etc.
        required: true
        schema:
          type: string
      - name: quotaName
        in: path
        description: The quota name.
        required: true
        x-ms-enum:
          name: QuotaNames
          modelAsString: true
          values:
          - name: ScalableExecution
            value: ScalableExecution
            description: The quota details for scalable execution feature. When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations.
          - name: Reporting
            value: Reporting
            description: The quota details for reporting feature. When enabled, Playwright client will be able to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.
        schema:
          type: string
          enum:
          - ScalableExecution
          - Reporting
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quota'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Quotas_Get:
          $ref: ./examples/Quotas_Get.json
      summary: Quotas get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    QuotaProperties:
      type: object
      description: The subscription quota resource properties.
      properties:
        freeTrial:
          $ref: '#/components/schemas/FreeTrialProperties'
          description: The subscription quota resource free-trial properties.
        offeringType:
          $ref: '#/components/schemas/OfferingType'
          description: Indicates the offering type for the subscription.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
          readOnly: true
    OfferingType:
      type: string
      description: Offering type state.
      enum:
      - NotApplicable
      - PrivatePreview
      - PublicPreview
      - GeneralAvailability
      x-ms-enum:
        name: OfferingType
        modelAsString: true
        values:
        - name: NotApplicable
          value: NotApplicable
          description: The offeringType is NotApplicable.
        - name: PrivatePreview
          value: PrivatePreview
          description: The offeringType is PrivatePreview.
        - name: PublicPreview
          value: PublicPreview
          description: The offeringType is PublicPreview.
        - name: GeneralAvailability
          value: GeneralAvailability
          description: The offeringType is GeneralAvailability.
    Quota:
      type: object
      description: A subscription quota resource.
      properties:
        properties:
          $ref: '#/components/schemas/QuotaProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    QuotaListResult:
      type: object
      description: The response of a Quota list operation.
      properties:
        value:
          type: array
          description: The Quota items on this page
          items:
            $ref: '#/components/schemas/Quota'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    FreeTrialState:
      type: string
      description: The free-trial state.
      enum:
      - Active
      - Expired
      - NotEligible
      - NotRegistered
      x-ms-enum:
        name: FreeTrialState
        modelAsString: true
        values:
        - name: Active
          value: Active
          description: The free-trial is Active.
        - name: Expired
          value: Expired
          description: The free-trial is Expired.
        - name: NotEligible
          value: NotEligible
          description: The free-trial is Not Eligible.
        - name: NotRegistered
          value: NotRegistered
          description: The free-trial is Not Registered.
    FreeTrialProperties:
      type: object
      description: The subscription quota resource free-trial properties.
      properties:
        accountId:
          type: string
          description: The Playwright service account id.
          readOnly: true
        state:
          $ref: '#/components/schemas/FreeTrialState'
          description: The free-trial state.
          readOnly: true
      required:
      - accountId
      - state
    ProvisioningState:
      type: string
      description: The status of the current operation.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Creating
      - Deleting
      - Accepted
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Succeeded
          value: Succeeded
          description: Resource has been created.
        - name: Failed
          value: Failed
          description: Resource creation failed.
        - name: Canceled
          value: Canceled
          description: Resource creation was canceled.
        - name: Creating
          value: Creating
          description: Creation in progress..
        - name: Deleting
          value: Deleting
          description: Deletion in progress..
        - name: Accepted
          value: Accepted
          description: Change accepted for processing..
      readOnly: true
  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.
x-refined-from:
- microsoft-playwright-azure-playwright-service-2024-12-01.json
- microsoft-playwright-management-openapi.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: "Supported Azure Playwright Service API Endpoints (protocol and hostname, for example:\n  https://{region}.api.playwright.microsoft.com)."
    required: true
    type: string