Module hpc

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.

Resources

Cache
CacheBlobTarget
CacheNfsTarget

Resources

Resource Cache

class Cache extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const exampleCache = new azure.hpc.Cache("exampleCache", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    cacheSizeInGb: 3072,
    subnetId: exampleSubnet.id,
    skuName: "Standard_2G",
});

constructor

new Cache(name: string, args: CacheArgs, opts?: pulumi.CustomResourceOptions)

Create a Cache resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CacheState, opts?: pulumi.CustomResourceOptions): Cache

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cache

Returns true if the given object is an instance of Cache. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cacheSizeInGb

public cacheSizeInGb: pulumi.Output<number>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.

property mountAddresses

public mountAddresses: pulumi.Output<string[]>;

A list of IP Addresses where the HPC Cache can be mounted.

property name

public name: pulumi.Output<string>;

The name of the HPC Cache. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.

property skuName

public skuName: pulumi.Output<string>;

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.

property subnetId

public subnetId: pulumi.Output<string>;

The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CacheBlobTarget

class CacheBlobTarget extends CustomResource

Manages a Blob Target within a HPC Cache.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as azuread from "@pulumi/azuread";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    addressSpaces: ["10.0.0.0/16"],
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
    resourceGroupName: exampleResourceGroup.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefix: "10.0.1.0/24",
});
const exampleCache = new azure.hpc.Cache("exampleCache", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    cacheSizeInGb: 3072,
    subnetId: exampleSubnet.id,
    skuName: "Standard_2G",
});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleContainer = new azure.storage.Container("exampleContainer", {storageAccountName: exampleAccount.name});
const exampleServicePrincipal = azuread.getServicePrincipal({
    displayName: "HPC Cache Resource Provider",
});
const exampleStorageAccountContrib = new azure.authorization.Assignment("exampleStorageAccountContrib", {
    scope: exampleAccount.id,
    roleDefinitionName: "Storage Account Contributor",
    principalId: exampleServicePrincipal.then(exampleServicePrincipal => exampleServicePrincipal.objectId),
});
const exampleStorageBlobDataContrib = new azure.authorization.Assignment("exampleStorageBlobDataContrib", {
    scope: exampleAccount.id,
    roleDefinitionName: "Storage Blob Data Contributor",
    principalId: exampleServicePrincipal.then(exampleServicePrincipal => exampleServicePrincipal.objectId),
});
const exampleCacheBlobTarget = new azure.hpc.CacheBlobTarget("exampleCacheBlobTarget", {
    resourceGroupName: exampleResourceGroup.name,
    cacheName: exampleCache.name,
    storageContainerId: exampleContainer.resourceManagerId,
    namespacePath: "/blob_storage",
});

constructor

new CacheBlobTarget(name: string, args: CacheBlobTargetArgs, opts?: pulumi.CustomResourceOptions)

Create a CacheBlobTarget resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CacheBlobTargetState, opts?: pulumi.CustomResourceOptions): CacheBlobTarget

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CacheBlobTarget

Returns true if the given object is an instance of CacheBlobTarget. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cacheName

public cacheName: pulumi.Output<string>;

The name HPC Cache, which the HPC Cache Blob Target will be added to. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the HPC Cache Blob Target. Changing this forces a new resource to be created.

property namespacePath

public namespacePath: pulumi.Output<string>;

The client-facing file path of the HPC Cache Blob Target.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which to create the HPC Cache Blob Target. Changing this forces a new resource to be created.

property storageContainerId

public storageContainerId: pulumi.Output<string>;

The Resource Manager ID of the Storage Container used as the HPC Cache Blob Target. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CacheNfsTarget

class CacheNfsTarget extends CustomResource

Manages a NFS Target within a HPC Cache.

constructor

new CacheNfsTarget(name: string, args: CacheNfsTargetArgs, opts?: pulumi.CustomResourceOptions)

Create a CacheNfsTarget resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CacheNfsTargetState, opts?: pulumi.CustomResourceOptions): CacheNfsTarget

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CacheNfsTarget

Returns true if the given object is an instance of CacheNfsTarget. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cacheName

