aml Filesystems - Archive

Service:

Storagecache

API Version:

2024-07-01

Archive data from the AML file system.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/archive?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
amlFilesystemName	path	True	string minLength: 2 maxLength: 80 pattern: ^[0-9a-zA-Z][-0-9a-zA-Z_]{0,78}[0-9a-zA-Z]$	Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
filesystemPath	string	Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data.

Responses

Name	Type	Description
200 OK		AML file system has started the archive operation. Poll the AML file system's hsm.archiveStatus field to monitor the progress.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

amlFilesystems_Archive

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/sc/archive?api-version=2024-07-01

{
  "filesystemPath": "/"
}

Sample response

Status code:

200

Definitions

Name	Description
AmlFilesystemArchiveInfo	Information required to execute the archive operation
CloudError	An error response.
CloudErrorBody	An error response.

AmlFilesystemArchiveInfo

Object

Information required to execute the archive operation

Name	Type	Default value	Description
filesystemPath	string	/	Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data.

CloudError

Object

An error response.

Name	Type	Description
error	CloudErrorBody	The body of the error.

CloudErrorBody

Object

An error response.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.