Microsoft.StorageCache (stable:2024-07-01)

2025/03/19 • 8 updated methods

autoExportJobs_Get (updated)
Description :  Returns an auto export job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "autoExportJobs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Enum": {
              "new": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ],
              "old": [
                [
                  "Active",
                  ""
                ],
                [
                  "Cancel",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoExportJobs/{autoExportJobName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
autoExportJobName:
{
Description: Name for the auto export job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the auto export job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoExportPrefixes:
{
Description: An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The status of the auto export ,
Required: False ,
}
{
state:
{
Description: The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error. ,
Enum:
{
InProgress: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
DisableFailed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto export job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto export job. ,
Required: False ,
}
string ,
totalFilesExported:
{
Description: Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMiBExported:
{
Description: Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesFailed:
{
Description: Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
exportIterationCount:
{
Description: Number of iterations completed since the start of the export. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessfulIterationCompletionTimeUTC:
{
Description: Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. ,
Format: date-time ,
Required: False ,
}
string ,
currentIterationFilesDiscovered:
{
Description: Files discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBDiscovered:
{
Description: Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesExported:
{
Description: Files that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBExported:
{
Description: Data (in MiB) that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesFailed:
{
Description: Files failed to export in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto export job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto export job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
autoExportJobs_CreateOrUpdate (updated)
Description :  Create or update an auto export job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "autoExportJobs_CreateOrUpdate",
  "$parameters": {
    "autoExportJob": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Enum": {
              "new": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ],
              "old": [
                [
                  "Active",
                  ""
                ],
                [
                  "Cancel",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Enum": {
              "new": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ],
              "old": [
                [
                  "Active",
                  ""
                ],
                [
                  "Cancel",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Enum": {
              "new": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ],
              "old": [
                [
                  "Active",
                  ""
                ],
                [
                  "Cancel",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoExportJobs/{autoExportJobName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
autoExportJobName:
{
Description: Name for the auto export job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
autoExportJob:
{
Description: Object containing the user-selectable properties of the auto export job. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of the auto export job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoExportPrefixes:
{
Description: An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The status of the auto export ,
Required: False ,
}
{
state:
{
Description: The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error. ,
Enum:
{
InProgress: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
DisableFailed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto export job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto export job. ,
Required: False ,
}
string ,
totalFilesExported:
{
Description: Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMiBExported:
{
Description: Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesFailed:
{
Description: Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
exportIterationCount:
{
Description: Number of iterations completed since the start of the export. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessfulIterationCompletionTimeUTC:
{
Description: Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. ,
Format: date-time ,
Required: False ,
}
string ,
currentIterationFilesDiscovered:
{
Description: Files discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBDiscovered:
{
Description: Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesExported:
{
Description: Files that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBExported:
{
Description: Data (in MiB) that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesFailed:
{
Description: Files failed to export in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto export job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto export job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the auto export job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoExportPrefixes:
{
Description: An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The status of the auto export ,
Required: False ,
}
{
state:
{
Description: The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error. ,
Enum:
{
InProgress: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
DisableFailed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto export job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto export job. ,
Required: False ,
}
string ,
totalFilesExported:
{
Description: Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMiBExported:
{
Description: Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesFailed:
{
Description: Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
exportIterationCount:
{
Description: Number of iterations completed since the start of the export. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessfulIterationCompletionTimeUTC:
{
Description: Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. ,
Format: date-time ,
Required: False ,
}
string ,
currentIterationFilesDiscovered:
{
Description: Files discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBDiscovered:
{
Description: Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesExported:
{
Description: Files that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBExported:
{
Description: Data (in MiB) that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesFailed:
{
Description: Files failed to export in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto export job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto export job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-async-operation:
{
Description: URI to poll for the operation status ,
}
string ,
}
,
$schema:
{
Description: An auto export job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md ,
}
{
properties:
{
Description: Properties of the auto export job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoExportPrefixes:
{
Description: An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The status of the auto export ,
Required: False ,
}
{
state:
{
Description: The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error. ,
Enum:
{
InProgress: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
DisableFailed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto export job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto export job. ,
Required: False ,
}
string ,
totalFilesExported:
{
Description: Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMiBExported:
{
Description: Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesFailed:
{
Description: Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
exportIterationCount:
{
Description: Number of iterations completed since the start of the export. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessfulIterationCompletionTimeUTC:
{
Description: Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. ,
Format: date-time ,
Required: False ,
}
string ,
currentIterationFilesDiscovered:
{
Description: Files discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBDiscovered:
{
Description: Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesExported:
{
Description: Files that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBExported:
{
Description: Data (in MiB) that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesFailed:
{
Description: Files failed to export in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto export job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto export job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
autoExportJobs_Update (updated)
Description :  Update an auto export job instance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "autoExportJobs_Update",
  "$parameters": {
    "autoExportJob": {
      "$properties": {
        "@added_95f6d7017e0042bf80ef69a9734e93d8": {
          "#name": "properties",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "adminStatus",
              "Description": "The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'.",
              "Enum": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Enum": {
              "new": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ],
              "old": [
                [
                  "Active",
                  ""
                ],
                [
                  "Cancel",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoExportJobs/{autoExportJobName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
autoExportJobName:
{
Description: Name for the auto export job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
autoExportJob:
{
Description: Object containing the user-selectable properties of the auto export job. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the auto export job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoExportPrefixes:
{
Description: An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The status of the auto export ,
Required: False ,
}
{
state:
{
Description: The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error. ,
Enum:
{
InProgress: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
DisableFailed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto export job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto export job. ,
Required: False ,
}
string ,
totalFilesExported:
{
Description: Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMiBExported:
{
Description: Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesFailed:
{
Description: Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
exportIterationCount:
{
Description: Number of iterations completed since the start of the export. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessfulIterationCompletionTimeUTC:
{
Description: Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. ,
Format: date-time ,
Required: False ,
}
string ,
currentIterationFilesDiscovered:
{
Description: Files discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBDiscovered:
{
Description: Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesExported:
{
Description: Files that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBExported:
{
Description: Data (in MiB) that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesFailed:
{
Description: Files failed to export in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto export job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto export job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URI to poll for the operation status ,
}
string ,
azure-async-operation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
autoExportJobs_ListByAmlFilesystem (updated)
Description :  Returns all the auto export jobs the user has access to under an AML File System.
Reference :  Link ¶

⚶ Changes

{
  "#id": "autoExportJobs_ListByAmlFilesystem",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "adminStatus",
                "Enum": {
                  "new": [
                    [
                      "Enable",
                      ""
                    ],
                    [
                      "Disable",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "Active",
                      ""
                    ],
                    [
                      "Cancel",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoExportJobs
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of auto export job list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of auto export jobs. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the auto export job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the auto export job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto export job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoExportPrefixes:
{
Description: An array of blob paths/prefixes that get auto exported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths for now is 1. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The status of the auto export ,
Required: False ,
}
{
state:
{
Description: The operational state of auto export. InProgress indicates the export is running. Disabling indicates the user has requested to disable the export but the disabling is still in progress. Disabled indicates auto export has been disabled. DisableFailed indicates the disabling has failed. Failed means the export was unable to continue, due to a fatal error. ,
Enum:
{
InProgress: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
DisableFailed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto export job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto export job. ,
Required: False ,
}
string ,
totalFilesExported:
{
Description: Total files exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMiBExported:
{
Description: Total data (in MiB) exported since the start of the export. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
totalFilesFailed:
{
Description: Total files failed to be export since the last successfully completed iteration. This is accumulative, some files may be counted repeatedly. ,
Format: int64 ,
Required: False ,
}
integer ,
exportIterationCount:
{
Description: Number of iterations completed since the start of the export. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSuccessfulIterationCompletionTimeUTC:
{
Description: Time (in UTC) of the last successfully completed export iteration. Look at logging container for details. ,
Format: date-time ,
Required: False ,
}
string ,
currentIterationFilesDiscovered:
{
Description: Files discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBDiscovered:
{
Description: Data (in MiB) discovered for export in current iteration. It may increase while more export items are found. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesExported:
{
Description: Files that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationMiBExported:
{
Description: Data (in MiB) that have been exported in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
currentIterationFilesFailed:
{
Description: Files failed to export in current iteration. ,
Format: int64 ,
Required: False ,
}
integer ,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto export job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto export job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
importJobs_Get (updated)
Description :  Returns an import job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "importJobs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Description": {
              "new": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'.",
              "old": "The administrative status of the import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will cancel the current active import job. By default it is set to 'Enable'."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
importJobName:
{
Description: Name for the import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the import job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
importPrefixes:
{
Description: An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: 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. ,
Enum:
{
Fail: No description available. ,
Skip: No description available. ,
OverwriteIfDirty: No description available. ,
OverwriteAlways: No description available. ,
}
,
Required: False ,
}
enum ,
maximumErrors:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the import ,
Required: False ,
}
{
state:
{
Description: The operational 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. ,
Enum:
{
InProgress: No description available. ,
Cancelling: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
CompletedPartial: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The status message of the import job. ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: The total blob objects walked. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsWalkedPerSecond:
{
Description: A recent and frequently updated rate of blobs walked per second. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: The total blobs that have been imported since import began. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: New or modified files that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: New or modified directories that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Newly added symbolic links into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Files that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Directories that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Symbolic links that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsImportedPerSecond:
{
Description: A recent and frequently updated rate of total files, directories, and symlinks imported per second. ,
Format: int64 ,
Required: False ,
}
integer ,
lastCompletionTime:
{
Description: The time (in UTC) of the last completed import job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time (in UTC) the latest import job started. ,
Format: date-time ,
Required: False ,
}
string ,
totalErrors:
{
Description: Number of errors in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Number of conflicts in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
importJobs_CreateOrUpdate (updated)
Description :  Create or update an import job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "importJobs_CreateOrUpdate",
  "$parameters": {
    "importJob": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Description": {
              "new": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'.",
              "old": "The administrative status of the import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will cancel the current active import job. By default it is set to 'Enable'."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Description": {
              "new": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'.",
              "old": "The administrative status of the import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will cancel the current active import job. By default it is set to 'Enable'."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Description": {
              "new": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'.",
              "old": "The administrative status of the import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will cancel the current active import job. By default it is set to 'Enable'."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
importJobName:
{
Description: Name for the import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
importJob:
{
Description: Object containing the user-selectable properties of the import job. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of the import job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
importPrefixes:
{
Description: An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: 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. ,
Enum:
{
Fail: No description available. ,
Skip: No description available. ,
OverwriteIfDirty: No description available. ,
OverwriteAlways: No description available. ,
}
,
Required: False ,
}
enum ,
maximumErrors:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the import ,
Required: False ,
}
{
state:
{
Description: The operational 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. ,
Enum:
{
InProgress: No description available. ,
Cancelling: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
CompletedPartial: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The status message of the import job. ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: The total blob objects walked. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsWalkedPerSecond:
{
Description: A recent and frequently updated rate of blobs walked per second. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: The total blobs that have been imported since import began. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: New or modified files that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: New or modified directories that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Newly added symbolic links into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Files that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Directories that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Symbolic links that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsImportedPerSecond:
{
Description: A recent and frequently updated rate of total files, directories, and symlinks imported per second. ,
Format: int64 ,
Required: False ,
}
integer ,
lastCompletionTime:
{
Description: The time (in UTC) of the last completed import job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time (in UTC) the latest import job started. ,
Format: date-time ,
Required: False ,
}
string ,
totalErrors:
{
Description: Number of errors in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Number of conflicts in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the import job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
importPrefixes:
{
Description: An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: 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. ,
Enum:
{
Fail: No description available. ,
Skip: No description available. ,
OverwriteIfDirty: No description available. ,
OverwriteAlways: No description available. ,
}
,
Required: False ,
}
enum ,
maximumErrors:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the import ,
Required: False ,
}
{
state:
{
Description: The operational 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. ,
Enum:
{
InProgress: No description available. ,
Cancelling: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
CompletedPartial: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The status message of the import job. ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: The total blob objects walked. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsWalkedPerSecond:
{
Description: A recent and frequently updated rate of blobs walked per second. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: The total blobs that have been imported since import began. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: New or modified files that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: New or modified directories that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Newly added symbolic links into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Files that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Directories that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Symbolic links that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsImportedPerSecond:
{
Description: A recent and frequently updated rate of total files, directories, and symlinks imported per second. ,
Format: int64 ,
Required: False ,
}
integer ,
lastCompletionTime:
{
Description: The time (in UTC) of the last completed import job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time (in UTC) the latest import job started. ,
Format: date-time ,
Required: False ,
}
string ,
totalErrors:
{
Description: Number of errors in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Number of conflicts in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-async-operation:
{
Description: URI to poll for the operation status ,
}
string ,
}
,
$schema:
{
Description: 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 ,
}
{
properties:
{
Description: Properties of the import job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
importPrefixes:
{
Description: An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: 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. ,
Enum:
{
Fail: No description available. ,
Skip: No description available. ,
OverwriteIfDirty: No description available. ,
OverwriteAlways: No description available. ,
}
,
Required: False ,
}
enum ,
maximumErrors:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the import ,
Required: False ,
}
{
state:
{
Description: The operational 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. ,
Enum:
{
InProgress: No description available. ,
Cancelling: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
CompletedPartial: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The status message of the import job. ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: The total blob objects walked. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsWalkedPerSecond:
{
Description: A recent and frequently updated rate of blobs walked per second. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: The total blobs that have been imported since import began. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: New or modified files that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: New or modified directories that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Newly added symbolic links into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Files that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Directories that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Symbolic links that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsImportedPerSecond:
{
Description: A recent and frequently updated rate of total files, directories, and symlinks imported per second. ,
Format: int64 ,
Required: False ,
}
integer ,
lastCompletionTime:
{
Description: The time (in UTC) of the last completed import job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time (in UTC) the latest import job started. ,
Format: date-time ,
Required: False ,
}
string ,
totalErrors:
{
Description: Number of errors in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Number of conflicts in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
importJobs_Update (updated)
Description :  Update an import job instance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "importJobs_Update",
  "$parameters": {
    "importJob": {
      "$properties": {
        "@added_3195301913ec4c4599fa270e06a00f9f": {
          "#name": "properties",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "adminStatus",
              "Description": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job.",
              "Enum": [
                [
                  "Active",
                  ""
                ],
                [
                  "Cancel",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "adminStatus",
            "Description": {
              "new": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'.",
              "old": "The administrative status of the import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will cancel the current active import job. By default it is set to 'Enable'."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs/{importJobName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
importJobName:
{
Description: Name for the import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
importJob:
{
Description: Object containing the user-selectable properties of the import job. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the import job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
importPrefixes:
{
Description: An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: 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. ,
Enum:
{
Fail: No description available. ,
Skip: No description available. ,
OverwriteIfDirty: No description available. ,
OverwriteAlways: No description available. ,
}
,
Required: False ,
}
enum ,
maximumErrors:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the import ,
Required: False ,
}
{
state:
{
Description: The operational 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. ,
Enum:
{
InProgress: No description available. ,
Cancelling: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
CompletedPartial: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The status message of the import job. ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: The total blob objects walked. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsWalkedPerSecond:
{
Description: A recent and frequently updated rate of blobs walked per second. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: The total blobs that have been imported since import began. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: New or modified files that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: New or modified directories that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Newly added symbolic links into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Files that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Directories that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Symbolic links that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsImportedPerSecond:
{
Description: A recent and frequently updated rate of total files, directories, and symlinks imported per second. ,
Format: int64 ,
Required: False ,
}
integer ,
lastCompletionTime:
{
Description: The time (in UTC) of the last completed import job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time (in UTC) the latest import job started. ,
Format: date-time ,
Required: False ,
}
string ,
totalErrors:
{
Description: Number of errors in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Number of conflicts in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URI to poll for the operation status ,
}
string ,
azure-async-operation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
importJobs_ListByAmlFilesystem (updated)
Description :  Returns all import jobs the user has access to under an AML File System.
Reference :  Link ¶

⚶ Changes

{
  "#id": "importJobs_ListByAmlFilesystem",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "adminStatus",
                "Description": {
                  "new": "The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'.",
                  "old": "The administrative status of the import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will cancel the current active import job. By default it is set to 'Enable'."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/importJobs
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of import job list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of import jobs. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the import job. ,
Required: False ,
}
{
provisioningState:
{
Description: ARM provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
adminStatus:
{
Description: The administrative status of the import job. Possible values: 'Active', 'Cancel'. Passing in a value of 'Cancel' will cancel the current active import job. By default it is set to 'Active'. ,
Enum:
{
Active: No description available. ,
Cancel: No description available. ,
}
,
Required: False ,
}
enum ,
importPrefixes:
{
Description: An array of blob paths/prefixes that get imported into the cluster namespace. It has '/' as the default value. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: 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. ,
Enum:
{
Fail: No description available. ,
Skip: No description available. ,
OverwriteIfDirty: No description available. ,
OverwriteAlways: No description available. ,
}
,
Required: False ,
}
enum ,
maximumErrors:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the import ,
Required: False ,
}
{
state:
{
Description: The operational 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. ,
Enum:
{
InProgress: No description available. ,
Cancelling: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
CompletedPartial: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The status message of the import job. ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: The total blob objects walked. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsWalkedPerSecond:
{
Description: A recent and frequently updated rate of blobs walked per second. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: The total blobs that have been imported since import began. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: New or modified files that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: New or modified directories that have been imported into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Newly added symbolic links into the filesystem. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Files that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Directories that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Symbolic links that already exist in the filesystem and have not been modified. ,
Format: int64 ,
Required: False ,
}
integer ,
blobsImportedPerSecond:
{
Description: A recent and frequently updated rate of total files, directories, and symlinks imported per second. ,
Format: int64 ,
Required: False ,
}
integer ,
lastCompletionTime:
{
Description: The time (in UTC) of the last completed import job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time (in UTC) the latest import job started. ,
Format: date-time ,
Required: False ,
}
string ,
totalErrors:
{
Description: Number of errors in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Number of conflicts in the import job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

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