Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The caches/storageTargets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StorageCache/caches/storageTargets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.StorageCache/caches/storageTargets@2024-07-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
blobNfs: {
target: 'string'
usageModel: 'string'
verificationTimer: int
writeBackTimer: int
}
clfs: {
target: 'string'
}
junctions: [
{
namespacePath: 'string'
nfsAccessPolicy: 'string'
nfsExport: 'string'
targetPath: 'string'
}
]
nfs3: {
target: 'string'
usageModel: 'string'
verificationTimer: int
writeBackTimer: int
}
state: 'string'
targetType: 'string'
unknown: {
attributes: {
{customized property}: 'string'
}
}
}
}
Property Values
BlobNfsTarget
| Name | Description | Value |
|---|---|---|
| target | Resource ID of the storage container. | string |
| usageModel | Identifies the StorageCache usage model to be used for this storage target. | string |
| verificationTimer | Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. | int |
| writeBackTimer | Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. | int |
ClfsTarget
| Name | Description | Value |
|---|---|---|
| target | Resource ID of storage container. | string |
Microsoft.StorageCache/caches/storageTargets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[-0-9a-zA-Z_]{1,80}$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: caches |
| properties | StorageTarget properties | StorageTargetProperties |
NamespaceJunction
| Name | Description | Value |
|---|---|---|
| namespacePath | Namespace path on a cache for a Storage Target. | string |
| nfsAccessPolicy | Name of the access policy applied to this junction. | string |
| nfsExport | NFS export where targetPath exists. | string |
| targetPath | Path in Storage Target to which namespacePath points. | string |
Nfs3Target
| Name | Description | Value |
|---|---|---|
| target | IP address or host name of an NFSv3 host (e.g., 10.0.44.44). | string Constraints: Pattern = ^[-.,0-9a-zA-Z]+$ |
| usageModel | Identifies the StorageCache usage model to be used for this storage target. | string |
| verificationTimer | Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. | int |
| writeBackTimer | Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. | int |
StorageTargetProperties
| Name | Description | Value |
|---|---|---|
| blobNfs | Properties when targetType is blobNfs. | BlobNfsTarget |
| clfs | Properties when targetType is clfs. | ClfsTarget |
| junctions | List of cache namespace junctions to target for namespace associations. | NamespaceJunction[] |
| nfs3 | Properties when targetType is nfs3. | Nfs3Target |
| state | Storage target operational state. | 'Busy' 'Flushing' 'Ready' 'Suspended' |
| targetType | Type of the Storage Target. | 'blobNfs' 'clfs' 'nfs3' 'unknown' (required) |
| unknown | Properties when targetType is unknown. | UnknownTarget |
UnknownProperties
| Name | Description | Value |
|---|
UnknownTarget
| Name | Description | Value |
|---|---|---|
| attributes | Dictionary of string->string pairs containing information about the Storage Target. | UnknownProperties |
ARM template resource definition
The caches/storageTargets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StorageCache/caches/storageTargets resource, add the following JSON to your template.
{
"type": "Microsoft.StorageCache/caches/storageTargets",
"apiVersion": "2024-07-01",
"name": "string",
"properties": {
"blobNfs": {
"target": "string",
"usageModel": "string",
"verificationTimer": "int",
"writeBackTimer": "int"
},
"clfs": {
"target": "string"
},
"junctions": [
{
"namespacePath": "string",
"nfsAccessPolicy": "string",
"nfsExport": "string",
"targetPath": "string"
}
],
"nfs3": {
"target": "string",
"usageModel": "string",
"verificationTimer": "int",
"writeBackTimer": "int"
},
"state": "string",
"targetType": "string",
"unknown": {
"attributes": {
"{customized property}": "string"
}
}
}
}
Property Values
BlobNfsTarget
| Name | Description | Value |
|---|---|---|
| target | Resource ID of the storage container. | string |
| usageModel | Identifies the StorageCache usage model to be used for this storage target. | string |
| verificationTimer | Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. | int |
| writeBackTimer | Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. | int |
ClfsTarget
| Name | Description | Value |
|---|---|---|
| target | Resource ID of storage container. | string |
Microsoft.StorageCache/caches/storageTargets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-01' |
| name | The resource name | string Constraints: Pattern = ^[-0-9a-zA-Z_]{1,80}$ (required) |
| properties | StorageTarget properties | StorageTargetProperties |
| type | The resource type | 'Microsoft.StorageCache/caches/storageTargets' |
NamespaceJunction
| Name | Description | Value |
|---|---|---|
| namespacePath | Namespace path on a cache for a Storage Target. | string |
| nfsAccessPolicy | Name of the access policy applied to this junction. | string |
| nfsExport | NFS export where targetPath exists. | string |
| targetPath | Path in Storage Target to which namespacePath points. | string |
Nfs3Target
| Name | Description | Value |
|---|---|---|
| target | IP address or host name of an NFSv3 host (e.g., 10.0.44.44). | string Constraints: Pattern = ^[-.,0-9a-zA-Z]+$ |
| usageModel | Identifies the StorageCache usage model to be used for this storage target. | string |
| verificationTimer | Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. | int |
| writeBackTimer | Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. | int |
StorageTargetProperties
| Name | Description | Value |
|---|---|---|
| blobNfs | Properties when targetType is blobNfs. | BlobNfsTarget |
| clfs | Properties when targetType is clfs. | ClfsTarget |
| junctions | List of cache namespace junctions to target for namespace associations. | NamespaceJunction[] |
| nfs3 | Properties when targetType is nfs3. | Nfs3Target |
| state | Storage target operational state. | 'Busy' 'Flushing' 'Ready' 'Suspended' |
| targetType | Type of the Storage Target. | 'blobNfs' 'clfs' 'nfs3' 'unknown' (required) |
| unknown | Properties when targetType is unknown. | UnknownTarget |
UnknownProperties
| Name | Description | Value |
|---|
UnknownTarget
| Name | Description | Value |
|---|---|---|
| attributes | Dictionary of string->string pairs containing information about the Storage Target. | UnknownProperties |
Usage Examples
Terraform (AzAPI provider) resource definition
The caches/storageTargets resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StorageCache/caches/storageTargets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.StorageCache/caches/storageTargets@2024-07-01"
name = "string"
parent_id = "string"
body = {
properties = {
blobNfs = {
target = "string"
usageModel = "string"
verificationTimer = int
writeBackTimer = int
}
clfs = {
target = "string"
}
junctions = [
{
namespacePath = "string"
nfsAccessPolicy = "string"
nfsExport = "string"
targetPath = "string"
}
]
nfs3 = {
target = "string"
usageModel = "string"
verificationTimer = int
writeBackTimer = int
}
state = "string"
targetType = "string"
unknown = {
attributes = {
{customized property} = "string"
}
}
}
}
}
Property Values
BlobNfsTarget
| Name | Description | Value |
|---|---|---|
| target | Resource ID of the storage container. | string |
| usageModel | Identifies the StorageCache usage model to be used for this storage target. | string |
| verificationTimer | Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. | int |
| writeBackTimer | Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. | int |
ClfsTarget
| Name | Description | Value |
|---|---|---|
| target | Resource ID of storage container. | string |
Microsoft.StorageCache/caches/storageTargets
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[-0-9a-zA-Z_]{1,80}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: caches |
| properties | StorageTarget properties | StorageTargetProperties |
| type | The resource type | "Microsoft.StorageCache/caches/storageTargets@2024-07-01" |
NamespaceJunction
| Name | Description | Value |
|---|---|---|
| namespacePath | Namespace path on a cache for a Storage Target. | string |
| nfsAccessPolicy | Name of the access policy applied to this junction. | string |
| nfsExport | NFS export where targetPath exists. | string |
| targetPath | Path in Storage Target to which namespacePath points. | string |
Nfs3Target
| Name | Description | Value |
|---|---|---|
| target | IP address or host name of an NFSv3 host (e.g., 10.0.44.44). | string Constraints: Pattern = ^[-.,0-9a-zA-Z]+$ |
| usageModel | Identifies the StorageCache usage model to be used for this storage target. | string |
| verificationTimer | Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. | int |
| writeBackTimer | Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. | int |
StorageTargetProperties
| Name | Description | Value |
|---|---|---|
| blobNfs | Properties when targetType is blobNfs. | BlobNfsTarget |
| clfs | Properties when targetType is clfs. | ClfsTarget |
| junctions | List of cache namespace junctions to target for namespace associations. | NamespaceJunction[] |
| nfs3 | Properties when targetType is nfs3. | Nfs3Target |
| state | Storage target operational state. | 'Busy' 'Flushing' 'Ready' 'Suspended' |
| targetType | Type of the Storage Target. | 'blobNfs' 'clfs' 'nfs3' 'unknown' (required) |
| unknown | Properties when targetType is unknown. | UnknownTarget |
UnknownProperties
| Name | Description | Value |
|---|
UnknownTarget
| Name | Description | Value |
|---|---|---|
| attributes | Dictionary of string->string pairs containing information about the Storage Target. | UnknownProperties |