@azure/arm-playwright 1.0.0-beta.1

package/review/arm-playwright.api.md

@@ -0,0 +1,361 @@
+## API Report File for "@azure/arm-playwright"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PathUncheckedResponse } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { PollerLike } from '@azure/core-lro';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type CheckNameAvailabilityReason = string;
+
+// @public
+export interface CheckNameAvailabilityRequest {
+    name?: string;
+    type?: string;
+}
+
+// @public
+export interface CheckNameAvailabilityResponse {
+    message?: string;
+    nameAvailable?: boolean;
+    reason?: CheckNameAvailabilityReason;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export type EnablementStatus = string;
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: any;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface FreeTrialProperties {
+    readonly state: FreeTrialState;
+    readonly workspaceId: string;
+}
+
+// @public
+export type FreeTrialState = string;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCheckNameAvailabilityReason {
+    AlreadyExists = "AlreadyExists",
+    Invalid = "Invalid"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownEnablementStatus {
+    Disabled = "Disabled",
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownFreeTrialState {
+    Active = "Active",
+    Expired = "Expired",
+    NotApplicable = "NotApplicable"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownQuotaName {
+    ExecutionMinutes = "ExecutionMinutes"
+}
+
+// @public
+export enum KnownVersions {
+    V20250701Preview = "2025-07-01-preview"
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public (undocumented)
+export class PlaywrightManagementClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: PlaywrightManagementClientOptionalParams);
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+    readonly playwrightQuotas: PlaywrightQuotasOperations;
+    readonly playwrightWorkspaceQuotas: PlaywrightWorkspaceQuotasOperations;
+    readonly playwrightWorkspaces: PlaywrightWorkspacesOperations;
+}
+
+// @public
+export interface PlaywrightManagementClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface PlaywrightQuota extends ProxyResource {
+    properties?: PlaywrightQuotaProperties;
+}
+
+// @public
+export interface PlaywrightQuotaProperties {
+    readonly freeTrial?: FreeTrialProperties;
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface PlaywrightQuotasGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightQuotasListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightQuotasOperations {
+    get: (location: string, playwrightQuotaName: QuotaName, options?: PlaywrightQuotasGetOptionalParams) => Promise<PlaywrightQuota>;
+    listBySubscription: (location: string, options?: PlaywrightQuotasListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<PlaywrightQuota>;
+}
+
+// @public
+export interface PlaywrightWorkspace extends TrackedResource {
+    properties?: PlaywrightWorkspaceProperties;
+}
+
+// @public
+export interface PlaywrightWorkspaceFreeTrialProperties {
+    readonly allocatedValue: number;
+    readonly createdAt: Date;
+    readonly expiryAt: Date;
+    readonly percentageUsed: number;
+    readonly usedValue: number;
+}
+
+// @public
+export interface PlaywrightWorkspaceProperties {
+    readonly dataplaneUri?: string;
+    localAuth?: EnablementStatus;
+    readonly provisioningState?: ProvisioningState;
+    regionalAffinity?: EnablementStatus;
+}
+
+// @public
+export interface PlaywrightWorkspaceQuota extends ProxyResource {
+    properties?: PlaywrightWorkspaceQuotaProperties;
+}
+
+// @public
+export interface PlaywrightWorkspaceQuotaProperties {
+    readonly freeTrial?: PlaywrightWorkspaceFreeTrialProperties;
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface PlaywrightWorkspaceQuotasGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspaceQuotasListByPlaywrightWorkspaceOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspaceQuotasOperations {
+    get: (resourceGroupName: string, playwrightWorkspaceName: string, quotaName: QuotaName, options?: PlaywrightWorkspaceQuotasGetOptionalParams) => Promise<PlaywrightWorkspaceQuota>;
+    listByPlaywrightWorkspace: (resourceGroupName: string, playwrightWorkspaceName: string, options?: PlaywrightWorkspaceQuotasListByPlaywrightWorkspaceOptionalParams) => PagedAsyncIterableIterator<PlaywrightWorkspaceQuota>;
+}
+
+// @public
+export interface PlaywrightWorkspacesCheckNameAvailabilityOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspacesCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface PlaywrightWorkspacesDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface PlaywrightWorkspacesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspacesListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspacesListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspacesOperations {
+    checkNameAvailability: (body: CheckNameAvailabilityRequest, options?: PlaywrightWorkspacesCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>;
+    createOrUpdate: (resourceGroupName: string, playwrightWorkspaceName: string, resource: PlaywrightWorkspace, options?: PlaywrightWorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<PlaywrightWorkspace>, PlaywrightWorkspace>;
+    delete: (resourceGroupName: string, playwrightWorkspaceName: string, options?: PlaywrightWorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, playwrightWorkspaceName: string, options?: PlaywrightWorkspacesGetOptionalParams) => Promise<PlaywrightWorkspace>;
+    listByResourceGroup: (resourceGroupName: string, options?: PlaywrightWorkspacesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<PlaywrightWorkspace>;
+    listBySubscription: (options?: PlaywrightWorkspacesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<PlaywrightWorkspace>;
+    update: (resourceGroupName: string, playwrightWorkspaceName: string, properties: PlaywrightWorkspaceUpdate, options?: PlaywrightWorkspacesUpdateOptionalParams) => Promise<PlaywrightWorkspace>;
+}
+
+// @public
+export interface PlaywrightWorkspacesUpdateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface PlaywrightWorkspaceUpdate {
+    properties?: PlaywrightWorkspaceUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface PlaywrightWorkspaceUpdateProperties {
+    localAuth?: EnablementStatus;
+    regionalAffinity?: EnablementStatus;
+}
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export type QuotaName = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: PlaywrightManagementClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+
+// @public (undocumented)
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    abortSignal?: AbortSignalLike;
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: Record<string, string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```