@azure/arm-storageactions 1.0.0-beta.1 → 1.0.0

package/review/arm-storageactions.api.md

@@ -4,15 +4,23 @@
 
 ```ts
 
-import * as coreAuth from '@azure/core-auth';
-import * as coreClient from '@azure/core-client';
+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 { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { SimplePollerLike } 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;
 
@@ -23,7 +31,7 @@ export interface ElseCondition {
 
 // @public
 export interface ErrorAdditionalInfo {
-    readonly info?: Record<string, unknown>;
+    readonly info?: any;
     readonly type?: string;
 }
 
@@ -41,9 +49,6 @@ export interface ErrorResponse {
     error?: ErrorDetail;
 }
 
-// @public
-export function getContinuationToken(page: unknown): string | undefined;
-
 // @public
 export interface IfCondition {
     condition: string;
@@ -73,11 +78,26 @@ export enum KnownManagedServiceIdentityType {
 
 // @public
 export enum KnownMatchedBlockName {
+    // (undocumented)
     Else = "Else",
+    // (undocumented)
     If = "If",
+    // (undocumented)
     None = "None"
 }
 
+// @public
+export enum KnownOnFailure {
+    // (undocumented)
+    Break = "break"
+}
+
+// @public
+export enum KnownOnSuccess {
+    // (undocumented)
+    Continue = "continue"
+}
+
 // @public
 export enum KnownOrigin {
     System = "system",
@@ -85,37 +105,71 @@ export enum KnownOrigin {
     UserSystem = "user,system"
 }
 
+// @public
+export enum KnownProvisioningState {
+    // (undocumented)
+    Accepted = "Accepted",
+    // (undocumented)
+    Canceled = "Canceled",
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Succeeded = "Succeeded",
+    // (undocumented)
+    ValidateSubscriptionQuotaBegin = "ValidateSubscriptionQuotaBegin",
+    // (undocumented)
+    ValidateSubscriptionQuotaEnd = "ValidateSubscriptionQuotaEnd"
+}
+
 // @public
 export enum KnownRunResult {
+    // (undocumented)
     Failed = "Failed",
+    // (undocumented)
     Succeeded = "Succeeded"
 }
 
 // @public
 export enum KnownRunStatusEnum {
+    // (undocumented)
     Finished = "Finished",
+    // (undocumented)
     InProgress = "InProgress"
 }
 
 // @public
 export enum KnownStorageTaskOperationName {
+    // (undocumented)
     DeleteBlob = "DeleteBlob",
+    // (undocumented)
     SetBlobExpiry = "SetBlobExpiry",
+    // (undocumented)
     SetBlobImmutabilityPolicy = "SetBlobImmutabilityPolicy",
+    // (undocumented)
     SetBlobLegalHold = "SetBlobLegalHold",
+    // (undocumented)
     SetBlobTags = "SetBlobTags",
+    // (undocumented)
     SetBlobTier = "SetBlobTier",
+    // (undocumented)
     UndeleteBlob = "UndeleteBlob"
 }
 
+// @public
+export enum KnownVersions {
+    V20230101 = "2023-01-01"
+}
+
 // @public
 export interface ManagedServiceIdentity {
     readonly principalId?: string;
     readonly tenantId?: string;
     type: ManagedServiceIdentityType;
-    userAssignedIdentities?: {
-        [propertyName: string]: UserAssignedIdentity | null;
-    };
+    userAssignedIdentities?: Record<string, UserAssignedIdentity | null>;
 }
 
 // @public
@@ -124,6 +178,12 @@ export type ManagedServiceIdentityType = string;
 // @public
 export type MatchedBlockName = string;
 
+// @public
+export type OnFailure = string;
+
+// @public
+export type OnSuccess = string;
+
 // @public
 export interface Operation {
     readonly actionType?: ActionType;
@@ -142,35 +202,31 @@ export interface OperationDisplay {
 }
 
 // @public
-export interface OperationListResult {
-    readonly nextLink?: string;
-    readonly value?: Operation[];
-}
-
-// @public
-export interface Operations {
-    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+export interface OperationsListOptionalParams extends OperationOptions {
 }
 
 // @public
-export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
 }
 
 // @public
-export type OperationsListNextResponse = OperationListResult;
+export type Origin = string;
 
 // @public
-export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+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 type OperationsListResponse = OperationListResult;
-
-// @public
-export type Origin = string;
+export interface PageSettings {
+    continuationToken?: string;
+}
 
 // @public
-export type ProvisioningState = "ValidateSubscriptionQuotaBegin" | "ValidateSubscriptionQuotaEnd" | "Creating" | "Succeeded" | "Deleting" | "Canceled" | "Failed";
+export type ProvisioningState = string;
 
 // @public
 export interface ProxyResource extends Resource {
@@ -184,6 +240,16 @@ export interface Resource {
     readonly type?: string;
 }
 
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: StorageActionsManagementClient, 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 type RunResult = string;
 
@@ -191,35 +257,24 @@ export type RunResult = string;
 export type RunStatusEnum = string;
 
 // @public (undocumented)
-export class StorageActionsManagementClient extends coreClient.ServiceClient {
-    // (undocumented)
-    $host: string;
-    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: StorageActionsManagementClientOptionalParams);
-    // (undocumented)
-    apiVersion: string;
-    // (undocumented)
-    operations: Operations;
-    // (undocumented)
-    storageTaskAssignmentOperations: StorageTaskAssignmentOperations;
-    // (undocumented)
-    storageTasks: StorageTasks;
-    // (undocumented)
-    storageTasksReport: StorageTasksReport;
-    // (undocumented)
-    subscriptionId: string;
+export class StorageActionsManagementClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: StorageActionsManagementClientOptionalParams);
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+    readonly storageTaskAssignment: StorageTaskAssignmentOperations;
+    readonly storageTasks: StorageTasksOperations;
+    readonly storageTasksReport: StorageTasksReportOperations;
 }
 
 // @public
-export interface StorageActionsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
-    $host?: string;
+export interface StorageActionsManagementClientOptionalParams extends ClientOptions {
     apiVersion?: string;
-    endpoint?: string;
 }
 
 // @public
 export interface StorageTask extends TrackedResource {
-    identity?: ManagedServiceIdentity;
-    properties?: StorageTaskProperties;
+    identity: ManagedServiceIdentity;
+    properties: StorageTaskProperties;
 }
 
 // @public
@@ -234,39 +289,21 @@ export interface StorageTaskAssignment {
 }
 
 // @public
-export interface StorageTaskAssignmentListNextOptionalParams extends coreClient.OperationOptions {
+export interface StorageTaskAssignmentListOptionalParams extends OperationOptions {
+    maxpagesize?: number;
 }
 
-// @public
-export type StorageTaskAssignmentListNextResponse = StorageTaskAssignmentsListResult;
-
-// @public
-export interface StorageTaskAssignmentListOptionalParams extends coreClient.OperationOptions {
-    maxpagesize?: string;
-}
-
-// @public
-export type StorageTaskAssignmentListResponse = StorageTaskAssignmentsListResult;
-
 // @public
 export interface StorageTaskAssignmentOperations {
-    list(resourceGroupName: string, storageTaskName: string, options?: StorageTaskAssignmentListOptionalParams): PagedAsyncIterableIterator<StorageTaskAssignment>;
-}
-
-// @public
-export interface StorageTaskAssignmentsListResult {
-    readonly nextLink?: string;
-    readonly value?: StorageTaskAssignment[];
+    list: (resourceGroupName: string, storageTaskName: string, options?: StorageTaskAssignmentListOptionalParams) => PagedAsyncIterableIterator<StorageTaskAssignment>;
 }
 
 // @public
 export interface StorageTaskOperation {
     name: StorageTaskOperationName;
-    onFailure?: "break";
-    onSuccess?: "continue";
-    parameters?: {
-        [propertyName: string]: string;
-    };
+    onFailure?: OnFailure;
+    onSuccess?: OnSuccess;
+    parameters?: Record<string, string>;
 }
 
 // @public
@@ -350,146 +387,73 @@ export interface StorageTaskReportProperties {
 }
 
 // @public
-export interface StorageTaskReportSummary {
-    readonly nextLink?: string;
-    readonly value?: StorageTaskReportInstance[];
-}
-
-// @public
-export interface StorageTasks {
-    beginCreate(resourceGroupName: string, storageTaskName: string, parameters: StorageTask, options?: StorageTasksCreateOptionalParams): Promise<SimplePollerLike<OperationState<StorageTasksCreateResponse>, StorageTasksCreateResponse>>;
-    beginCreateAndWait(resourceGroupName: string, storageTaskName: string, parameters: StorageTask, options?: StorageTasksCreateOptionalParams): Promise<StorageTasksCreateResponse>;
-    beginDelete(resourceGroupName: string, storageTaskName: string, options?: StorageTasksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<StorageTasksDeleteResponse>, StorageTasksDeleteResponse>>;
-    beginDeleteAndWait(resourceGroupName: string, storageTaskName: string, options?: StorageTasksDeleteOptionalParams): Promise<StorageTasksDeleteResponse>;
-    beginUpdate(resourceGroupName: string, storageTaskName: string, parameters: StorageTaskUpdateParameters, options?: StorageTasksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StorageTasksUpdateResponse>, StorageTasksUpdateResponse>>;
-    beginUpdateAndWait(resourceGroupName: string, storageTaskName: string, parameters: StorageTaskUpdateParameters, options?: StorageTasksUpdateOptionalParams): Promise<StorageTasksUpdateResponse>;
-    get(resourceGroupName: string, storageTaskName: string, options?: StorageTasksGetOptionalParams): Promise<StorageTasksGetResponse>;
-    listByResourceGroup(resourceGroupName: string, options?: StorageTasksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StorageTask>;
-    listBySubscription(options?: StorageTasksListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StorageTask>;
-    previewActions(location: string, parameters: StorageTaskPreviewAction, options?: StorageTasksPreviewActionsOptionalParams): Promise<StorageTasksPreviewActionsResponse>;
-}
-
-// @public
-export interface StorageTasksCreateHeaders {
-    // (undocumented)
-    location?: string;
-}
-
-// @public
-export interface StorageTasksCreateOptionalParams extends coreClient.OperationOptions {
-    resumeFrom?: string;
+export interface StorageTasksCreateOptionalParams extends OperationOptions {
     updateIntervalInMs?: number;
 }
 
 // @public
-export type StorageTasksCreateResponse = StorageTask;
-
-// @public
-export interface StorageTasksDeleteHeaders {
-    // (undocumented)
-    location?: string;
-}
-
-// @public
-export interface StorageTasksDeleteOptionalParams extends coreClient.OperationOptions {
-    resumeFrom?: string;
+export interface StorageTasksDeleteOptionalParams extends OperationOptions {
     updateIntervalInMs?: number;
 }
 
 // @public
-export type StorageTasksDeleteResponse = StorageTasksDeleteHeaders;
-
-// @public
-export interface StorageTasksGetOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type StorageTasksGetResponse = StorageTask;
-
-// @public
-export interface StorageTasksListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type StorageTasksListByResourceGroupNextResponse = StorageTasksListResult;
-
-// @public
-export interface StorageTasksListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+export interface StorageTasksGetOptionalParams extends OperationOptions {
 }
 
 // @public
-export type StorageTasksListByResourceGroupResponse = StorageTasksListResult;
-
-// @public
-export interface StorageTasksListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+export interface StorageTasksListByResourceGroupOptionalParams extends OperationOptions {
 }
 
 // @public
-export type StorageTasksListBySubscriptionNextResponse = StorageTasksListResult;
-
-// @public
-export interface StorageTasksListBySubscriptionOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type StorageTasksListBySubscriptionResponse = StorageTasksListResult;
-
-// @public
-export interface StorageTasksListResult {
-    readonly nextLink?: string;
-    readonly value?: StorageTask[];
+export interface StorageTasksListBySubscriptionOptionalParams extends OperationOptions {
 }
 
 // @public
-export interface StorageTasksPreviewActionsOptionalParams extends coreClient.OperationOptions {
+export interface StorageTasksOperations {
+    create: (resourceGroupName: string, storageTaskName: string, parameters: StorageTask, options?: StorageTasksCreateOptionalParams) => PollerLike<OperationState<StorageTask>, StorageTask>;
+    delete: (resourceGroupName: string, storageTaskName: string, options?: StorageTasksDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, storageTaskName: string, options?: StorageTasksGetOptionalParams) => Promise<StorageTask>;
+    listByResourceGroup: (resourceGroupName: string, options?: StorageTasksListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<StorageTask>;
+    listBySubscription: (options?: StorageTasksListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<StorageTask>;
+    previewActions: (location: string, parameters: StorageTaskPreviewAction, options?: StorageTasksPreviewActionsOptionalParams) => Promise<StorageTaskPreviewAction>;
+    update: (resourceGroupName: string, storageTaskName: string, parameters: StorageTaskUpdateParameters, options?: StorageTasksUpdateOptionalParams) => PollerLike<OperationState<StorageTask>, StorageTask>;
 }
 
 // @public
-export type StorageTasksPreviewActionsResponse = StorageTaskPreviewAction;
-
-// @public
-export interface StorageTasksReport {
-    list(resourceGroupName: string, storageTaskName: string, options?: StorageTasksReportListOptionalParams): PagedAsyncIterableIterator<StorageTaskReportInstance>;
+export interface StorageTasksPreviewActionsOptionalParams extends OperationOptions {
 }
 
 // @public
-export interface StorageTasksReportListNextOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type StorageTasksReportListNextResponse = StorageTaskReportSummary;
-
-// @public
-export interface StorageTasksReportListOptionalParams extends coreClient.OperationOptions {
+export interface StorageTasksReportListOptionalParams extends OperationOptions {
     filter?: string;
-    maxpagesize?: string;
+    maxpagesize?: number;
 }
 
 // @public
-export type StorageTasksReportListResponse = StorageTaskReportSummary;
-
-// @public
-export interface StorageTasksUpdateHeaders {
-    // (undocumented)
-    location?: string;
+export interface StorageTasksReportOperations {
+    list: (resourceGroupName: string, storageTaskName: string, options?: StorageTasksReportListOptionalParams) => PagedAsyncIterableIterator<StorageTaskReportInstance>;
 }
 
 // @public
-export interface StorageTasksUpdateOptionalParams extends coreClient.OperationOptions {
-    resumeFrom?: string;
+export interface StorageTasksUpdateOptionalParams extends OperationOptions {
     updateIntervalInMs?: number;
 }
 
-// @public
-export type StorageTasksUpdateResponse = StorageTask;
-
 // @public
 export interface StorageTaskUpdateParameters {
     identity?: ManagedServiceIdentity;
-    properties?: StorageTaskProperties;
-    tags?: {
-        [propertyName: string]: string;
-    };
+    properties?: StorageTaskUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface StorageTaskUpdateProperties {
+    action?: StorageTaskAction;
+    readonly creationTimeInUtc?: Date;
+    description?: string;
+    enabled?: boolean;
+    readonly provisioningState?: ProvisioningState;
+    readonly taskVersion?: number;
 }
 
 // @public
@@ -505,9 +469,7 @@ export interface SystemData {
 // @public
 export interface TrackedResource extends Resource {
     location: string;
-    tags?: {
-        [propertyName: string]: string;
-    };
+    tags?: Record<string, string>;
 }
 
 // @public