Microsoft.StorageCache caches/storageTargets 2020-03-01

• Latest
• 2024-07-01
• 2024-03-01
• 2023-11-01-preview
• 2023-05-01
• 2023-03-01-preview
• 2023-01-01
• 2022-05-01
• 2022-01-01
• 2021-09-01
• 2021-05-01
• 2021-03-01
• 2020-10-01
• 2020-03-01
• 2019-11-01
• 2019-08-01-preview

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@2020-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clfs: {
      target: 'string'
    }
    junctions: [
      {
        namespacePath: 'string'
        nfsExport: 'string'
        targetPath: 'string'
      }
    ]
    nfs3: {
      target: 'string'
      usageModel: 'string'
    }
    provisioningState: 'string'
    unknown: {
      unknownMap: {
        {customized property}: 'string'
      }
    }
    targetType: 'string'
    // For remaining properties, see StorageTargetProperties objects
  }
}

StorageTargetProperties objects

Set the targetType property to specify the type of object.

For clfs, use:

{
  targetType: 'clfs'
}

For nfs3, use:

{
  targetType: 'nfs3'
}

For unknown, use:

{
  targetType: 'unknown'
}

Property Values

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

ClfsTarget

Name	Description	Value
target	Resource ID of storage container.	string

ClfsTargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'clfs' (required)

NamespaceJunction

Name	Description	Value
namespacePath	Namespace path on a Cache for a Storage Target.	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 primary usage model to be used for this Storage Target. Get choices from .../usageModels	string

Nfs3TargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'nfs3' (required)

StorageTargetProperties

Name	Description	Value
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
provisioningState	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property	'Cancelled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating'
targetType	Set to 'clfs' for type ClfsTargetProperties. Set to 'nfs3' for type Nfs3TargetProperties. Set to 'unknown' for type UnknownTargetProperties.	'clfs' 'nfs3' 'unknown' (required)
unknown	Properties when targetType is unknown.	UnknownTarget

UnknownProperties

Name	Description	Value

UnknownTarget

Name	Description	Value
unknownMap	Dictionary of string->string pairs containing information about the Storage Target.	UnknownProperties

UnknownTargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'unknown' (required)

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": "2020-03-01",
  "name": "string",
  "properties": {
    "clfs": {
      "target": "string"
    },
    "junctions": [
      {
        "namespacePath": "string",
        "nfsExport": "string",
        "targetPath": "string"
      }
    ],
    "nfs3": {
      "target": "string",
      "usageModel": "string"
    },
    "provisioningState": "string",
    "unknown": {
      "unknownMap": {
        "{customized property}": "string"
      }
    },
    "targetType": "string"
    // For remaining properties, see StorageTargetProperties objects
  }
}

StorageTargetProperties objects

Set the targetType property to specify the type of object.

For clfs, use:

{
  "targetType": "clfs"
}

For nfs3, use:

{
  "targetType": "nfs3"
}

For unknown, use:

{
  "targetType": "unknown"
}

Property Values

Microsoft.StorageCache/caches/storageTargets

Name	Description	Value
apiVersion	The api version	'2020-03-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'

ClfsTarget

Name	Description	Value
target	Resource ID of storage container.	string

ClfsTargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'clfs' (required)

NamespaceJunction

Name	Description	Value
namespacePath	Namespace path on a Cache for a Storage Target.	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 primary usage model to be used for this Storage Target. Get choices from .../usageModels	string

Nfs3TargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'nfs3' (required)

StorageTargetProperties

Name	Description	Value
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
provisioningState	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property	'Cancelled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating'
targetType	Set to 'clfs' for type ClfsTargetProperties. Set to 'nfs3' for type Nfs3TargetProperties. Set to 'unknown' for type UnknownTargetProperties.	'clfs' 'nfs3' 'unknown' (required)
unknown	Properties when targetType is unknown.	UnknownTarget

UnknownProperties

Name	Description	Value

UnknownTarget

Name	Description	Value
unknownMap	Dictionary of string->string pairs containing information about the Storage Target.	UnknownProperties

UnknownTargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'unknown' (required)

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@2020-03-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      clfs = {
        target = "string"
      }
      junctions = [
        {
          namespacePath = "string"
          nfsExport = "string"
          targetPath = "string"
        }
      ]
      nfs3 = {
        target = "string"
        usageModel = "string"
      }
      provisioningState = "string"
      unknown = {
        unknownMap = {
          {customized property} = "string"
        }
      }
      targetType = "string"
      // For remaining properties, see StorageTargetProperties objects
    }
  }
}

StorageTargetProperties objects

Set the targetType property to specify the type of object.

For clfs, use:

{
  targetType = "clfs"
}

For nfs3, use:

{
  targetType = "nfs3"
}

For unknown, use:

{
  targetType = "unknown"
}

Property Values

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@2020-03-01"

ClfsTarget

Name	Description	Value
target	Resource ID of storage container.	string

ClfsTargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'clfs' (required)

NamespaceJunction

Name	Description	Value
namespacePath	Namespace path on a Cache for a Storage Target.	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 primary usage model to be used for this Storage Target. Get choices from .../usageModels	string

Nfs3TargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'nfs3' (required)

StorageTargetProperties

Name	Description	Value
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
provisioningState	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property	'Cancelled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating'
targetType	Set to 'clfs' for type ClfsTargetProperties. Set to 'nfs3' for type Nfs3TargetProperties. Set to 'unknown' for type UnknownTargetProperties.	'clfs' 'nfs3' 'unknown' (required)
unknown	Properties when targetType is unknown.	UnknownTarget

UnknownProperties

Name	Description	Value

UnknownTarget

Name	Description	Value
unknownMap	Dictionary of string->string pairs containing information about the Storage Target.	UnknownProperties

UnknownTargetProperties

Name	Description	Value
targetType	Type of the Storage Target.	'unknown' (required)