@azure/arm-onlineexperimentation 1.0.0-alpha.20250509.1

package/review/arm-onlineexperimentation.api.md

@@ -0,0 +1,307 @@
+## API Report File for "@azure/arm-onlineexperimentation"
+
+> 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 ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface CustomerManagedKeyEncryption {
+    keyEncryptionKeyIdentity?: KeyEncryptionKeyIdentity;
+    keyEncryptionKeyUrl?: string;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, 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 KeyEncryptionKeyIdentity {
+    federatedClientId?: string;
+    identityType?: KeyEncryptionKeyIdentityType;
+    userAssignedIdentityResourceId?: string;
+}
+
+// @public
+export type KeyEncryptionKeyIdentityType = string;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownKeyEncryptionKeyIdentityType {
+    SystemAssignedIdentity = "SystemAssignedIdentity",
+    UserAssignedIdentity = "UserAssignedIdentity"
+}
+
+// @public
+export enum KnownManagedServiceIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned",
+    SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownOnlineExperimentationWorkspaceSkuName {
+    D0 = "D0",
+    F0 = "F0",
+    P0 = "P0",
+    S0 = "S0"
+}
+
+// @public
+export enum KnownOnlineExperimentationWorkspaceSkuTier {
+    Developer = "Developer",
+    Free = "Free",
+    Premium = "Premium",
+    Standard = "Standard"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownResourceProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownVersions {
+    V20250531Preview = "2025-05-31-preview"
+}
+
+// @public
+export interface ManagedServiceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ManagedServiceIdentityType;
+    userAssignedIdentities?: Record<string, UserAssignedIdentity | null>;
+}
+
+// @public
+export type ManagedServiceIdentityType = string;
+
+// @public (undocumented)
+export class OnlineExperimentationClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: OnlineExperimentationClientOptionalParams);
+    readonly onlineExperimentWorkspaces: OnlineExperimentWorkspacesOperations;
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+}
+
+// @public
+export interface OnlineExperimentationClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface OnlineExperimentationWorkspaceSku {
+    name: OnlineExperimentationWorkspaceSkuName;
+    readonly tier?: OnlineExperimentationWorkspaceSkuTier;
+}
+
+// @public
+export type OnlineExperimentationWorkspaceSkuName = string;
+
+// @public
+export type OnlineExperimentationWorkspaceSkuTier = string;
+
+// @public
+export interface OnlineExperimentWorkspace extends TrackedResource {
+    identity?: ManagedServiceIdentity;
+    properties?: OnlineExperimentWorkspaceProperties;
+    sku?: OnlineExperimentationWorkspaceSku;
+}
+
+// @public
+export interface OnlineExperimentWorkspaceProperties {
+    appConfigurationResourceId: string;
+    encryption?: ResourceEncryptionConfiguration;
+    readonly endpoint?: string;
+    logAnalyticsWorkspaceResourceId: string;
+    logsExporterStorageAccountResourceId: string;
+    readonly provisioningState?: ResourceProvisioningState;
+    readonly workspaceId?: string;
+}
+
+// @public
+export interface OnlineExperimentWorkspacesCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OnlineExperimentWorkspacesDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OnlineExperimentWorkspacesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OnlineExperimentWorkspacesListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OnlineExperimentWorkspacesListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OnlineExperimentWorkspacesOperations {
+    createOrUpdate: (resourceGroupName: string, workspaceName: string, resource: OnlineExperimentWorkspace, options?: OnlineExperimentWorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<OnlineExperimentWorkspace>, OnlineExperimentWorkspace>;
+    delete: (resourceGroupName: string, workspaceName: string, options?: OnlineExperimentWorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, workspaceName: string, options?: OnlineExperimentWorkspacesGetOptionalParams) => Promise<OnlineExperimentWorkspace>;
+    listByResourceGroup: (resourceGroupName: string, options?: OnlineExperimentWorkspacesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<OnlineExperimentWorkspace>;
+    listBySubscription: (options?: OnlineExperimentWorkspacesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<OnlineExperimentWorkspace>;
+    update: (resourceGroupName: string, workspaceName: string, properties: OnlineExperimentWorkspace, options?: OnlineExperimentWorkspacesUpdateOptionalParams) => PollerLike<OperationState<OnlineExperimentWorkspace>, OnlineExperimentWorkspace>;
+}
+
+// @public
+export interface OnlineExperimentWorkspacesUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @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
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceEncryptionConfiguration {
+    customerManagedKeyEncryption?: CustomerManagedKeyEncryption;
+}
+
+// @public
+export type ResourceProvisioningState = string;
+
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: OnlineExperimentationClient, 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>;
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```