@azure/arm-storagecache 7.1.0-beta.1 → 8.0.0

package/src/models/index.ts

@@ -153,8 +153,10 @@ export interface AmlFilesystemHsmSettings {
   container: string;
   /** Resource ID of storage container used for logging events and errors.  Must be a separate container in the same storage account as the hydration and archive container. The resource provider must have permission to create SAS tokens on the storage account. */
   loggingContainer: string;
-  /** Only blobs in the non-logging container that start with this path/prefix get hydrated into the cluster namespace. */
+  /** Only blobs in the non-logging container that start with this path/prefix get imported into the cluster namespace. This is only used during initial creation of the AML file system. It automatically creates an import job resource that can be deleted. */
   importPrefix?: string;
+  /** Only blobs in the non-logging container that start with one of the paths/prefixes in this array get imported into the cluster namespace. This is only used during initial creation of the AML file system and has '/' as the default value. It automatically creates an import job resource that can be deleted. */
+  importPrefixesInitial?: string[];
 }
 
 /** Information about the AML file system archive */
@@ -306,6 +308,69 @@ export interface AmlFilesystemArchiveInfo {
   filesystemPath?: string;
 }
 
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export interface ErrorResponse {
+  /** The error object. */
+  error?: ErrorDetail;
+}
+
+/** The error detail. */
+export interface ErrorDetail {
+  /**
+   * The error code.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly code?: string;
+  /**
+   * The error message.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly message?: string;
+  /**
+   * The error target.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly target?: string;
+  /**
+   * The error details.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly details?: ErrorDetail[];
+  /**
+   * The error additional info.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** The resource management error additional info. */
+export interface ErrorAdditionalInfo {
+  /**
+   * The additional info type.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The additional info.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly info?: Record<string, unknown>;
+}
+
+/** An import job update instance. */
+export interface ImportJobUpdate {
+  /** Resource tags. */
+  tags?: { [propertyName: string]: string };
+}
+
+/** Result of the request to list import jobs. It contains a list of import jobs and a URL link to get the next set of results. */
+export interface ImportJobsListResult {
+  /** URL to get the next set of import job list results, if there are any. */
+  nextLink?: string;
+  /** List of import jobs. */
+  value?: ImportJob[];
+}
+
 /** Information required to validate the subnet that will be used in AML file system create */
 export interface AmlFilesystemSubnetInfo {
   /** Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space. */
@@ -530,13 +595,13 @@ export interface AscOperation {
   /** The status of the operation. */
   status?: string;
   /** The error detail of the operation if any. */
-  error?: ErrorResponse;
+  error?: AscOperationErrorResponse;
   /** Additional operation-specific output. */
   output?: { [propertyName: string]: Record<string, unknown> };
 }
 
 /** Describes the format of Error response. */
-export interface ErrorResponse {
+export interface AscOperationErrorResponse {
   /** Error code */
   code?: string;
   /** Error message indicating why the operation failed. */
@@ -1110,6 +1175,71 @@ export interface AmlFilesystem extends TrackedResource {
   rootSquashSettings?: AmlFilesystemRootSquashSettings;
 }
 
+/** An import job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md */
+export interface ImportJob extends TrackedResource {
+  /**
+   * ARM provisioning state.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly provisioningState?: ImportJobProvisioningStateType;
+  /** An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. */
+  importPrefixes?: string[];
+  /** How the import job will handle conflicts. For example, if the import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or was not previously imported. OverwriteAlways extends OverwriteIfDirty to include releasing files that had been restored but were not dirty. Please reference https://learn.microsoft.com/en-us/azure/azure-managed-lustre/ for a thorough explanation of these resolution modes. */
+  conflictResolutionMode?: ConflictResolutionMode;
+  /** Total non-conflict oriented errors the import job will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately and is the default. */
+  maximumErrors?: number;
+  /**
+   * The state of the import job. InProgress indicates the import is still running. Canceled indicates it has been canceled by the user. Completed indicates import finished, successfully importing all discovered blobs into the Lustre namespace. CompletedPartial indicates the import finished but some blobs either were found to be conflicting and could not be imported or other errors were encountered. Failed means the import was unable to complete due to a fatal error.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly state?: ImportStatusType;
+  /**
+   * The status message of the import job.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly statusMessage?: string;
+  /**
+   * The total blob objects walked.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly totalBlobsWalked?: number;
+  /**
+   * A recent and frequently updated rate of blobs walked per second.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly blobsWalkedPerSecond?: number;
+  /**
+   * The total blobs that have been imported since import began.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly totalBlobsImported?: number;
+  /**
+   * A recent and frequently updated rate of total files, directories, and symlinks imported per second.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly blobsImportedPerSecond?: number;
+  /**
+   * The time of the last completed archive operation
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly lastCompletionTime?: Date;
+  /**
+   * The time the latest archive operation started
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly lastStartedTime?: Date;
+  /**
+   * Number of errors in the import job.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly totalErrors?: number;
+  /**
+   * Number of conflicts in the import job.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly totalConflicts?: number;
+}
+
 /** Defines headers for AmlFilesystems_delete operation. */
 export interface AmlFilesystemsDeleteHeaders {
   /** Location URI to poll for result */
@@ -1132,6 +1262,28 @@ export interface AmlFilesystemsUpdateHeaders {
   azureAsyncOperation?: string;
 }
 
+/** Defines headers for ImportJobs_delete operation. */
+export interface ImportJobsDeleteHeaders {
+  /** Location URI to poll for result */
+  location?: string;
+  /** URI to poll for the operation status */
+  azureAsyncOperation?: string;
+}
+
+/** Defines headers for ImportJobs_createOrUpdate operation. */
+export interface ImportJobsCreateOrUpdateHeaders {
+  /** URI to poll for the operation status */
+  azureAsyncOperation?: string;
+}
+
+/** Defines headers for ImportJobs_update operation. */
+export interface ImportJobsUpdateHeaders {
+  /** URI to poll for the operation status */
+  location?: string;
+  /** URI to poll for the operation status */
+  azureAsyncOperation?: string;
+}
+
 /** Defines headers for Caches_delete operation. */
 export interface CachesDeleteHeaders {
   /** Location URI to poll for result */
@@ -1295,7 +1447,7 @@ export enum KnownAmlFilesystemHealthStateType {
   /** Transitioning */
   Transitioning = "Transitioning",
   /** Maintenance */
-  Maintenance = "Maintenance"
+  Maintenance = "Maintenance",
 }
 
 /**
@@ -1324,7 +1476,7 @@ export enum KnownAmlFilesystemProvisioningStateType {
   /** Updating */
   Updating = "Updating",
   /** Canceled */
-  Canceled = "Canceled"
+  Canceled = "Canceled",
 }
 
 /**
@@ -1358,7 +1510,7 @@ export enum KnownArchiveStatusType {
   /** Cancelling */
   Cancelling = "Cancelling",
   /** FSScanInProgress */
-  FSScanInProgress = "FSScanInProgress"
+  FSScanInProgress = "FSScanInProgress",
 }
 
 /**
@@ -1384,7 +1536,7 @@ export enum KnownAmlFilesystemSquashMode {
   /** RootOnly */
   RootOnly = "RootOnly",
   /** All */
-  All = "All"
+  All = "All",
 }
 
 /**
@@ -1407,7 +1559,7 @@ export enum KnownCreatedByType {
   /** ManagedIdentity */
   ManagedIdentity = "ManagedIdentity",
   /** Key */
-  Key = "Key"
+  Key = "Key",
 }
 
 /**
@@ -1422,12 +1574,96 @@ export enum KnownCreatedByType {
  */
 export type CreatedByType = string;
 
+/** Known values of {@link ImportJobProvisioningStateType} that the service accepts. */
+export enum KnownImportJobProvisioningStateType {
+  /** Succeeded */
+  Succeeded = "Succeeded",
+  /** Failed */
+  Failed = "Failed",
+  /** Creating */
+  Creating = "Creating",
+  /** Deleting */
+  Deleting = "Deleting",
+  /** Updating */
+  Updating = "Updating",
+  /** Canceled */
+  Canceled = "Canceled",
+}
+
+/**
+ * Defines values for ImportJobProvisioningStateType. \
+ * {@link KnownImportJobProvisioningStateType} can be used interchangeably with ImportJobProvisioningStateType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded** \
+ * **Failed** \
+ * **Creating** \
+ * **Deleting** \
+ * **Updating** \
+ * **Canceled**
+ */
+export type ImportJobProvisioningStateType = string;
+
+/** Known values of {@link ConflictResolutionMode} that the service accepts. */
+export enum KnownConflictResolutionMode {
+  /** Fail */
+  Fail = "Fail",
+  /** Skip */
+  Skip = "Skip",
+  /** OverwriteIfDirty */
+  OverwriteIfDirty = "OverwriteIfDirty",
+  /** OverwriteAlways */
+  OverwriteAlways = "OverwriteAlways",
+}
+
+/**
+ * Defines values for ConflictResolutionMode. \
+ * {@link KnownConflictResolutionMode} can be used interchangeably with ConflictResolutionMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Fail** \
+ * **Skip** \
+ * **OverwriteIfDirty** \
+ * **OverwriteAlways**
+ */
+export type ConflictResolutionMode = string;
+
+/** Known values of {@link ImportStatusType} that the service accepts. */
+export enum KnownImportStatusType {
+  /** InProgress */
+  InProgress = "InProgress",
+  /** Cancelling */
+  Cancelling = "Cancelling",
+  /** Canceled */
+  Canceled = "Canceled",
+  /** Completed */
+  Completed = "Completed",
+  /** CompletedPartial */
+  CompletedPartial = "CompletedPartial",
+  /** Failed */
+  Failed = "Failed",
+}
+
+/**
+ * Defines values for ImportStatusType. \
+ * {@link KnownImportStatusType} can be used interchangeably with ImportStatusType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **InProgress** \
+ * **Cancelling** \
+ * **Canceled** \
+ * **Completed** \
+ * **CompletedPartial** \
+ * **Failed**
+ */
+export type ImportStatusType = string;
+
 /** Known values of {@link FilesystemSubnetStatusType} that the service accepts. */
 export enum KnownFilesystemSubnetStatusType {
   /** Ok */
   Ok = "Ok",
   /** Invalid */
-  Invalid = "Invalid"
+  Invalid = "Invalid",
 }
 
 /**
@@ -1455,7 +1691,7 @@ export enum KnownMetricAggregationType {
   /** Total */
   Total = "Total",
   /** Count */
-  Count = "Count"
+  Count = "Count",
 }
 
 /**
@@ -1478,7 +1714,7 @@ export enum KnownReasonCode {
   /** QuotaId */
   QuotaId = "QuotaId",
   /** NotAvailableForSubscription */
-  NotAvailableForSubscription = "NotAvailableForSubscription"
+  NotAvailableForSubscription = "NotAvailableForSubscription",
 }
 
 /**
@@ -1516,7 +1752,7 @@ export enum KnownHealthStateType {
   /** StartFailed */
   StartFailed = "StartFailed",
   /** UpgradeFailed */
-  UpgradeFailed = "UpgradeFailed"
+  UpgradeFailed = "UpgradeFailed",
 }
 
 /**
@@ -1552,7 +1788,7 @@ export enum KnownProvisioningStateType {
   /** Deleting */
   Deleting = "Deleting",
   /** Updating */
-  Updating = "Updating"
+  Updating = "Updating",
 }
 
 /**
@@ -1574,7 +1810,7 @@ export enum KnownFirmwareStatusType {
   /** Available */
   Available = "available",
   /** Unavailable */
