@azure/arm-storageactions 1.0.0-alpha.20240322.2

package/review/arm-storageactions.api.md

@@ -0,0 +1,521 @@
+## API Report File for "@azure/arm-storageactions"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface ElseCondition {
+    operations: StorageTaskOperation[];
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    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 function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface IfCondition {
+    condition: string;
+    operations: StorageTaskOperation[];
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownManagedServiceIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned",
+    SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownMatchedBlockName {
+    Else = "Else",
+    If = "If",
+    None = "None"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownRunResult {
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownRunStatusEnum {
+    Finished = "Finished",
+    InProgress = "InProgress"
+}
+
+// @public
+export enum KnownStorageTaskOperationName {
+    DeleteBlob = "DeleteBlob",
+    SetBlobExpiry = "SetBlobExpiry",
+    SetBlobImmutabilityPolicy = "SetBlobImmutabilityPolicy",
+    SetBlobLegalHold = "SetBlobLegalHold",
+    SetBlobTags = "SetBlobTags",
+    SetBlobTier = "SetBlobTier",
+    UndeleteBlob = "UndeleteBlob"
+}
+
+// @public
+export interface ManagedServiceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ManagedServiceIdentityType;
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity | null;
+    };
+}
+
+// @public
+export type ManagedServiceIdentityType = string;
+
+// @public
+export type MatchedBlockName = string;
+
+// @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 OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type Origin = string;
+
+// @public
+export type ProvisioningState = "ValidateSubscriptionQuotaBegin" | "ValidateSubscriptionQuotaEnd" | "Creating" | "Succeeded" | "Deleting" | "Canceled" | "Failed";
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export type RunResult = string;
+
+// @public
+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;
+}
+
+// @public
+export interface StorageActionsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface StorageTask extends TrackedResource {
+    identity?: ManagedServiceIdentity;
+    properties?: StorageTaskProperties;
+}
+
+// @public
+export interface StorageTaskAction {
+    else?: ElseCondition;
+    if: IfCondition;
+}
+
+// @public
+export interface StorageTaskAssignment {
+    readonly id?: string;
+}
+
+// @public
+export interface StorageTaskAssignmentListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @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[];
+}
+
+// @public
+export interface StorageTaskOperation {
+    name: StorageTaskOperationName;
+    onFailure?: "break";
+    onSuccess?: "continue";
+    parameters?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type StorageTaskOperationName = string;
+
+// @public
+export interface StorageTaskPreviewAction {
+    properties: StorageTaskPreviewActionProperties;
+}
+
+// @public
+export interface StorageTaskPreviewActionCondition {
+    elseBlockExists: boolean;
+    if: StorageTaskPreviewActionIfCondition;
+}
+
+// @public
+export interface StorageTaskPreviewActionIfCondition {
+    condition?: string;
+}
+
+// @public
+export interface StorageTaskPreviewActionProperties {
+    action: StorageTaskPreviewActionCondition;
+    blobs: StorageTaskPreviewBlobProperties[];
+    container: StorageTaskPreviewContainerProperties;
+}
+
+// @public
+export interface StorageTaskPreviewBlobProperties {
+    readonly matchedBlock?: MatchedBlockName;
+    metadata?: StorageTaskPreviewKeyValueProperties[];
+    name?: string;
+    properties?: StorageTaskPreviewKeyValueProperties[];
+    tags?: StorageTaskPreviewKeyValueProperties[];
+}
+
+// @public
+export interface StorageTaskPreviewContainerProperties {
+    metadata?: StorageTaskPreviewKeyValueProperties[];
+    name?: string;
+}
+
+// @public
+export interface StorageTaskPreviewKeyValueProperties {
+    key?: string;
+    value?: string;
+}
+
+// @public
+export interface StorageTaskProperties {
+    action: StorageTaskAction;
+    readonly creationTimeInUtc?: Date;
+    description: string;
+    enabled: boolean;
+    readonly provisioningState?: ProvisioningState;
+    readonly taskVersion?: number;
+}
+
+// @public
+export interface StorageTaskReportInstance extends ProxyResource {
+    properties?: StorageTaskReportProperties;
+}
+
+// @public
+export interface StorageTaskReportProperties {
+    readonly finishTime?: string;
+    readonly objectFailedCount?: string;
+    readonly objectsOperatedOnCount?: string;
+    readonly objectsSucceededCount?: string;
+    readonly objectsTargetedCount?: string;
+    readonly runResult?: RunResult;
+    readonly runStatusEnum?: RunStatusEnum;
+    readonly runStatusError?: string;
+    readonly startTime?: string;
+    readonly storageAccountId?: string;
+    readonly summaryReportPath?: string;
+    readonly taskAssignmentId?: string;
+    readonly taskId?: string;
+    readonly taskVersion?: string;
+}
+
+// @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;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type StorageTasksCreateResponse = StorageTask;
+
+// @public
+export interface StorageTasksDeleteHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface StorageTasksDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    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 {
+}
+
+// @public
+export type StorageTasksListByResourceGroupResponse = StorageTasksListResult;
+
+// @public
+export interface StorageTasksListBySubscriptionNextOptionalParams extends coreClient.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[];
+}
+
+// @public
+export interface StorageTasksPreviewActionsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StorageTasksPreviewActionsResponse = StorageTaskPreviewAction;
+
+// @public
+export interface StorageTasksReport {
+    list(resourceGroupName: string, storageTaskName: string, options?: StorageTasksReportListOptionalParams): PagedAsyncIterableIterator<StorageTaskReportInstance>;
+}
+
+// @public
+export interface StorageTasksReportListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StorageTasksReportListNextResponse = StorageTaskReportSummary;
+
+// @public
+export interface StorageTasksReportListOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    maxpagesize?: string;
+}
+
+// @public
+export type StorageTasksReportListResponse = StorageTaskReportSummary;
+
+// @public
+export interface StorageTasksUpdateHeaders {
+    // (undocumented)
+    location?: string;
+}
+
+// @public
+export interface StorageTasksUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type StorageTasksUpdateResponse = StorageTask;
+
+// @public
+export interface StorageTaskUpdateParameters {
+    identity?: ManagedServiceIdentity;
+    properties?: StorageTaskProperties;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @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?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/src/index.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export { getContinuationToken } from "./pagingHelper";
+export * from "./models";
+export { StorageActionsManagementClient } from "./storageActionsManagementClient";
+export * from "./operationsInterfaces";

package/src/lroImpl.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { AbortSignalLike } from "@azure/abort-controller";
+import { LongRunningOperation, LroResponse } from "@azure/core-lro";
+
+export function createLroSpec<T>(inputs: {
+  sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>;
+  args: Record<string, unknown>;
+  spec: {
+    readonly requestBody?: unknown;
+    readonly path?: string;
+    readonly httpMethod: string;
+  } & Record<string, any>;
+}): LongRunningOperation<T> {
+  const { args, spec, sendOperationFn } = inputs;
+  return {
+    requestMethod: spec.httpMethod,
+    requestPath: spec.path!,
+    sendInitialRequest: () => sendOperationFn(args, spec),
+    sendPollRequest: (
+      path: string,
+      options?: { abortSignal?: AbortSignalLike },
+    ) => {
+      const { requestBody, ...restSpec } = spec;
+      return sendOperationFn(args, {
+        ...restSpec,
+        httpMethod: "GET",
+        path,
+        abortSignal: options?.abortSignal,
+      });
+    },
+  };
+}