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

2025/09/02 • 56 new methods

amlFilesystems_List (new)
Description :  Returns all AML file systems the user has access to under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/amlFilesystems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of AML file system list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of AML file systems. ,
Required: False ,
}
[
{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
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 ,
}
,
}
amlFilesystems_ListByResourceGroup (new)
Description :  Returns all AML file systems the user has access to under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems
{
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of AML file system list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of AML file systems. ,
Required: False ,
}
[
{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
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 ,
}
,
}
amlFilesystems_Delete (new)
Description :  Schedules an AML file system for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}
{
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
amlFilesystems_Get (new)
Description :  Returns an AML file system.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}
{
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
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 ,
}
,
}
amlFilesystems_CreateOrUpdate (new)
Description :  Create or update an AML file system.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}
{
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. ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
amlFilesystem:
{
Description: Object containing the user-selectable properties of the AML file system. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-async-operation:
{
Description: URI to poll for the operation status ,
}
string ,
}
,
$schema:
{
Description: An AML file system instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md ,
}
{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
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 ,
}
,
}
amlFilesystems_Update (new)
Description :  Update an AML file system instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}
{
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. ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
amlFilesystem:
{
Description: Object containing the user-selectable properties of the AML file system. 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:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity used by the AML file system, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the user-assigned identity of the resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the resource. ,
Enum:
{
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Properties of the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. This might be rounded up. ,
Format: float ,
Required: True ,
}
number ,
health:
{
Description: Health of the AML file system. ,
Required: False ,
}
{
state:
{
Description: List of AML file system health states. ,
Enum:
{
Unavailable: No description available. ,
Available: No description available. ,
Degraded: No description available. ,
Transitioning: No description available. ,
Maintenance: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined error code for the AML file system health ,
Required: False ,
}
string ,
statusDescription:
{
Description: Describes the health state. ,
Required: False ,
}
string ,
}
,
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 ,
filesystemSubnet:
{
Description: 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. ,
Required: True ,
}
string ,
clientInfo:
{
Description: Client information for the AML file system. ,
Required: False ,
}
{
mgsAddress:
{
Description: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). ,
Required: False ,
}
string ,
mountCommand:
{
Description: Recommended command to mount the AML file system ,
Required: False ,
}
string ,
lustreVersion:
{
Description: The version of Lustre running in the AML file system ,
Required: False ,
}
string ,
containerStorageInterface:
{
Description: Container Storage Interface information for the AML file system. ,
Required: False ,
}
{
persistentVolumeClaim:
{
Description: Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
persistentVolume:
{
Description: Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
storageClass:
{
Description: Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML ,
Required: False ,
}
string ,
}
,
}
,
throughputProvisionedMBps:
{
Description: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput ,
Format: int32 ,
Required: False ,
}
integer ,
encryptionSettings:
{
Description: Specifies encryption settings of the AML file system. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
maintenanceWindow:
{
Description: Start time of a 30-minute weekly maintenance window. ,
Required: True ,
}
{
dayOfWeek:
{
Description: Day of the week on which the maintenance window will occur. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
timeOfDayUTC:
{
Description: The time of day (in UTC) to start the maintenance window. ,
Required: False ,
}
string ,
}
,
hsm:
{
Description: Hydration and archive settings and status ,
Required: False ,
}
{
settings:
{
Description: Specifies HSM settings of the AML file system. ,
Required: False ,
}
{
container:
{
Description: Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. ,
Required: True ,
}
string ,
loggingContainer:
{
Description: 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. ,
Required: True ,
}
string ,
importPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
importPrefixesInitial:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
archiveStatus:
{
Description: Archive status ,
Required: False ,
}
[
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the archive ,
Required: False ,
}
{
state:
{
Description: The state of the archive operation ,
Enum:
{
NotConfigured: No description available. ,
Idle: No description available. ,
InProgress: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Cancelling: No description available. ,
FSScanInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
lastCompletionTime:
{
Description: The time of the last completed archive operation ,
Format: date-time ,
Required: False ,
}
string ,
lastStartedTime:
{
Description: The time the latest archive operation started ,
Format: date-time ,
Required: False ,
}
string ,
percentComplete:
{
Description: The completion percentage of the archive operation ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: Server-defined error code for the archive operation ,
Required: False ,
}
string ,
errorMessage:
{
Description: Server-defined error message for the archive operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
rootSquashSettings:
{
Description: Specifies root squash settings of the AML file system. ,
Required: False ,
}
{
mode:
{
Description: Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. ,
Enum:
{
None: No description available. ,
RootOnly: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
noSquashNidLists:
{
Description: Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. ,
Required: False ,
}
string ,
squashUID:
{
Description: User ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
squashGID:
{
Description: Group ID to squash to. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: AML file system squash status. ,
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 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 ,
}
,
}
amlFilesystems_Archive (new)
Description :  Archive data from the AML file system.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/archive
{
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. ,
Required: True ,
}
string ,
amlFilesystemName:
{
Description: Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
archiveInfo:
{
Description: Information about the archive operation ,
Required: False ,
}
{
filesystemPath:
{
Description: Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
amlFilesystems_CancelArchive (new)
Description :  Cancel archiving data from the AML file system.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/cancelArchive
{
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. ,
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)

{}

⚐ 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 ,
}
,
}
autoExportJobs_Delete (new)
Description :  Schedules an auto export job for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /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 (202)

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

⚐ Response (204)

{}

⚐ 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_Get (new)
Description :  Returns an auto export job.
Reference :  Link ¶

⚼ 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 (new)
Description :  Create or update an auto export job.
Reference :  Link ¶

⚼ 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 (new)
Description :  Update an auto export job instance.
Reference :  Link ¶

⚼ 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 (new)
Description :  Returns all the auto export jobs the user has access to under an AML File System.
Reference :  Link ¶

⚼ 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_Delete (new)
Description :  Schedules an import job for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /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 (202)

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

⚐ Response (204)

{}

⚐ 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_Get (new)
Description :  Returns an import job.
Reference :  Link ¶

⚼ 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 (new)
Description :  Create or update an import job.
Reference :  Link ¶

⚼ 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 (new)
Description :  Update an import job instance.
Reference :  Link ¶

⚼ 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 (new)
Description :  Returns all import jobs the user has access to under an AML File System.
Reference :  Link ¶

⚼ 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 ,
}
,
}
autoImportJobs_Delete (new)
Description :  Schedules an auto import job for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoImportJobs/{autoImportJobName}
{
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 ,
autoImportJobName:
{
Description: Name for the auto import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
autoImportJobs_Get (new)
Description :  Returns an auto import job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoImportJobs/{autoImportJobName}
{
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 ,
autoImportJobName:
{
Description: Name for the auto import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the auto 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoImportPrefixes:
{
Description: An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode 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 ,
enableDeletions:
{
Description: Whether or not to enable deletions during auto import. This only affects overwrite-dirty. ,
Required: False ,
}
boolean ,
maximumErrors:
{
Description: Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the auto import job. ,
Required: False ,
}
{
state:
{
Description: The state of the auto import operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto import job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto import job. ,
Required: False ,
}
string ,
scanStartTime:
{
Description: Date and time of when the currently running full scan began. ,
Format: date-time ,
Required: False ,
}
string ,
scanEndTime:
{
Description: Date and time of when the full scan ended. ,
Format: date-time ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: Total number of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobWalk:
{
Description: Rate of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: Number of files imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
blobSyncEvents:
{
Description: The storage account blob change feed status of the auto import job. ,
Required: False ,
}
{
importedFiles:
{
Description: Number of files imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import per second during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
deletions:
{
Description: Number of deletions during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
lastChangeFeedEventConsumedTime:
{
Description: Date and time of the last Change Feed event consumed. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimeFullySynchronized:
{
Description: Date and time when last fully synchronized. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto import job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto import 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 ,
}
,
]
,
}
,
}
autoImportJobs_CreateOrUpdate (new)
Description :  Create or update an auto import job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoImportJobs/{autoImportJobName}
{
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 ,
autoImportJobName:
{
Description: Name for the auto import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
autoImportJob:
{
Description: Object containing the user-selectable properties of the auto import job. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of the auto 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoImportPrefixes:
{
Description: An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode 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 ,
enableDeletions:
{
Description: Whether or not to enable deletions during auto import. This only affects overwrite-dirty. ,
Required: False ,
}
boolean ,
maximumErrors:
{
Description: Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the auto import job. ,
Required: False ,
}
{
state:
{
Description: The state of the auto import operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto import job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto import job. ,
Required: False ,
}
string ,
scanStartTime:
{
Description: Date and time of when the currently running full scan began. ,
Format: date-time ,
Required: False ,
}
string ,
scanEndTime:
{
Description: Date and time of when the full scan ended. ,
Format: date-time ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: Total number of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobWalk:
{
Description: Rate of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: Number of files imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
blobSyncEvents:
{
Description: The storage account blob change feed status of the auto import job. ,
Required: False ,
}
{
importedFiles:
{
Description: Number of files imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import per second during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
deletions:
{
Description: Number of deletions during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
lastChangeFeedEventConsumedTime:
{
Description: Date and time of the last Change Feed event consumed. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimeFullySynchronized:
{
Description: Date and time when last fully synchronized. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto import job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto import job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the auto 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoImportPrefixes:
{
Description: An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode 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 ,
enableDeletions:
{
Description: Whether or not to enable deletions during auto import. This only affects overwrite-dirty. ,
Required: False ,
}
boolean ,
maximumErrors:
{
Description: Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the auto import job. ,
Required: False ,
}
{
state:
{
Description: The state of the auto import operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto import job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto import job. ,
Required: False ,
}
string ,
scanStartTime:
{
Description: Date and time of when the currently running full scan began. ,
Format: date-time ,
Required: False ,
}
string ,
scanEndTime:
{
Description: Date and time of when the full scan ended. ,
Format: date-time ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: Total number of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobWalk:
{
Description: Rate of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: Number of files imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
blobSyncEvents:
{
Description: The storage account blob change feed status of the auto import job. ,
Required: False ,
}
{
importedFiles:
{
Description: Number of files imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import per second during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
deletions:
{
Description: Number of deletions during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
lastChangeFeedEventConsumedTime:
{
Description: Date and time of the last Change Feed event consumed. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimeFullySynchronized:
{
Description: Date and time when last fully synchronized. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto import job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto import job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-async-operation: string ,
}
,
$schema:
{
Description: An auto 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 auto 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoImportPrefixes:
{
Description: An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode 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 ,
enableDeletions:
{
Description: Whether or not to enable deletions during auto import. This only affects overwrite-dirty. ,
Required: False ,
}
boolean ,
maximumErrors:
{
Description: Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the auto import job. ,
Required: False ,
}
{
state:
{
Description: The state of the auto import operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto import job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto import job. ,
Required: False ,
}
string ,
scanStartTime:
{
Description: Date and time of when the currently running full scan began. ,
Format: date-time ,
Required: False ,
}
string ,
scanEndTime:
{
Description: Date and time of when the full scan ended. ,
Format: date-time ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: Total number of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobWalk:
{
Description: Rate of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: Number of files imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
blobSyncEvents:
{
Description: The storage account blob change feed status of the auto import job. ,
Required: False ,
}
{
importedFiles:
{
Description: Number of files imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import per second during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
deletions:
{
Description: Number of deletions during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
lastChangeFeedEventConsumedTime:
{
Description: Date and time of the last Change Feed event consumed. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimeFullySynchronized:
{
Description: Date and time when last fully synchronized. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto import job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto import 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 ,
}
,
]
,
}
,
}
autoImportJobs_Update (new)
Description :  Update an auto import job instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoImportJobs/{autoImportJobName}
{
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 ,
autoImportJobName:
{
Description: Name for the auto import job. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric. ,
Required: True ,
}
string ,
autoImportJob:
{
Description: Object containing the user-selectable properties of the auto 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import 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 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoImportPrefixes:
{
Description: An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode 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 ,
enableDeletions:
{
Description: Whether or not to enable deletions during auto import. This only affects overwrite-dirty. ,
Required: False ,
}
boolean ,
maximumErrors:
{
Description: Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the auto import job. ,
Required: False ,
}
{
state:
{
Description: The state of the auto import operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto import job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto import job. ,
Required: False ,
}
string ,
scanStartTime:
{
Description: Date and time of when the currently running full scan began. ,
Format: date-time ,
Required: False ,
}
string ,
scanEndTime:
{
Description: Date and time of when the full scan ended. ,
Format: date-time ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: Total number of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobWalk:
{
Description: Rate of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: Number of files imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
blobSyncEvents:
{
Description: The storage account blob change feed status of the auto import job. ,
Required: False ,
}
{
importedFiles:
{
Description: Number of files imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import per second during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
deletions:
{
Description: Number of deletions during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
lastChangeFeedEventConsumedTime:
{
Description: Date and time of the last Change Feed event consumed. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimeFullySynchronized:
{
Description: Date and time when last fully synchronized. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto import job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto import job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
azure-async-operation: 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 ,
}
,
]
,
}
,
}
autoImportJobs_ListByAmlFilesystem (new)
Description :  Returns all the auto import jobs the user has access to under an AML File System.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/autoImportJobs
{
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)

{
value:
{
Description: List of auto import jobs. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the auto 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 auto import job. Possible values: 'Enable', 'Disable'. Passing in a value of 'Disable' will disable the current active auto import job. By default it is set to 'Enable'. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
autoImportPrefixes:
{
Description: An array of blob paths/prefixes that get auto imported to the cluster namespace. It has '/' as the default value. Number of maximum allowed paths is 100. ,
Required: False ,
}
[
string ,
]
,
conflictResolutionMode:
{
Description: How the auto import job will handle conflicts. For example, if the auto import job is trying to bring in a directory, but a file is at that path, how it handles it. Fail indicates that the auto import job should stop immediately and not do anything with the conflict. Skip indicates that it should pass over the conflict. OverwriteIfDirty causes the auto import job to delete and re-import the file or directory if it is a conflicting type, is dirty, or is currently released. 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/blob-integration#conflict-resolution-mode 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 ,
enableDeletions:
{
Description: Whether or not to enable deletions during auto import. This only affects overwrite-dirty. ,
Required: False ,
}
boolean ,
maximumErrors:
{
Description: Total non-conflict-oriented errors (e.g., OS errors) Import will tolerate before exiting with failure. -1 means infinite. 0 means exit immediately on any error. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the auto import job. ,
Required: False ,
}
{
state:
{
Description: The state of the auto import operation. ,
Enum:
{
InProgress: No description available. ,
Failed: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
statusCode:
{
Description: Server-defined status code for auto import job. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Server-defined status message for auto import job. ,
Required: False ,
}
string ,
scanStartTime:
{
Description: Date and time of when the currently running full scan began. ,
Format: date-time ,
Required: False ,
}
string ,
scanEndTime:
{
Description: Date and time of when the full scan ended. ,
Format: date-time ,
Required: False ,
}
string ,
totalBlobsWalked:
{
Description: Total number of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobWalk:
{
Description: Rate of blobs walked during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedFiles:
{
Description: Number of files imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during full scan. ,
Format: int64 ,
Required: False ,
}
integer ,
blobSyncEvents:
{
Description: The storage account blob change feed status of the auto import job. ,
Required: False ,
}
{
importedFiles:
{
Description: Number of files imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedDirectories:
{
Description: Number of directories imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
importedSymlinks:
{
Description: Number of symlinks imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingFiles:
{
Description: Number of preexisting files during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingDirectories:
{
Description: Number of preexisting directories during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
preexistingSymlinks:
{
Description: Number of preexisting symlinks during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalBlobsImported:
{
Description: Total number of blobs imported during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
rateOfBlobImport:
{
Description: Rate of blob import per second during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalErrors:
{
Description: Total errors encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
totalConflicts:
{
Description: Total conflicts encountered during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
deletions:
{
Description: Number of deletions during auto import. ,
Format: int64 ,
Required: False ,
}
integer ,
lastChangeFeedEventConsumedTime:
{
Description: Date and time of the last Change Feed event consumed. ,
Format: date-time ,
Required: False ,
}
string ,
lastTimeFullySynchronized:
{
Description: Date and time when last fully synchronized. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
lastStartedTimeUTC:
{
Description: The time (in UTC) the latest auto import job started. ,
Format: date-time ,
Required: False ,
}
string ,
lastCompletionTimeUTC:
{
Description: The time (in UTC) of the last completed auto import job. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of auto import job list results, if there are any. ,
Format: uri ,
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 ,
}
,
}
checkAmlFSSubnets (new)
Description :  Check that subnets will be valid for AML file system create calls.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/checkAmlFSSubnets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
amlFilesystemSubnetInfo:
{
Description: Information about the subnets to validate. ,
Required: False ,
}
{
filesystemSubnet:
{
Description: 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. ,
Required: False ,
}
string ,
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. ,
Format: float ,
Required: False ,
}
number ,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
location:
{
Description: Region that the AML file system will be created in. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (400)

{
filesystemSubnet:
{
Description: The error details for the AML file system's subnet. ,
Required: False ,
}
{
status:
{
Description: The status of the AML file system subnet check. ,
Enum:
{
Ok: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The details of the AML file system subnet check. ,
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 ,
}
,
}
getRequiredAmlFSSubnetsSize (new)
Description :  Get the number of available IP addresses needed for the AML file system information provided.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/getRequiredAmlFSSubnetsSize
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
requiredAMLFilesystemSubnetsSizeInfo:
{
Description: Information to determine the number of available IPs a subnet will need to host the AML file system. ,
Required: False ,
}
{
storageCapacityTiB:
{
Description: The size of the AML file system, in TiB. ,
Format: float ,
Required: False ,
}
number ,
sku:
{
Description: SKU for the resource. ,
Required: False ,
}
{
name:
{
Description: SKU name for this resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
filesystemSubnetSize:
{
Description: The number of available IP addresses that are required for the AML file system. ,
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 ,
}
,
}
Operations_List (new)
Description :  Lists all of the available Resource Provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorageCache/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Resource Provider operations supported by the Microsoft.StorageCache resource provider. ,
Required: False ,
}
[
{
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft.StorageCache ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Cache, etc. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: The flag that indicates whether the operation applies to data plane. ,
Required: False ,
}
boolean ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
properties:
{
Description: Additional details about an operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Specification of the all the metrics provided for a resource type. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Details about operations related to metrics. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that the metric is measured in. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The type of metric aggregation. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Support metric aggregation type. ,
Required: False ,
}
[
string ,
]
,
metricClass:
{
Description: Type of metrics. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
internalName:
{
Description: Internal name of the dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: To be exported to shoe box. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Details about operations related to logs. ,
Required: False ,
}
[
{
name:
{
Description: The name of the log. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name of the log. ,
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 ,
}
,
}
Skus_List (new)
Description :  Get the list of StorageCache.Cache SKUs available to this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of cache SKUs. ,
Required: False ,
}
string ,
value:
{
Description: The list of SKUs available for the subscription. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: A list of capabilities of this SKU, such as throughput or ops/sec. ,
Required: False ,
}
[
{
name:
{
Description: Name of a capability, such as ops/sec. ,
Required: False ,
}
string ,
value:
{
Description: Quantity, if the capability is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
locations:
{
Description: The set of locations where the SKU is available. This is the supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: The set of locations where the SKU is available. ,
Required: False ,
}
[
{
location:
{
Description: Location where this SKU is available. ,
Required: False ,
}
string ,
zones:
{
Description: Zones if any. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
name:
{
Description: The name of this SKU. ,
Required: False ,
}
string ,
restrictions:
{
Description: The restrictions preventing this SKU from being used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. In this version, the only possible value for this is location. ,
Required: False ,
}
string ,
values:
{
Description: The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". "QuotaId" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. "NotAvailableForSubscription" is related to capacity at the datacenter. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ 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 ,
}
,
}
UsageModels_List (new)
Description :  Get the list of cache usage models available to this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of cache usage models. ,
Required: False ,
}
string ,
value:
{
Description: The list of usage models available for the subscription. ,
Required: False ,
}
[
{
display:
{
Description: Localized information describing this usage model. ,
Required: False ,
}
{
description:
{
Description: String to display for this usage model. ,
Required: False ,
}
string ,
}
,
modelName:
{
Description: Non-localized keyword name for this usage model. ,
Required: False ,
}
string ,
targetType:
{
Description: The type of Storage Target to which this model is applicable (only nfs3 as of this version). ,
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 ,
}
,
}
AscOperations_Get (new)
Description :  Gets the status of an asynchronous operation for the Azure HPC Cache
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional operation-specific properties ,
Required: False ,
}
{
output:
{
Description: Additional operation-specific output. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
AscUsages_List (new)
Description :  Gets the quantity used and quota limit for resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/usages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of the region to query for usage information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of resource usage list results if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of usages and limits for resources controlled by the Microsoft.StorageCache resource provider. ,
Required: False ,
}
[
{
limit:
{
Description: The limit (quota) for this resource. ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: Unit that the limit and usages are expressed in, such as 'Count'. ,
Required: False ,
}
string ,
currentValue:
{
Description: The current usage of this resource. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Naming information for this resource type. ,
Required: False ,
}
{
value:
{
Description: Canonical name for this resource type. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized name for this resource type. ,
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 ,
}
,
}
Caches_List (new)
Description :  Returns all caches the user has access to under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of cache list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Caches. ,
Required: False ,
}
[
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
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 ,
}
,
}
Caches_ListByResourceGroup (new)
Description :  Returns all caches the user has access to under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches
{
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of cache list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Caches. ,
Required: False ,
}
[
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
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 ,
}
,
}
Caches_Delete (new)
Description :  Schedules a cache for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_Get (new)
Description :  Returns a cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
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 ,
}
,
}
Caches_CreateOrUpdate (new)
Description :  Create or update a cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
cache:
{
Description: Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
Caches_Update (new)
Description :  Update a cache instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
cache:
{
Description: Object containing the user-selectable properties of the cache. If read-only properties are included, they must match the existing values of those properties. ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID for the system-assigned identity of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
Required: False ,
}
integer ,
health:
{
Description: Health of the cache. ,
Required: False ,
}
{
state:
{
Description: List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
WaitingForKey: No description available. ,
StartFailed: No description available. ,
UpgradeFailed: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
Required: False ,
}
string ,
}
,
]
,
}
,
mountAddresses:
{
Description: Array of IPv4 addresses that can be used by clients mounting this cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
upgradeSettings:
{
Description: Upgrade settings of the cache. ,
Required: False ,
}
{
upgradeScheduleEnabled:
{
Description: True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. ,
Required: False ,
}
boolean ,
scheduledTime:
{
Description: When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in key vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in key vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source key vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
rotationToLatestKeyVersionEnabled:
{
Description: Specifies whether the service will automatically rotate to the newest version of the key in the key vault. ,
Required: False ,
}
boolean ,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
zones:
{
Description: Availability zones for resources. This field should only contain a single element in the array. ,
Required: False ,
}
[
string ,
]
,
primingJobs:
{
Description: Specifies the priming jobs defined in the cache. ,
Required: False ,
}
[
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
spaceAllocation:
{
Description: Specifies the space allocation percentage for each storage target in the cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sku:
{
Description: SKU for the cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
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 ,
}
,
}
StorageTargets_DnsRefresh (new)
Description :  Tells a storage target to refresh its DNS information.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/dnsRefresh
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
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 ,
}
,
}
Caches_DebugInfo (new)
Description :  Tells a cache to write generate debug info for support to process.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_Flush (new)
Description :  Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_Start (new)
Description :  Tells a Stopped state cache to transition to Active state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_Stop (new)
Description :  Tells an Active cache to transition to Stopped state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
StorageTargets_ListByCache (new)
Description :  Returns a list of Storage Targets for the specified cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Storage Targets. ,
Required: False ,
}
string ,
value:
{
Description: The list of Storage Targets defined for the cache. ,
Required: False ,
}
[
{
properties:
{
Description: StorageTarget properties ,
Required: False ,
}
{
junctions:
{
Description: List of cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Storage target operational state. ,
Enum:
{
Ready: No description available. ,
Busy: No description available. ,
Suspended: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
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 ,
}
,
}
StorageTargets_Delete (new)
Description :  Removes a Storage Target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the cache is healthy again. Note that if the cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
force:
{
Description: Boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
StorageTargets_Get (new)
Description :  Returns a Storage Target from a cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: StorageTarget properties ,
Required: False ,
}
{
junctions:
{
Description: List of cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Storage target operational state. ,
Enum:
{
Ready: No description available. ,
Busy: No description available. ,
Suspended: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
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 ,
}
,
}
StorageTargets_CreateOrUpdate (new)
Description :  Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
storagetarget:
{
Description: Object containing the definition of a Storage Target. ,
Required: True ,
}
{
properties:
{
Description: StorageTarget properties ,
Required: False ,
}
{
junctions:
{
Description: List of cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Storage target operational state. ,
Enum:
{
Ready: No description available. ,
Busy: No description available. ,
Suspended: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: StorageTarget properties ,
Required: False ,
}
{
junctions:
{
Description: List of cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Storage target operational state. ,
Enum:
{
Ready: No description available. ,
Busy: No description available. ,
Suspended: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: StorageTarget properties ,
Required: False ,
}
{
junctions:
{
Description: List of cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Storage target operational state. ,
Enum:
{
Ready: No description available. ,
Busy: No description available. ,
Suspended: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
verificationTimer:
{
Description: Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. ,
Format: int32 ,
Required: False ,
}
integer ,
writeBackTimer:
{
Description: Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
}
StorageTarget_Flush (new)
Description :  Tells the cache to write all dirty data to the Storage Target's backend storage. Client requests to this storage target's namespace will return errors until the flush operation completes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/flush
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
StorageTarget_Suspend (new)
Description :  Suspends client access to a storage target.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/suspend
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
StorageTarget_Resume (new)
Description :  Resumes client access to a previously suspended storage target.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/resume
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
StorageTarget_Invalidate (new)
Description :  Invalidate all cached data for a storage target. Cached files are discarded and fetched from the back end on the next request.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/invalidate
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_StartPrimingJob (new)
Description :  Create a priming job. This operation is only allowed when the cache is healthy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/startPrimingJob
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
primingjob:
{
Description: Object containing the definition of a priming job. ,
Required: False ,
}
{
primingJobName:
{
Description: The priming job name. ,
Required: True ,
}
string ,
primingManifestUrl:
{
Description: The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob. ,
Required: True ,
}
string ,
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: False ,
}
string ,
primingJobState:
{
Description: The state of the priming operation. ,
Enum:
{
Queued: No description available. ,
Running: No description available. ,
Paused: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
primingJobStatus:
{
Description: The status code of the priming job. ,
Required: False ,
}
string ,
primingJobDetails:
{
Description: The job details or error information if any. ,
Required: False ,
}
string ,
primingJobPercentComplete:
{
Description: The current progress of the priming job, as a percentage. ,
Format: double ,
Required: False ,
}
number ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
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 ,
}
,
}
Caches_StopPrimingJob (new)
Description :  Schedule a priming job for deletion.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stopPrimingJob
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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. ,
Required: True ,
}
string ,
primingJobId:
{
Description: Object containing the priming job ID. ,
Required: False ,
}
{
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_PausePrimingJob (new)
Description :  Schedule a priming job to be paused.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/pausePrimingJob
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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. ,
Required: True ,
}
string ,
primingJobId:
{
Description: Object containing the priming job ID. ,
Required: False ,
}
{
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_ResumePrimingJob (new)
Description :  Resumes a paused priming job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/resumePrimingJob
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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. ,
Required: True ,
}
string ,
primingJobId:
{
Description: Object containing the priming job ID. ,
Required: False ,
}
{
primingJobId:
{
Description: The unique identifier of the priming job. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_UpgradeFirmware (new)
Description :  Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
Caches_SpaceAllocation (new)
Description :  Update cache space allocation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/spaceAllocation
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
spaceAllocation:
{
Description: List containing storage target cache space percentage allocations. ,
Required: False ,
}
{
name:
{
Description: Name of the storage target. ,
Required: False ,
}
string ,
allocationPercentage:
{
Description: The percentage of cache space allocated for this storage target ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
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 ,
}
,
}
StorageTargets_RestoreDefaults (new)
Description :  Tells a storage target to restore its settings to their default values.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/restoreDefaults
{
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. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
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 ,
}
,
}