-  Unavailable = "unavailable"
+  Unavailable = "unavailable",
 }
 
 /**
@@ -1594,7 +1830,7 @@ export enum KnownNfsAccessRuleScope {
   /** Network */
   Network = "network",
   /** Host */
-  Host = "host"
+  Host = "host",
 }
 
 /**
@@ -1615,7 +1851,7 @@ export enum KnownNfsAccessRuleAccess {
   /** Ro */
   Ro = "ro",
   /** Rw */
-  Rw = "rw"
+  Rw = "rw",
 }
 
 /**
@@ -1636,7 +1872,7 @@ export enum KnownDomainJoinedType {
   /** No */
   No = "No",
   /** Error */
-  Error = "Error"
+  Error = "Error",
 }
 
 /**
@@ -1659,7 +1895,7 @@ export enum KnownUsernameSource {
   /** File */
   File = "File",
   /** None */
-  None = "None"
+  None = "None",
 }
 
 /**
@@ -1681,7 +1917,7 @@ export enum KnownUsernameDownloadedType {
   /** No */
   No = "No",
   /** Error */
-  Error = "Error"
+  Error = "Error",
 }
 
 /**
@@ -1704,7 +1940,7 @@ export enum KnownPrimingJobState {
   /** Paused */
   Paused = "Paused",
   /** Complete */
