@azure/arm-durabletask 1.0.0-beta.2 → 1.0.0

package/review/arm-durabletask.api.md

@@ -1,367 +0,0 @@
-## API Report File for "@azure/arm-durabletask"
-
-> 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 (undocumented)
-export class DurableTaskClient {
-    constructor(credential: TokenCredential, subscriptionId: string, options?: DurableTaskClientOptionalParams);
-    readonly operations: OperationsOperations;
-    readonly pipeline: Pipeline;
-    readonly retentionPolicies: RetentionPoliciesOperations;
-    readonly schedulers: SchedulersOperations;
-    readonly taskHubs: TaskHubsOperations;
-}
-
-// @public
-export interface DurableTaskClientOptionalParams extends ClientOptions {
-    apiVersion?: 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 enum KnownActionType {
-    Internal = "Internal"
-}
-
-// @public
-export enum KnownCreatedByType {
-    Application = "Application",
-    Key = "Key",
-    ManagedIdentity = "ManagedIdentity",
-    User = "User"
-}
-
-// @public
-export enum KnownOrigin {
-    System = "system",
-    User = "user",
-    UserSystem = "user,system"
-}
-
-// @public
-export enum KnownProvisioningState {
-    Accepted = "Accepted",
-    Canceled = "Canceled",
-    Deleting = "Deleting",
-    Failed = "Failed",
-    Provisioning = "Provisioning",
-    Succeeded = "Succeeded",
-    Updating = "Updating"
-}
-
-// @public
-export enum KnownPurgeableOrchestrationState {
-    Canceled = "Canceled",
-    Completed = "Completed",
-    Failed = "Failed",
-    Terminated = "Terminated"
-}
-
-// @public
-export enum KnownRedundancyState {
-    None = "None",
-    Zone = "Zone"
-}
-
-// @public
-export enum KnownVersions {
-    V20241001Preview = "2024-10-01-preview",
-    V20250401Preview = "2025-04-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
-export type ProvisioningState = string;
-
-// @public
-export interface ProxyResource extends Resource {
-}
-
-// @public
-export type PurgeableOrchestrationState = string;
-
-// @public
-export type RedundancyState = 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: DurableTaskClient, 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 RetentionPoliciesCreateOrReplaceOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface RetentionPoliciesDeleteOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface RetentionPoliciesGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface RetentionPoliciesListBySchedulerOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface RetentionPoliciesOperations {
-    createOrReplace: (resourceGroupName: string, schedulerName: string, resource: RetentionPolicy, options?: RetentionPoliciesCreateOrReplaceOptionalParams) => PollerLike<OperationState<RetentionPolicy>, RetentionPolicy>;
-    delete: (resourceGroupName: string, schedulerName: string, options?: RetentionPoliciesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
-    get: (resourceGroupName: string, schedulerName: string, options?: RetentionPoliciesGetOptionalParams) => Promise<RetentionPolicy>;
-    listByScheduler: (resourceGroupName: string, schedulerName: string, options?: RetentionPoliciesListBySchedulerOptionalParams) => PagedAsyncIterableIterator<RetentionPolicy>;
-    update: (resourceGroupName: string, schedulerName: string, properties: RetentionPolicy, options?: RetentionPoliciesUpdateOptionalParams) => PollerLike<OperationState<RetentionPolicy>, RetentionPolicy>;
-}
-
-// @public
-export interface RetentionPoliciesUpdateOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface RetentionPolicy extends ProxyResource {
-    properties?: RetentionPolicyProperties;
-}
-
-// @public
-export interface RetentionPolicyDetails {
-    orchestrationState?: PurgeableOrchestrationState;
-    retentionPeriodInDays: number;
-}
-
-// @public
-export interface RetentionPolicyProperties {
-    readonly provisioningState?: ProvisioningState;
-    retentionPolicies?: RetentionPolicyDetails[];
-}
-
-// @public
-export interface Scheduler extends TrackedResource {
-    properties?: SchedulerProperties;
-}
-
-// @public
-export interface SchedulerProperties {
-    readonly endpoint?: string;
-    ipAllowlist: string[];
-    readonly provisioningState?: ProvisioningState;
-    sku: SchedulerSku;
-}
-
-// @public
-export interface SchedulerPropertiesUpdate {
-    readonly endpoint?: string;
-    ipAllowlist?: string[];
-    readonly provisioningState?: ProvisioningState;
-    sku?: SchedulerSkuUpdate;
-}
-
-// @public
-export interface SchedulersCreateOrUpdateOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface SchedulersDeleteOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface SchedulersGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface SchedulerSku {
-    capacity?: number;
-    name: string;
-    readonly redundancyState?: RedundancyState;
-}
-
-// @public
-export interface SchedulerSkuUpdate {
-    capacity?: number;
-    name?: string;
-    readonly redundancyState?: RedundancyState;
-}
-
-// @public
-export interface SchedulersListByResourceGroupOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface SchedulersListBySubscriptionOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface SchedulersOperations {
-    createOrUpdate: (resourceGroupName: string, schedulerName: string, resource: Scheduler, options?: SchedulersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Scheduler>, Scheduler>;
-    delete: (resourceGroupName: string, schedulerName: string, options?: SchedulersDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
-    get: (resourceGroupName: string, schedulerName: string, options?: SchedulersGetOptionalParams) => Promise<Scheduler>;
-    listByResourceGroup: (resourceGroupName: string, options?: SchedulersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Scheduler>;
-    listBySubscription: (options?: SchedulersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Scheduler>;
-    update: (resourceGroupName: string, schedulerName: string, properties: SchedulerUpdate, options?: SchedulersUpdateOptionalParams) => PollerLike<OperationState<Scheduler>, Scheduler>;
-}
-
-// @public
-export interface SchedulersUpdateOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface SchedulerUpdate {
-    properties?: SchedulerPropertiesUpdate;
-    tags?: Record<string, string>;
-}
-
-// @public
-export interface SystemData {
-    createdAt?: Date;
-    createdBy?: string;
-    createdByType?: CreatedByType;
-    lastModifiedAt?: Date;
-    lastModifiedBy?: string;
-    lastModifiedByType?: CreatedByType;
-}
-
-// @public
-export interface TaskHub extends ProxyResource {
-    properties?: TaskHubProperties;
-}
-
-// @public
-export interface TaskHubProperties {
-    readonly dashboardUrl?: string;
-    readonly provisioningState?: ProvisioningState;
-}
-
-// @public
-export interface TaskHubsCreateOrUpdateOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface TaskHubsDeleteOptionalParams extends OperationOptions {
-    updateIntervalInMs?: number;
-}
-
-// @public
-export interface TaskHubsGetOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface TaskHubsListBySchedulerOptionalParams extends OperationOptions {
-}
-
-// @public
-export interface TaskHubsOperations {
-    createOrUpdate: (resourceGroupName: string, schedulerName: string, taskHubName: string, resource: TaskHub, options?: TaskHubsCreateOrUpdateOptionalParams) => PollerLike<OperationState<TaskHub>, TaskHub>;
-    delete: (resourceGroupName: string, schedulerName: string, taskHubName: string, options?: TaskHubsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
-    get: (resourceGroupName: string, schedulerName: string, taskHubName: string, options?: TaskHubsGetOptionalParams) => Promise<TaskHub>;
-    listByScheduler: (resourceGroupName: string, schedulerName: string, options?: TaskHubsListBySchedulerOptionalParams) => PagedAsyncIterableIterator<TaskHub>;
-}
-
-// @public
-export interface TrackedResource extends Resource {
-    location: string;
-    tags?: Record<string, string>;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```