public cacheName: pulumi.Output<string>;

The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.

property namespaceJunctions

public namespaceJunctions: pulumi.Output<CacheNfsTargetNamespaceJunction[]>;

Can be specified multiple times to define multiple namespaceJunction. Each namespaceJuntion block supports fields documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<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.

property targetHostName

public targetHostName: pulumi.Output<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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property usageModel

public usageModel: pulumi.Output<string>;

The type of usage of the HPC Cache NFS Target.

Others

interface CacheArgs

interface CacheArgs

The set of arguments for constructing a Cache resource.

property cacheSizeInGb

cacheSizeInGb: pulumi.Input<number>;

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.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the HPC Cache. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.

property skuName

skuName: pulumi.Input<string>;

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.

property subnetId

subnetId: pulumi.Input<string>;

The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.

interface CacheBlobTargetArgs

interface CacheBlobTargetArgs

The set of arguments for constructing a CacheBlobTarget resource.

property cacheName

cacheName: pulumi.Input<string>;

The name HPC Cache, which the HPC Cache Blob Target will be added to. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the HPC Cache Blob Target. Changing this forces a new resource to be created.

property namespacePath

namespacePath: pulumi.Input<string>;

The client-facing file path of the HPC Cache Blob Target.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which to create the HPC Cache Blob Target. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: pulumi.Input<string>;

The Resource Manager ID of the Storage Container used as the HPC Cache Blob Target. Changing this forces a new resource to be created.

interface CacheBlobTargetState

interface CacheBlobTargetState

Input properties used for looking up and filtering CacheBlobTarget resources.

property cacheName

cacheName?: pulumi.Input<string>;

The name HPC Cache, which the HPC Cache Blob Target will be added to. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the HPC Cache Blob Target. Changing this forces a new resource to be created.

property namespacePath

namespacePath?: pulumi.Input<string>;

The client-facing file path of the HPC Cache Blob Target.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which to create the HPC Cache Blob Target. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId?: pulumi.Input<string>;

The Resource Manager ID of the Storage Container used as the HPC Cache Blob Target. Changing this forces a new resource to be created.

interface CacheNfsTargetArgs

interface CacheNfsTargetArgs

The set of arguments for constructing a CacheNfsTarget resource.

property cacheName

cacheName: pulumi.Input<string>;

The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.

property namespaceJunctions

namespaceJunctions: pulumi.Input<pulumi.Input<CacheNfsTargetNamespaceJunction>[]>;

Can be specified multiple times to define multiple namespaceJunction. Each namespaceJuntion block supports fields documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<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.

property targetHostName

targetHostName: pulumi.Input<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.

property usageModel

usageModel: pulumi.Input<string>;

The type of usage of the HPC Cache NFS Target.

interface CacheNfsTargetState

interface CacheNfsTargetState

Input properties used for looking up and filtering CacheNfsTarget resources.

property cacheName

cacheName?: pulumi.Input<string>;

The name HPC Cache, which the HPC Cache NFS Target will be added to. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the HPC Cache NFS Target. Changing this forces a new resource to be created.

property namespaceJunctions

namespaceJunctions?: pulumi.Input<pulumi.Input<CacheNfsTargetNamespaceJunction>[]>;

Can be specified multiple times to define multiple namespaceJunction. Each namespaceJuntion block supports fields documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<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.

property targetHostName

targetHostName?: pulumi.Input<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.

property usageModel

usageModel?: pulumi.Input<string>;

The type of usage of the HPC Cache NFS Target.

interface CacheState

interface CacheState

Input properties used for looking up and filtering Cache resources.

property cacheSizeInGb

cacheSizeInGb?: pulumi.Input<number>;

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.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.

property mountAddresses

mountAddresses?: pulumi.Input<pulumi.Input<string>[]>;

A list of IP Addresses where the HPC Cache can be mounted.

property name

name?: pulumi.Input<string>;

The name of the HPC Cache. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.

property skuName

skuName?: pulumi.Input<string>;

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.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module hpc

Resources

Others

Resources

Example Usage

Example Usage

Others