-  Complete = "Complete"
+  Complete = "Complete",
 }
 
 /**
@@ -1728,7 +1964,7 @@ export enum KnownStorageTargetType {
   /** Unknown */
   Unknown = "unknown",
   /** BlobNfs */
-  BlobNfs = "blobNfs"
+  BlobNfs = "blobNfs",
 }
 
 /**
@@ -1752,7 +1988,7 @@ export enum KnownOperationalStateType {
   /** Suspended */
   Suspended = "Suspended",
   /** Flushing */
-  Flushing = "Flushing"
+  Flushing = "Flushing",
 }
 
 /**
@@ -1796,7 +2032,8 @@ export interface AmlFilesystemsListByResourceGroupOptionalParams
   extends coreClient.OperationOptions {}
 
 /** Contains response data for the listByResourceGroup operation. */
-export type AmlFilesystemsListByResourceGroupResponse = AmlFilesystemsListResult;
+export type AmlFilesystemsListByResourceGroupResponse =
+  AmlFilesystemsListResult;
 
 /** Optional parameters. */
 export interface AmlFilesystemsDeleteOptionalParams
@@ -1861,7 +2098,65 @@ export interface AmlFilesystemsListByResourceGroupNextOptionalParams
   extends coreClient.OperationOptions {}
 
 /** Contains response data for the listByResourceGroupNext operation. */
