CacheArgs

data class CacheArgs(val automaticallyRotateKeyToLatestEnabled: Output<Boolean>? = null, val cacheSizeInGb: Output<Int>? = null, val defaultAccessPolicy: Output<CacheDefaultAccessPolicyArgs>? = null, val directoryActiveDirectory: Output<CacheDirectoryActiveDirectoryArgs>? = null, val directoryFlatFile: Output<CacheDirectoryFlatFileArgs>? = null, val directoryLdap: Output<CacheDirectoryLdapArgs>? = null, val dns: Output<CacheDnsArgs>? = null, val identity: Output<CacheIdentityArgs>? = null, val keyVaultKeyId: Output<String>? = null, val location: Output<String>? = null, val mtu: Output<Int>? = null, val name: Output<String>? = null, val ntpServer: Output<String>? = null, val resourceGroupName: Output<String>? = null, val skuName: Output<String>? = null, val subnetId: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<CacheArgs>

Manages a HPC Cache. !>Note: The azure.hpc.Cache resource has been deprecated because the service is retiring on 2025-09-30. This resource will be removed in v5.0 of the AzureRM Provider. See https://aka.ms/hpccacheretirement for more information.

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
name: "examplevn",
addressSpaces: ["10&#46;0&#46;0&#46;0/16"],
location: example.location,
resourceGroupName: example.name,
});
const exampleSubnet = new azure.network.Subnet("example", {
name: "examplesubnet",
resourceGroupName: example.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10&#46;0&#46;1&#46;0/24"],
});
const exampleCache = new azure.hpc.Cache("example", {
name: "examplehpccache",
resourceGroupName: example.name,
location: example.location,
cacheSizeInGb: 3072,
subnetId: exampleSubnet.id,
skuName: "Standard_2G",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
name="examplevn",
address_spaces=["10&#46;0&#46;0&#46;0/16"],
location=example.location,
resource_group_name=example.name)
example_subnet = azure.network.Subnet("example",
name="examplesubnet",
resource_group_name=example.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10&#46;0&#46;1&#46;0/24"])
example_cache = azure.hpc.Cache("example",
name="examplehpccache",
resource_group_name=example.name,
location=example.location,
cache_size_in_gb=3072,
subnet_id=example_subnet.id,
sku_name="Standard_2G")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
{
Name = "examplevn",
AddressSpaces = new[]
{
"10.0.0.0/16",
},
Location = example.Location,
ResourceGroupName = example.Name,
});
var exampleSubnet = new Azure.Network.Subnet("example", new()
{
Name = "examplesubnet",
ResourceGroupName = example.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.1.0/24",
},
});
var exampleCache = new Azure.Hpc.Cache("example", new()
{
Name = "examplehpccache",
ResourceGroupName = example.Name,
Location = example.Location,
CacheSizeInGb = 3072,
SubnetId = exampleSubnet.Id,
SkuName = "Standard_2G",
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/hpc"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
Name: pulumi.String("examplevn"),
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
Location: example.Location,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
Name: pulumi.String("examplesubnet"),
ResourceGroupName: example.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.1.0/24"),
},
})
if err != nil {
return err
}
_, err = hpc.NewCache(ctx, "example", &hpc.CacheArgs{
Name: pulumi.String("examplehpccache"),
ResourceGroupName: example.Name,
Location: example.Location,
CacheSizeInGb: pulumi.Int(3072),
SubnetId: exampleSubnet.ID(),
SkuName: pulumi.String("Standard_2G"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.hpc.Cache;
import com.pulumi.azure.hpc.CacheArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.name("examplevn")
.addressSpaces("10.0.0.0/16")
.location(example.location())
.resourceGroupName(example.name())
.build());
var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
.name("examplesubnet")
.resourceGroupName(example.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.1.0/24")
.build());
var exampleCache = new Cache("exampleCache", CacheArgs.builder()
.name("examplehpccache")
.resourceGroupName(example.name())
.location(example.location())
.cacheSizeInGb(3072)
.subnetId(exampleSubnet.id())
.skuName("Standard_2G")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
name: example
properties:
name: examplevn
addressSpaces:
- 10.0.0.0/16
location: ${example.location}
resourceGroupName: ${example.name}
exampleSubnet:
type: azure:network:Subnet
name: example
properties:
name: examplesubnet
resourceGroupName: ${example.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.1.0/24
exampleCache:
type: azure:hpc:Cache
name: example
properties:
name: examplehpccache
resourceGroupName: ${example.name}
location: ${example.location}
cacheSizeInGb: 3072
subnetId: ${exampleSubnet.id}
skuName: Standard_2G

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.StorageCache: 2023-05-01

Import

HPC Caches can be imported using the resource id, e.g.

$ pulumi import azure:hpc/cache:Cache example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.StorageCache/caches/cacheName

Constructors

Link copied to clipboard
constructor(automaticallyRotateKeyToLatestEnabled: Output<Boolean>? = null, cacheSizeInGb: Output<Int>? = null, defaultAccessPolicy: Output<CacheDefaultAccessPolicyArgs>? = null, directoryActiveDirectory: Output<CacheDirectoryActiveDirectoryArgs>? = null, directoryFlatFile: Output<CacheDirectoryFlatFileArgs>? = null, directoryLdap: Output<CacheDirectoryLdapArgs>? = null, dns: Output<CacheDnsArgs>? = null, identity: Output<CacheIdentityArgs>? = null, keyVaultKeyId: Output<String>? = null, location: Output<String>? = null, mtu: Output<Int>? = null, name: Output<String>? = null, ntpServer: Output<String>? = null, resourceGroupName: Output<String>? = null, skuName: Output<String>? = null, subnetId: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard

Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.

Link copied to clipboard
val cacheSizeInGb: Output<Int>? = null

The size of the HPC Cache, in GB. Possible values are 3072, 6144, 12288, 21623, 24576, 43246, 49152 and 86491. Changing this forces a new resource to be created.

Link copied to clipboard

A default_access_policy block as defined below.

Link copied to clipboard

A directory_active_directory block as defined below.

Link copied to clipboard

A directory_flat_file block as defined below.

Link copied to clipboard

A directory_ldap block as defined below.

Link copied to clipboard
val dns: Output<CacheDnsArgs>? = null

A dns block as defined below.

Link copied to clipboard
val identity: Output<CacheIdentityArgs>? = null

An identity block as defined below. Changing this forces a new resource to be created.

Link copied to clipboard
val keyVaultKeyId: Output<String>? = null

The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.

Link copied to clipboard
val location: Output<String>? = null

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

Link copied to clipboard
val mtu: Output<Int>? = null

The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val ntpServer: Output<String>? = null

The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

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

Link copied to clipboard
val skuName: Output<String>? = null

The SKU of HPC Cache to use. Possible values are (ReadWrite) - Standard_2G, Standard_4G Standard_8G or (ReadOnly) - Standard_L4_5G, Standard_L9G, and Standard_L16G. Changing this forces a new resource to be created.

Link copied to clipboard
val subnetId: Output<String>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A mapping of tags to assign to the HPC Cache.

Functions

Link copied to clipboard
open override fun toJava(): CacheArgs