We recommend using Azure Native.
azure.hpc.CacheNfsTarget
Explore with Pulumi AI
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 runaz provider register --namespace 'Microsoft.StorageCache'
.
Create CacheNfsTarget Resource
new CacheNfsTarget(name: string, args: CacheNfsTargetArgs, opts?: CustomResourceOptions);
@overload
def CacheNfsTarget(resource_name: 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)
@overload
def CacheNfsTarget(resource_name: str,
args: CacheNfsTargetArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The CacheNfsTarget resource accepts the following input properties:
- Cache
Name string 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 List<CacheNfs Target Namespace Junction> Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- Resource
Group stringName 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 stringName 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 string The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.- Name string
The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
- Cache
Name string 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 []CacheNfs Target Namespace Junction Args Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- Resource
Group stringName 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 stringName 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 string The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.- Name string
The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
- cache
Name String 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 List<CacheNfs Target Namespace Junction> Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource
Group StringName 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 StringName 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 String The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.- name String
The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
- cache
Name string 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 CacheNfs Target Namespace Junction[] Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource
Group stringName 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 stringName 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 string The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_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[CacheNfs Target Namespace Junction Args] Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource_
group_ strname 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_ strname 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
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.- name str
The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
- cache
Name String 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 List<Property Map> Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource
Group StringName 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 StringName 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 String The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_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)
Resource lookup is not supported in YAML
- 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.
- Cache
Name 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.
- Namespace
Junctions List<CacheNfs Target Namespace Junction> Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- Resource
Group stringName 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 stringName 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 string The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.
- Cache
Name 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.
- Namespace
Junctions []CacheNfs Target Namespace Junction Args Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- Resource
Group stringName 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 stringName 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 string The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.
- cache
Name 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.
- namespace
Junctions List<CacheNfs Target Namespace Junction> Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource
Group StringName 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 StringName 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 String The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.
- cache
Name 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.
- namespace
Junctions CacheNfs Target Namespace Junction[] Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource
Group stringName 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 stringName 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 string The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_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[CacheNfs Target Namespace Junction Args] Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource_
group_ strname 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_ strname 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
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.
- cache
Name 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.
- namespace
Junctions List<Property Map> Can be specified multiple times to define multiple
namespace_junction
. Eachnamespace_juntion
block supports fields documented below.- resource
Group StringName 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 StringName 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 String The type of usage of the HPC Cache NFS Target. Possible values are:
READ_HEAVY_INFREQ
,READ_HEAVY_CHECK_180
,READ_ONLY
,READ_WRITE
,WRITE_WORKLOAD_15
,WRITE_AROUND
,WRITE_WORKLOAD_CHECK_30
,WRITE_WORKLOAD_CHECK_60
andWRITE_WORKLOAD_CLOUDWS
.
Supporting Types
CacheNfsTargetNamespaceJunction, CacheNfsTargetNamespaceJunctionArgs
- Namespace
Path string The client-facing file path of this NFS target within the HPC Cache NFS Target.
- Nfs
Export string The NFS export of this NFS target within the HPC Cache NFS Target.
- Access
Policy stringName The name of the access policy applied to this target. Defaults to
default
.- Target
Path string The relative subdirectory path from the
nfs_export
to map to thenamespace_path
. Defaults to""
, in which case the wholenfs_export
is exported.
- Namespace
Path string The client-facing file path of this NFS target within the HPC Cache NFS Target.
- Nfs
Export string The NFS export of this NFS target within the HPC Cache NFS Target.
- Access
Policy stringName The name of the access policy applied to this target. Defaults to
default
.- Target
Path string The relative subdirectory path from the
nfs_export
to map to thenamespace_path
. Defaults to""
, in which case the wholenfs_export
is exported.
- namespace
Path String The client-facing file path of this NFS target within the HPC Cache NFS Target.
- nfs
Export String The NFS export of this NFS target within the HPC Cache NFS Target.
- access
Policy StringName The name of the access policy applied to this target. Defaults to
default
.- target
Path String The relative subdirectory path from the
nfs_export
to map to thenamespace_path
. Defaults to""
, in which case the wholenfs_export
is exported.
- namespace
Path string The client-facing file path of this NFS target within the HPC Cache NFS Target.
- nfs
Export string The NFS export of this NFS target within the HPC Cache NFS Target.
- access
Policy stringName The name of the access policy applied to this target. Defaults to
default
.- target
Path string The relative subdirectory path from the
nfs_export
to map to thenamespace_path
. Defaults to""
, in which case the wholenfs_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_ strname 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 thenamespace_path
. Defaults to""
, in which case the wholenfs_export
is exported.
- namespace
Path String The client-facing file path of this NFS target within the HPC Cache NFS Target.
- nfs
Export String The NFS export of this NFS target within the HPC Cache NFS Target.
- access
Policy StringName The name of the access policy applied to this target. Defaults to
default
.- target
Path String The relative subdirectory path from the
nfs_export
to map to thenamespace_path
. Defaults to""
, in which case the wholenfs_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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.