Microsoft Playwright Account Quotas API

openapi: 3.2.0
info:
  title: Microsoft Playwright Account Quotas API
  version: '2024-12-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged AccountQuotas 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: AccountQuotas
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas
  : get:
      operationId: AccountQuotas_ListByAccount
      tags:
      - AccountQuotas
      description: List quotas for a given account.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Name of account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
          pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountQuotaListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        AccountQuotas_ListByAccount:
          $ref: ./examples/AccountQuotas_ListByAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Account quotas list by account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas/{quotaName}
  : get:
      operationId: AccountQuotas_Get
      tags:
      - AccountQuotas
      description: Get quota by name for an account.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: accountName
        in: path
        description: Name of account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 3
          pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$
      - name: quotaName
        in: path
        description: The Playwright service account 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/AccountQuota'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        AccountQuotas_Get:
          $ref: ./examples/AccountQuotas_Get.json
      summary: Account quotas get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    AccountQuotaListResult:
      type: object
      description: The response of a AccountQuota list operation.
      properties:
        value:
          type: array
          description: The AccountQuota items on this page
          items:
            $ref: '#/components/schemas/AccountQuota'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    AccountQuota:
      type: object
      description: A quota resource for a Playwright service account.
      properties:
        properties:
          $ref: '#/components/schemas/AccountQuotaProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    AccountQuotaProperties:
      type: object
      description: The Playwright service account quota resource properties.
      properties:
        freeTrial:
          $ref: '#/components/schemas/AccountFreeTrialProperties'
          description: The Playwright service account quota resource free-trial properties.
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
          readOnly: true
    AccountFreeTrialProperties:
      type: object
      description: The Playwright service account quota resource free-trial properties.
      properties:
        createdAt:
          type: string
          format: date-time
          description: The free-trial createdAt utcDateTime.
          readOnly: true
        expiryAt:
          type: string
          format: date-time
          description: The free-trial expiryAt utcDateTime.
          readOnly: true
        allocatedValue:
          type: integer
          format: int32
          description: The free-trial allocated limit value eg. allocated free minutes.
          readOnly: true
        usedValue:
          type: integer
          format: int32
          description: The free-trial used value eg. used free minutes.
          readOnly: true
        percentageUsed:
          type: number
          format: float
          description: The free-trial percentage used.
          minimum: 0
          maximum: 100
          readOnly: true
      required:
      - createdAt
      - expiryAt
      - allocatedValue
      - usedValue
      - percentageUsed
    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