This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

hpc¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.hpc.Cache(resource_name, opts=None, cache_size_in_gb=None, location=None, name=None, resource_group_name=None, sku_name=None, subnet_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages a HPC Cache.

Note: During the first several months of the GA release, a request must be made to the Azure HPC Cache team to add your subscription to the access list before it can be used to create a cache instance. Fill out this form to request access.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_cache = azure.hpc.Cache("exampleCache",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    cache_size_in_gb=3072,
    subnet_id=example_subnet.id,
    sku_name="Standard_2G")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cache_size_in_gb (pulumi.Input[float]) – The size of the HPC Cache, in GB. Possible values are 3072, 6144, 12288, 24576, and 49152. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the HPC Cache. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
sku_name (pulumi.Input[str]) – The SKU of HPC Cache to use. Possible values are Standard_2G, Standard_4G and Standard_8G. Changing this forces a new resource to be created.
subnet_id (pulumi.Input[str]) – The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.

cache_size_in_gb: pulumi.Output[float] = None¶: The size of the HPC Cache, in GB. Possible values are 3072, 6144, 12288, 24576, and 49152. Changing this forces a new resource to be created.

location: pulumi.Output[str] = None¶: Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.

mount_addresses: pulumi.Output[list] = None¶: A list of IP Addresses where the HPC Cache can be mounted.

name: pulumi.Output[str] = None¶: The name of the HPC Cache. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.

sku_name: pulumi.Output[str] = None¶: The SKU of HPC Cache to use. Possible values are Standard_2G, Standard_4G and Standard_8G. Changing this forces a new resource to be created.

subnet_id: pulumi.Output[str] = None¶: The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, cache_size_in_gb=None, location=None, mount_addresses=None, name=None, resource_group_name=None, sku_name=None, subnet_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cache_size_in_gb (pulumi.Input[float]) – The size of the HPC Cache, in GB. Possible values are 3072, 6144, 12288, 24576, and 49152. Changing this forces a new resource to be created.
location (pulumi.Input[str]) – Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
mount_addresses (pulumi.Input[list]) – A list of IP Addresses where the HPC Cache can be mounted.
name (pulumi.Input[str]) – The name of the HPC Cache. Changing this forces a new resource to be created.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
sku_name (pulumi.Input[str]) – The SKU of HPC Cache to use. Possible values are Standard_2G, Standard_4G and Standard_8G. Changing this forces a new resource to be created.
subnet_id (pulumi.Input[str]) – The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.hpc.CacheBlobTarget(resource_name, opts=None, cache_name=None, name=None, namespace_path=None, resource_group_name=None, storage_container_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages a Blob Target within a HPC Cache.

import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.1.0/24")
example_cache = azure.hpc.Cache("exampleCache",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    cache_size_in_gb=3072,
    subnet_id=example_subnet.id,
    sku_name="Standard_2G")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("exampleContainer", storage_account_name=example_account.name)
example_service_principal = azuread.get_service_principal(display_name="HPC Cache Resource Provider")
example_storage_account_contrib = azure.authorization.Assignment("exampleStorageAccountContrib",
    scope=example_account.id,
    role_definition_name="Storage Account Contributor",
    principal_id=example_service_principal.object_id)
example_storage_blob_data_contrib = azure.authorization.Assignment("exampleStorageBlobDataContrib",
    scope=example_account.id,
    role_definition_name="Storage Blob Data Contributor",
    principal_id=example_service_principal.object_id)
example_cache_blob_target = azure.hpc.CacheBlobTarget("exampleCacheBlobTarget",
    resource_group_name=example_resource_group.name,
    cache_name=example_cache.name,
    storage_container_id=example_container.resource_manager_id,
    namespace_path="/blob_storage")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cache_name (pulumi.Input[str]) – The name HPC Cache, which the HPC Cache Blob Target will be added to. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the HPC Cache Blob Target. Changing this forces a new resource to be created.
namespace_path (pulumi.Input[str]) – The client-facing file path of the HPC Cache Blob Target.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the HPC Cache Blob Target. Changing this forces a new resource to be created.
storage_container_id (pulumi.Input[str]) – The Resource Manager ID of the Storage Container used as the HPC Cache Blob Target. Changing this forces a new resource to be created.

cache_name: pulumi.Output[str] = None¶: The name HPC Cache, which the HPC Cache Blob Target will be added to. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the HPC Cache Blob Target. Changing this forces a new resource to be created.

namespace_path: pulumi.Output[str] = None¶: The client-facing file path of the HPC Cache Blob Target.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group in which to create the HPC Cache Blob Target. Changing this forces a new resource to be created.

storage_container_id: pulumi.Output[str] = None¶: The Resource Manager ID of the Storage Container used as the HPC Cache Blob Target. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, cache_name=None, name=None, namespace_path=None, resource_group_name=None, storage_container_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cache_name (pulumi.Input[str]) – The name HPC Cache, which the HPC Cache Blob Target will be added to. Changing this forces a new resource to be created.
name (pulumi.Input[str]) – The name of the HPC Cache Blob Target. Changing this forces a new resource to be created.
namespace_path (pulumi.Input[str]) – The client-facing file path of the HPC Cache Blob Target.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the HPC Cache Blob Target. Changing this forces a new resource to be created.
storage_container_id (pulumi.Input[str]) – The Resource Manager ID of the Storage Container used as the HPC Cache Blob Target. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.hpc.CacheNfsTarget(resource_name, opts=None, cache_name=None, name=None, namespace_junctions=None, resource_group_name=None, target_host_name=None, usage_model=None, __props__=None, __name__=None, __opts__=None)¶

Manages a NFS Target within a HPC Cache.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cache_name (pulumi.Input[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 (pulumi.Input[str]) – The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
namespace_junctions (pulumi.Input[list]) – Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
resource_group_name (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The type of usage of the HPC Cache NFS Target.

The namespace_junctions object supports the following:

namespace_path (pulumi.Input[str]) - The client-facing file path of this NFS target within the HPC Cache NFS Target.
nfsExport (pulumi.Input[str]) - The NFS export of this NFS target within the HPC Cache NFS Target.
targetPath (pulumi.Input[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.

cache_name: pulumi.Output[str] = None¶: The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.

namespace_junctions: pulumi.Output[list] = None¶

Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.

namespace_path (str) - The client-facing file path of this NFS target within the HPC Cache NFS Target.
nfsExport (str) - The NFS export of this NFS target within the HPC Cache NFS Target.
targetPath (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.

resource_group_name: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: The type of usage of the HPC Cache NFS Target.

static get(resource_name, id, opts=None, cache_name=None, name=None, namespace_junctions=None, resource_group_name=None, target_host_name=None, usage_model=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cache_name (pulumi.Input[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 (pulumi.Input[str]) – The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.
namespace_junctions (pulumi.Input[list]) – Can be specified multiple times to define multiple namespace_junction. Each namespace_juntion block supports fields documented below.
resource_group_name (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The type of usage of the HPC Cache NFS Target.

The namespace_junctions object supports the following:

namespace_path (pulumi.Input[str]) - The client-facing file path of this NFS target within the HPC Cache NFS Target.
nfsExport (pulumi.Input[str]) - The NFS export of this NFS target within the HPC Cache NFS Target.
targetPath (pulumi.Input[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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

hpc¶

On This Page