1. Packages
  2. Azure Classic
  3. API Docs
  4. hpc
  5. CacheNfsTarget

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.hpc.CacheNfsTarget

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a NFS Target within a HPC Cache.

    NOTE:: By request of the service team the provider no longer automatically registering the Microsoft.StorageCache Resource Provider for this resource. To register it you can run az provider register --namespace 'Microsoft.StorageCache'.

    Create CacheNfsTarget Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CacheNfsTarget(name: string, args: CacheNfsTargetArgs, opts?: CustomResourceOptions);
    @overload
def CacheNfsTarget(resource_name: str,
                   args: CacheNfsTargetArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CacheNfsTarget(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cache_name: Optional[str] = None,
                   namespace_junctions: Optional[Sequence[CacheNfsTargetNamespaceJunctionArgs]] = None,
                   resource_group_name: Optional[str] = None,
                   target_host_name: Optional[str] = None,
                   usage_model: Optional[str] = None,
                   name: Optional[str] = None)
    func NewCacheNfsTarget(ctx *Context, name string, args CacheNfsTargetArgs, opts ...ResourceOption) (*CacheNfsTarget, error)
    public CacheNfsTarget(string name, CacheNfsTargetArgs args, CustomResourceOptions? opts = null)
    public CacheNfsTarget(String name, CacheNfsTargetArgs args)
public CacheNfsTarget(String name, CacheNfsTargetArgs args, CustomResourceOptions options)

    type: azure:hpc:CacheNfsTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CacheNfsTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CacheNfsTargetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CacheNfsTargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CacheNfsTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CacheNfsTargetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var cacheNfsTargetResource = new Azure.Hpc.CacheNfsTarget("cacheNfsTargetResource", new()
{
    CacheName = "string",
    NamespaceJunctions = new[]
    {
        new Azure.Hpc.Inputs.CacheNfsTargetNamespaceJunctionArgs
        {
            NamespacePath = "string",
            NfsExport = "string",
            AccessPolicyName = "string",
            TargetPath = "string",
        },
    },
    ResourceGroupName = "string",
    TargetHostName = "string",
    UsageModel = "string",
    Name = "string",
});

    example, err := hpc.NewCacheNfsTarget(ctx, "cacheNfsTargetResource", &hpc.CacheNfsTargetArgs{
	CacheName: pulumi.String("string"),
	NamespaceJunctions: hpc.CacheNfsTargetNamespaceJunctionArray{
		&hpc.CacheNfsTargetNamespaceJunctionArgs{
			NamespacePath:    pulumi.String("string"),
			NfsExport:        pulumi.String("string"),
			AccessPolicyName: pulumi.String("string"),
			TargetPath:       pulumi.String("string"),
		},
	},
	ResourceGroupName: pulumi.String("string"),
	TargetHostName:    pulumi.String("string"),
	UsageModel:        pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var cacheNfsTargetResource = new CacheNfsTarget("cacheNfsTargetResource", CacheNfsTargetArgs.builder()
    .cacheName("string")
    .namespaceJunctions(CacheNfsTargetNamespaceJunctionArgs.builder()
        .namespacePath("string")
        .nfsExport("string")
        .accessPolicyName("string")
        .targetPath("string")
        .build())
    .resourceGroupName("string")
    .targetHostName("string")
    .usageModel("string")
    .name("string")
    .build());

    cache_nfs_target_resource = azure.hpc.CacheNfsTarget("cacheNfsTargetResource",
    cache_name="string",
    namespace_junctions=[{
        "namespace_path": "string",
        "nfs_export": "string",
        "access_policy_name": "string",
        "target_path": "string",
    }],
    resource_group_name="string",
    target_host_name="string",
    usage_model="string",
    name="string")

    const cacheNfsTargetResource = new azure.hpc.CacheNfsTarget("cacheNfsTargetResource", {
    cacheName: "string",
    namespaceJunctions: [{
        namespacePath: "string",
        nfsExport: "string",
        accessPolicyName: "string",
        targetPath: "string",
    }],
    resourceGroupName: "string",
    targetHostName: "string",
    usageModel: "string",
    name: "string",
});

    type: azure:hpc:CacheNfsTarget
properties:
    cacheName: string
    name: string
    namespaceJunctions:
        - accessPolicyName: string
          namespacePath: string
          nfsExport: string
          targetPath: string
    resourceGroupName: string
    targetHostName: string
    usageModel: string

    CacheNfsTarget Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CacheNfsTarget resource accepts the following input properties:

    CacheName string
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    NamespaceJunctions List<CacheNfsTargetNamespaceJunction>
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    ResourceGroupName string
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    TargetHostName string
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    UsageModel string
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    Name string
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    CacheName string
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    NamespaceJunctions []CacheNfsTargetNamespaceJunctionArgs
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    ResourceGroupName string
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    TargetHostName string
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    UsageModel string
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    Name string
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    cacheName String
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    namespaceJunctions List<CacheNfsTargetNamespaceJunction>
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resourceGroupName String
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    targetHostName String
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usageModel String
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    name String
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    cacheName string
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    namespaceJunctions CacheNfsTargetNamespaceJunction[]
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resourceGroupName string
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    targetHostName string
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usageModel string
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    name string
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    cache_name str
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    namespace_junctions Sequence[CacheNfsTargetNamespaceJunctionArgs]
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resource_group_name str
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    target_host_name str
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usage_model str
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    name str
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    cacheName String
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    namespaceJunctions List<Property Map>
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resourceGroupName String
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    targetHostName String
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usageModel String
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    name String
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CacheNfsTarget resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CacheNfsTarget Resource

    Get an existing CacheNfsTarget resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CacheNfsTargetState, opts?: CustomResourceOptions): CacheNfsTarget
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cache_name: Optional[str] = None,
        name: Optional[str] = None,
        namespace_junctions: Optional[Sequence[CacheNfsTargetNamespaceJunctionArgs]] = None,
        resource_group_name: Optional[str] = None,
        target_host_name: Optional[str] = None,
        usage_model: Optional[str] = None) -> CacheNfsTarget
    func GetCacheNfsTarget(ctx *Context, name string, id IDInput, state *CacheNfsTargetState, opts ...ResourceOption) (*CacheNfsTarget, error)
    public static CacheNfsTarget Get(string name, Input<string> id, CacheNfsTargetState? state, CustomResourceOptions? opts = null)
    public static CacheNfsTarget get(String name, Output<String> id, CacheNfsTargetState state, CustomResourceOptions options)
    resources:  _:    type: azure:hpc:CacheNfsTarget    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CacheName string
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    Name string
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    NamespaceJunctions List<CacheNfsTargetNamespaceJunction>
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    ResourceGroupName string
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    TargetHostName string
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    UsageModel string
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    CacheName string
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    Name string
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    NamespaceJunctions []CacheNfsTargetNamespaceJunctionArgs
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    ResourceGroupName string
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    TargetHostName string
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    UsageModel string
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    cacheName String
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    name String
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    namespaceJunctions List<CacheNfsTargetNamespaceJunction>
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resourceGroupName String
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    targetHostName String
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usageModel String
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    cacheName string
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    name string
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    namespaceJunctions CacheNfsTargetNamespaceJunction[]
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resourceGroupName string
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    targetHostName string
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usageModel string
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    cache_name str
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    name str
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    namespace_junctions Sequence[CacheNfsTargetNamespaceJunctionArgs]
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resource_group_name str
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    target_host_name str
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usage_model str
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.
    cacheName String
    The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.
    name String
    The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
    namespaceJunctions List<Property Map>
    Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
    resourceGroupName String
    The name of the Resource Group in which to create the HPC Cache NFS Target. Changing this forces a new resource to be created.
    targetHostName String
    The IP address or fully qualified domain name (FQDN) of the HPC Cache NFS target. Changing this forces a new resource to be created.
    usageModel String
    The type of usage of the HPC Cache NFS Target. Possible values are: READ_HEAVY_INFREQ, READ_HEAVY_CHECK_180, WRITE_WORKLOAD_15, WRITE_AROUND, WRITE_WORKLOAD_CHECK_30, WRITE_WORKLOAD_CHECK_60 and WRITE_WORKLOAD_CLOUDWS.

    Supporting Types

    CacheNfsTargetNamespaceJunction, CacheNfsTargetNamespaceJunctionArgs

    NamespacePath string
    The client-facing file path of this NFS target within the HPC Cache NFS Target.
    NfsExport string
    The NFS export of this NFS target within the HPC Cache NFS Target.
    AccessPolicyName string
    The name of the access policy applied to this target. Defaults to default.
    TargetPath string
    The relative subdirectory path from the nfs_export to map to the namespace_path. Defaults to "", in which case the whole nfs_export is exported.
    NamespacePath string
    The client-facing file path of this NFS target within the HPC Cache NFS Target.
    NfsExport string
    The NFS export of this NFS target within the HPC Cache NFS Target.
    AccessPolicyName string
    The name of the access policy applied to this target. Defaults to default.
    TargetPath string
    The relative subdirectory path from the nfs_export to map to the namespace_path. Defaults to "", in which case the whole nfs_export is exported.
    namespacePath String
    The client-facing file path of this NFS target within the HPC Cache NFS Target.
    nfsExport String
    The NFS export of this NFS target within the HPC Cache NFS Target.
    accessPolicyName String
    The name of the access policy applied to this target. Defaults to default.
    targetPath String
    The relative subdirectory path from the nfs_export to map to the namespace_path. Defaults to "", in which case the whole nfs_export is exported.
    namespacePath string
    The client-facing file path of this NFS target within the HPC Cache NFS Target.
    nfsExport string
    The NFS export of this NFS target within the HPC Cache NFS Target.
    accessPolicyName string
    The name of the access policy applied to this target. Defaults to default.
    targetPath string
    The relative subdirectory path from the nfs_export to map to the namespace_path. Defaults to "", in which case the whole nfs_export is exported.
    namespace_path str
    The client-facing file path of this NFS target within the HPC Cache NFS Target.
    nfs_export str
    The NFS export of this NFS target within the HPC Cache NFS Target.
    access_policy_name str
    The name of the access policy applied to this target. Defaults to default.
    target_path str
    The relative subdirectory path from the nfs_export to map to the namespace_path. Defaults to "", in which case the whole nfs_export is exported.
    namespacePath String
    The client-facing file path of this NFS target within the HPC Cache NFS Target.
    nfsExport String
    The NFS export of this NFS target within the HPC Cache NFS Target.
    accessPolicyName String
    The name of the access policy applied to this target. Defaults to default.
    targetPath String
    The relative subdirectory path from the nfs_export to map to the namespace_path. Defaults to "", in which case the whole nfs_export is exported.

    Import

    NFS Target within a HPC Cache can be imported using the resource id, e.g.

     $ pulumi import azure:hpc/cacheNfsTarget:CacheNfsTarget example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StorageCache/caches/cache1/storageTargets/target1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.