-export type AmlFilesystemsListByResourceGroupNextResponse = AmlFilesystemsListResult;
+export type AmlFilesystemsListByResourceGroupNextResponse =
+  AmlFilesystemsListResult;
+
+/** Optional parameters. */
+export interface ImportJobsDeleteOptionalParams
+  extends coreClient.OperationOptions {
+  /** Delay to wait until next poll, in milliseconds. */
+  updateIntervalInMs?: number;
+  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+  resumeFrom?: string;
+}
+
+/** Contains response data for the delete operation. */
+export type ImportJobsDeleteResponse = ImportJobsDeleteHeaders;
+
+/** Optional parameters. */
+export interface ImportJobsGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type ImportJobsGetResponse = ImportJob;
+
+/** Optional parameters. */
+export interface ImportJobsCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {
+  /** Delay to wait until next poll, in milliseconds. */
+  updateIntervalInMs?: number;
+  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+  resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export type ImportJobsCreateOrUpdateResponse = ImportJob;
+
+/** Optional parameters. */
+export interface ImportJobsUpdateOptionalParams
+  extends coreClient.OperationOptions {
+  /** Delay to wait until next poll, in milliseconds. */
+  updateIntervalInMs?: number;
+  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+  resumeFrom?: string;
+}
+
+/** Contains response data for the update operation. */
+export type ImportJobsUpdateResponse = ImportJob;
+
+/** Optional parameters. */
+export interface ImportJobsListByAmlFilesystemOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listByAmlFilesystem operation. */
+export type ImportJobsListByAmlFilesystemResponse = ImportJobsListResult;
+
+/** Optional parameters. */
+export interface ImportJobsListByAmlFilesystemNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listByAmlFilesystemNext operation. */
+export type ImportJobsListByAmlFilesystemNextResponse = ImportJobsListResult;
 
 /** Optional parameters. */
 export interface CheckAmlFSSubnetsOptionalParams
@@ -1878,7 +2173,8 @@ export interface GetRequiredAmlFSSubnetsSizeOptionalParams
 }
 
 /** Contains response data for the getRequiredAmlFSSubnetsSize operation. */
-export type GetRequiredAmlFSSubnetsSizeResponse = RequiredAmlFilesystemSubnetsSize;
+export type GetRequiredAmlFSSubnetsSizeResponse =
+  RequiredAmlFilesystemSubnetsSize;
 
 /** Optional parameters. */
 export interface OperationsListOptionalParams