Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. hpc
  5. Cache

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.hpc.Cache

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages 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'.

    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.0.0.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.0.1.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.0.0.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.0.1.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")

    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
	})
}

    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 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

    Create Cache Resource

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

    Constructor syntax

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

@overload
def Cache(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          resource_group_name: Optional[str] = None,
          cache_size_in_gb: Optional[int] = None,
          subnet_id: Optional[str] = None,
          sku_name: Optional[str] = None,
          key_vault_key_id: Optional[str] = None,
          directory_ldap: Optional[CacheDirectoryLdapArgs] = None,
          dns: Optional[CacheDnsArgs] = None,
          identity: Optional[CacheIdentityArgs] = None,
          automatically_rotate_key_to_latest_enabled: Optional[bool] = None,
          location: Optional[str] = None,
          mtu: Optional[int] = None,
          name: Optional[str] = None,
          ntp_server: Optional[str] = None,
          directory_flat_file: Optional[CacheDirectoryFlatFileArgs] = None,
          directory_active_directory: Optional[CacheDirectoryActiveDirectoryArgs] = None,
          default_access_policy: Optional[CacheDefaultAccessPolicyArgs] = None,
          tags: Optional[Mapping[str, str]] = None)
    func NewCache(ctx *Context, name string, args CacheArgs, opts ...ResourceOption) (*Cache, error)
    public Cache(string name, CacheArgs args, CustomResourceOptions? opts = null)
    public Cache(String name, CacheArgs args)
public Cache(String name, CacheArgs args, CustomResourceOptions options)

    type: azure:hpc:Cache
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 CacheArgs
    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 CacheArgs
    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 CacheArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CacheArgs
    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 cacheResource = new Azure.Hpc.Cache("cacheResource", new()
{
    ResourceGroupName = "string",
    CacheSizeInGb = 0,
    SubnetId = "string",
    SkuName = "string",
    KeyVaultKeyId = "string",
    DirectoryLdap = new Azure.Hpc.Inputs.CacheDirectoryLdapArgs
    {
        BaseDn = "string",
        Server = "string",
        Bind = new Azure.Hpc.Inputs.CacheDirectoryLdapBindArgs
        {
            Dn = "string",
            Password = "string",
        },
        CertificateValidationUri = "string",
        DownloadCertificateAutomatically = false,
        Encrypted = false,
    },
    Dns = new Azure.Hpc.Inputs.CacheDnsArgs
    {
        Servers = new[]
        {
            "string",
        },
        SearchDomain = "string",
    },
    Identity = new Azure.Hpc.Inputs.CacheIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    AutomaticallyRotateKeyToLatestEnabled = false,
    Location = "string",
    Mtu = 0,
    Name = "string",
    NtpServer = "string",
    DirectoryFlatFile = new Azure.Hpc.Inputs.CacheDirectoryFlatFileArgs
    {
        GroupFileUri = "string",
        PasswordFileUri = "string",
    },
    DirectoryActiveDirectory = new Azure.Hpc.Inputs.CacheDirectoryActiveDirectoryArgs
    {
        CacheNetbiosName = "string",
        DnsPrimaryIp = "string",
        DomainName = "string",
        DomainNetbiosName = "string",
        Password = "string",
        Username = "string",
        DnsSecondaryIp = "string",
    },
    DefaultAccessPolicy = new Azure.Hpc.Inputs.CacheDefaultAccessPolicyArgs
    {
        AccessRules = new[]
        {
            new Azure.Hpc.Inputs.CacheDefaultAccessPolicyAccessRuleArgs
            {
                Access = "string",
                Scope = "string",
                AnonymousGid = 0,
                AnonymousUid = 0,
                Filter = "string",
                RootSquashEnabled = false,
                SubmountAccessEnabled = false,
                SuidEnabled = false,
            },
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := hpc.NewCache(ctx, "cacheResource", &hpc.CacheArgs{
	ResourceGroupName: pulumi.String("string"),
	CacheSizeInGb:     pulumi.Int(0),
	SubnetId:          pulumi.String("string"),
	SkuName:           pulumi.String("string"),
	KeyVaultKeyId:     pulumi.String("string"),
	DirectoryLdap: &hpc.CacheDirectoryLdapArgs{
		BaseDn: pulumi.String("string"),
		Server: pulumi.String("string"),
		Bind: &hpc.CacheDirectoryLdapBindArgs{
			Dn:       pulumi.String("string"),
			Password: pulumi.String("string"),
		},
		CertificateValidationUri:         pulumi.String("string"),
		DownloadCertificateAutomatically: pulumi.Bool(false),
		Encrypted:                        pulumi.Bool(false),
	},
	Dns: &hpc.CacheDnsArgs{
		Servers: pulumi.StringArray{
			pulumi.String("string"),
		},
		SearchDomain: pulumi.String("string"),
	},
	Identity: &hpc.CacheIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	AutomaticallyRotateKeyToLatestEnabled: pulumi.Bool(false),
	Location:                              pulumi.String("string"),
	Mtu:                                   pulumi.Int(0),
	Name:                                  pulumi.String("string"),
	NtpServer:                             pulumi.String("string"),
	DirectoryFlatFile: &hpc.CacheDirectoryFlatFileArgs{
		GroupFileUri:    pulumi.String("string"),
		PasswordFileUri: pulumi.String("string"),
	},
	DirectoryActiveDirectory: &hpc.CacheDirectoryActiveDirectoryArgs{
		CacheNetbiosName:  pulumi.String("string"),
		DnsPrimaryIp:      pulumi.String("string"),
		DomainName:        pulumi.String("string"),
		DomainNetbiosName: pulumi.String("string"),
		Password:          pulumi.String("string"),
		Username:          pulumi.String("string"),
		DnsSecondaryIp:    pulumi.String("string"),
	},
	DefaultAccessPolicy: &hpc.CacheDefaultAccessPolicyArgs{
		AccessRules: hpc.CacheDefaultAccessPolicyAccessRuleArray{
			&hpc.CacheDefaultAccessPolicyAccessRuleArgs{
				Access:                pulumi.String("string"),
				Scope:                 pulumi.String("string"),
				AnonymousGid:          pulumi.Int(0),
				AnonymousUid:          pulumi.Int(0),
				Filter:                pulumi.String("string"),
				RootSquashEnabled:     pulumi.Bool(false),
				SubmountAccessEnabled: pulumi.Bool(false),
				SuidEnabled:           pulumi.Bool(false),
			},
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var cacheResource = new Cache("cacheResource", CacheArgs.builder()
    .resourceGroupName("string")
    .cacheSizeInGb(0)
    .subnetId("string")
    .skuName("string")
    .keyVaultKeyId("string")
    .directoryLdap(CacheDirectoryLdapArgs.builder()
        .baseDn("string")
        .server("string")
        .bind(CacheDirectoryLdapBindArgs.builder()
            .dn("string")
            .password("string")
            .build())
        .certificateValidationUri("string")
        .downloadCertificateAutomatically(false)
        .encrypted(false)
        .build())
    .dns(CacheDnsArgs.builder()
        .servers("string")
        .searchDomain("string")
        .build())
    .identity(CacheIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .automaticallyRotateKeyToLatestEnabled(false)
    .location("string")
    .mtu(0)
    .name("string")
    .ntpServer("string")
    .directoryFlatFile(CacheDirectoryFlatFileArgs.builder()
        .groupFileUri("string")
        .passwordFileUri("string")
        .build())
    .directoryActiveDirectory(CacheDirectoryActiveDirectoryArgs.builder()
        .cacheNetbiosName("string")
        .dnsPrimaryIp("string")
        .domainName("string")
        .domainNetbiosName("string")
        .password("string")
        .username("string")
        .dnsSecondaryIp("string")
        .build())
    .defaultAccessPolicy(CacheDefaultAccessPolicyArgs.builder()
        .accessRules(CacheDefaultAccessPolicyAccessRuleArgs.builder()
            .access("string")
            .scope("string")
            .anonymousGid(0)
            .anonymousUid(0)
            .filter("string")
            .rootSquashEnabled(false)
            .submountAccessEnabled(false)
            .suidEnabled(false)
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .build());

    cache_resource = azure.hpc.Cache("cacheResource",
    resource_group_name="string",
    cache_size_in_gb=0,
    subnet_id="string",
    sku_name="string",
    key_vault_key_id="string",
    directory_ldap={
        "baseDn": "string",
        "server": "string",
        "bind": {
            "dn": "string",
            "password": "string",
        },
        "certificateValidationUri": "string",
        "downloadCertificateAutomatically": False,
        "encrypted": False,
    },
    dns={
        "servers": ["string"],
        "searchDomain": "string",
    },
    identity={
        "type": "string",
        "identityIds": ["string"],
        "principalId": "string",
        "tenantId": "string",
    },
    automatically_rotate_key_to_latest_enabled=False,
    location="string",
    mtu=0,
    name="string",
    ntp_server="string",
    directory_flat_file={
        "groupFileUri": "string",
        "passwordFileUri": "string",
    },
    directory_active_directory={
        "cacheNetbiosName": "string",
        "dnsPrimaryIp": "string",
        "domainName": "string",
        "domainNetbiosName": "string",
        "password": "string",
        "username": "string",
        "dnsSecondaryIp": "string",
    },
    default_access_policy={
        "accessRules": [{
            "access": "string",
            "scope": "string",
            "anonymousGid": 0,
            "anonymousUid": 0,
            "filter": "string",
            "rootSquashEnabled": False,
            "submountAccessEnabled": False,
            "suidEnabled": False,
        }],
    },
    tags={
        "string": "string",
    })

    const cacheResource = new azure.hpc.Cache("cacheResource", {
    resourceGroupName: "string",
    cacheSizeInGb: 0,
    subnetId: "string",
    skuName: "string",
    keyVaultKeyId: "string",
    directoryLdap: {
        baseDn: "string",
        server: "string",
        bind: {
            dn: "string",
            password: "string",
        },
        certificateValidationUri: "string",
        downloadCertificateAutomatically: false,
        encrypted: false,
    },
    dns: {
        servers: ["string"],
        searchDomain: "string",
    },
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    automaticallyRotateKeyToLatestEnabled: false,
    location: "string",
    mtu: 0,
    name: "string",
    ntpServer: "string",
    directoryFlatFile: {
        groupFileUri: "string",
        passwordFileUri: "string",
    },
    directoryActiveDirectory: {
        cacheNetbiosName: "string",
        dnsPrimaryIp: "string",
        domainName: "string",
        domainNetbiosName: "string",
        password: "string",
        username: "string",
        dnsSecondaryIp: "string",
    },
    defaultAccessPolicy: {
        accessRules: [{
            access: "string",
            scope: "string",
            anonymousGid: 0,
            anonymousUid: 0,
            filter: "string",
            rootSquashEnabled: false,
            submountAccessEnabled: false,
            suidEnabled: false,
        }],
    },
    tags: {
        string: "string",
    },
});

    type: azure:hpc:Cache
properties:
    automaticallyRotateKeyToLatestEnabled: false
    cacheSizeInGb: 0
    defaultAccessPolicy:
        accessRules:
            - access: string
              anonymousGid: 0
              anonymousUid: 0
              filter: string
              rootSquashEnabled: false
              scope: string
              submountAccessEnabled: false
              suidEnabled: false
    directoryActiveDirectory:
        cacheNetbiosName: string
        dnsPrimaryIp: string
        dnsSecondaryIp: string
        domainName: string
        domainNetbiosName: string
        password: string
        username: string
    directoryFlatFile:
        groupFileUri: string
        passwordFileUri: string
    directoryLdap:
        baseDn: string
        bind:
            dn: string
            password: string
        certificateValidationUri: string
        downloadCertificateAutomatically: false
        encrypted: false
        server: string
    dns:
        searchDomain: string
        servers:
            - string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    keyVaultKeyId: string
    location: string
    mtu: 0
    name: string
    ntpServer: string
    resourceGroupName: string
    skuName: string
    subnetId: string
    tags:
        string: string

    Cache 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 Cache resource accepts the following input properties:

    CacheSizeInGb int

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

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

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    SubnetId string
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    AutomaticallyRotateKeyToLatestEnabled bool
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    DefaultAccessPolicy CacheDefaultAccessPolicy
    A default_access_policy block as defined below.
    DirectoryActiveDirectory CacheDirectoryActiveDirectory
    A directory_active_directory block as defined below.
    DirectoryFlatFile CacheDirectoryFlatFile
    A directory_flat_file block as defined below.
    DirectoryLdap CacheDirectoryLdap

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    Dns CacheDns
    A dns block as defined below.
    Identity CacheIdentity
    An identity block as defined below. Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    Location string
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    Mtu int
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    Name string
    The name of the HPC Cache. Changing this forces a new resource to be created.
    NtpServer string
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the HPC Cache.
    CacheSizeInGb int

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

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

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    SubnetId string
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    AutomaticallyRotateKeyToLatestEnabled bool
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    DefaultAccessPolicy CacheDefaultAccessPolicyArgs
    A default_access_policy block as defined below.
    DirectoryActiveDirectory CacheDirectoryActiveDirectoryArgs
    A directory_active_directory block as defined below.
    DirectoryFlatFile CacheDirectoryFlatFileArgs
    A directory_flat_file block as defined below.
    DirectoryLdap CacheDirectoryLdapArgs

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    Dns CacheDnsArgs
    A dns block as defined below.
    Identity CacheIdentityArgs
    An identity block as defined below. Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    Location string
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    Mtu int
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    Name string
    The name of the HPC Cache. Changing this forces a new resource to be created.
    NtpServer string
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    Tags map[string]string
    A mapping of tags to assign to the HPC Cache.
    cacheSizeInGb Integer

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

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

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnetId String
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    automaticallyRotateKeyToLatestEnabled Boolean
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    defaultAccessPolicy CacheDefaultAccessPolicy
    A default_access_policy block as defined below.
    directoryActiveDirectory CacheDirectoryActiveDirectory
    A directory_active_directory block as defined below.
    directoryFlatFile CacheDirectoryFlatFile
    A directory_flat_file block as defined below.
    directoryLdap CacheDirectoryLdap

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns CacheDns
    A dns block as defined below.
    identity CacheIdentity
    An identity block as defined below. Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location String
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mtu Integer
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name String
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntpServer String
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    tags Map<String,String>
    A mapping of tags to assign to the HPC Cache.
    cacheSizeInGb number

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

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

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnetId string
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    automaticallyRotateKeyToLatestEnabled boolean
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    defaultAccessPolicy CacheDefaultAccessPolicy
    A default_access_policy block as defined below.
    directoryActiveDirectory CacheDirectoryActiveDirectory
    A directory_active_directory block as defined below.
    directoryFlatFile CacheDirectoryFlatFile
    A directory_flat_file block as defined below.
    directoryLdap CacheDirectoryLdap

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns CacheDns
    A dns block as defined below.
    identity CacheIdentity
    An identity block as defined below. Changing this forces a new resource to be created.
    keyVaultKeyId string
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location string
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mtu number
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name string
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntpServer string
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    tags {[key: string]: string}
    A mapping of tags to assign to the HPC Cache.
    cache_size_in_gb int

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    resource_group_name 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 str

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnet_id str
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    automatically_rotate_key_to_latest_enabled bool
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    default_access_policy CacheDefaultAccessPolicyArgs
    A default_access_policy block as defined below.
    directory_active_directory CacheDirectoryActiveDirectoryArgs
    A directory_active_directory block as defined below.
    directory_flat_file CacheDirectoryFlatFileArgs
    A directory_flat_file block as defined below.
    directory_ldap CacheDirectoryLdapArgs

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns CacheDnsArgs
    A dns block as defined below.
    identity CacheIdentityArgs
    An identity block as defined below. Changing this forces a new resource to be created.
    key_vault_key_id str
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location str
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mtu int
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name str
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntp_server str
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    tags Mapping[str, str]
    A mapping of tags to assign to the HPC Cache.
    cacheSizeInGb Number

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

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

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnetId String
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    automaticallyRotateKeyToLatestEnabled Boolean
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    defaultAccessPolicy Property Map
    A default_access_policy block as defined below.
    directoryActiveDirectory Property Map
    A directory_active_directory block as defined below.
    directoryFlatFile Property Map
    A directory_flat_file block as defined below.
    directoryLdap Property Map

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns Property Map
    A dns block as defined below.
    identity Property Map
    An identity block as defined below. Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location String
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mtu Number
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name String
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntpServer String
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    tags Map<String>
    A mapping of tags to assign to the HPC Cache.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MountAddresses List<string>
    A list of IP Addresses where the HPC Cache can be mounted.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountAddresses []string
    A list of IP Addresses where the HPC Cache can be mounted.
    id String
    The provider-assigned unique ID for this managed resource.
    mountAddresses List<String>
    A list of IP Addresses where the HPC Cache can be mounted.
    id string
    The provider-assigned unique ID for this managed resource.
    mountAddresses string[]
    A list of IP Addresses where the HPC Cache can be mounted.
    id str
    The provider-assigned unique ID for this managed resource.
    mount_addresses Sequence[str]
    A list of IP Addresses where the HPC Cache can be mounted.
    id String
    The provider-assigned unique ID for this managed resource.
    mountAddresses List<String>
    A list of IP Addresses where the HPC Cache can be mounted.

    Look up Existing Cache Resource

    Get an existing Cache 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?: CacheState, opts?: CustomResourceOptions): Cache
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automatically_rotate_key_to_latest_enabled: Optional[bool] = None,
        cache_size_in_gb: Optional[int] = None,
        default_access_policy: Optional[CacheDefaultAccessPolicyArgs] = None,
        directory_active_directory: Optional[CacheDirectoryActiveDirectoryArgs] = None,
        directory_flat_file: Optional[CacheDirectoryFlatFileArgs] = None,
        directory_ldap: Optional[CacheDirectoryLdapArgs] = None,
        dns: Optional[CacheDnsArgs] = None,
        identity: Optional[CacheIdentityArgs] = None,
        key_vault_key_id: Optional[str] = None,
        location: Optional[str] = None,
        mount_addresses: Optional[Sequence[str]] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        ntp_server: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Cache
    func GetCache(ctx *Context, name string, id IDInput, state *CacheState, opts ...ResourceOption) (*Cache, error)
    public static Cache Get(string name, Input<string> id, CacheState? state, CustomResourceOptions? opts = null)
    public static Cache get(String name, Output<String> id, CacheState 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.
    The following state arguments are supported:
    AutomaticallyRotateKeyToLatestEnabled bool
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    CacheSizeInGb int

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    DefaultAccessPolicy CacheDefaultAccessPolicy
    A default_access_policy block as defined below.
    DirectoryActiveDirectory CacheDirectoryActiveDirectory
    A directory_active_directory block as defined below.
    DirectoryFlatFile CacheDirectoryFlatFile
    A directory_flat_file block as defined below.
    DirectoryLdap CacheDirectoryLdap

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    Dns CacheDns
    A dns block as defined below.
    Identity CacheIdentity
    An identity block as defined below. Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    Location string
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    MountAddresses List<string>
    A list of IP Addresses where the HPC Cache can be mounted.
    Mtu int
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    Name string
    The name of the HPC Cache. Changing this forces a new resource to be created.
    NtpServer string
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    ResourceGroupName string
    The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
    SkuName string

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    SubnetId string
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the HPC Cache.
    AutomaticallyRotateKeyToLatestEnabled bool
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    CacheSizeInGb int

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    DefaultAccessPolicy CacheDefaultAccessPolicyArgs
    A default_access_policy block as defined below.
    DirectoryActiveDirectory CacheDirectoryActiveDirectoryArgs
    A directory_active_directory block as defined below.
    DirectoryFlatFile CacheDirectoryFlatFileArgs
    A directory_flat_file block as defined below.
    DirectoryLdap CacheDirectoryLdapArgs

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    Dns CacheDnsArgs
    A dns block as defined below.
    Identity CacheIdentityArgs
    An identity block as defined below. Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    Location string
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    MountAddresses []string
    A list of IP Addresses where the HPC Cache can be mounted.
    Mtu int
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    Name string
    The name of the HPC Cache. Changing this forces a new resource to be created.
    NtpServer string
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    ResourceGroupName string
    The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
    SkuName string

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    SubnetId string
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the HPC Cache.
    automaticallyRotateKeyToLatestEnabled Boolean
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    cacheSizeInGb Integer

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    defaultAccessPolicy CacheDefaultAccessPolicy
    A default_access_policy block as defined below.
    directoryActiveDirectory CacheDirectoryActiveDirectory
    A directory_active_directory block as defined below.
    directoryFlatFile CacheDirectoryFlatFile
    A directory_flat_file block as defined below.
    directoryLdap CacheDirectoryLdap

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns CacheDns
    A dns block as defined below.
    identity CacheIdentity
    An identity block as defined below. Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location String
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mountAddresses List<String>
    A list of IP Addresses where the HPC Cache can be mounted.
    mtu Integer
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name String
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntpServer String
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    resourceGroupName String
    The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
    skuName String

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnetId String
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the HPC Cache.
    automaticallyRotateKeyToLatestEnabled boolean
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    cacheSizeInGb number

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    defaultAccessPolicy CacheDefaultAccessPolicy
    A default_access_policy block as defined below.
    directoryActiveDirectory CacheDirectoryActiveDirectory
    A directory_active_directory block as defined below.
    directoryFlatFile CacheDirectoryFlatFile
    A directory_flat_file block as defined below.
    directoryLdap CacheDirectoryLdap

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns CacheDns
    A dns block as defined below.
    identity CacheIdentity
    An identity block as defined below. Changing this forces a new resource to be created.
    keyVaultKeyId string
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location string
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mountAddresses string[]
    A list of IP Addresses where the HPC Cache can be mounted.
    mtu number
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name string
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntpServer string
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    resourceGroupName string
    The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
    skuName string

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnetId string
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the HPC Cache.
    automatically_rotate_key_to_latest_enabled bool
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    cache_size_in_gb int

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    default_access_policy CacheDefaultAccessPolicyArgs
    A default_access_policy block as defined below.
    directory_active_directory CacheDirectoryActiveDirectoryArgs
    A directory_active_directory block as defined below.
    directory_flat_file CacheDirectoryFlatFileArgs
    A directory_flat_file block as defined below.
    directory_ldap CacheDirectoryLdapArgs

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns CacheDnsArgs
    A dns block as defined below.
    identity CacheIdentityArgs
    An identity block as defined below. Changing this forces a new resource to be created.
    key_vault_key_id str
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location str
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mount_addresses Sequence[str]
    A list of IP Addresses where the HPC Cache can be mounted.
    mtu int
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name str
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntp_server str
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    resource_group_name 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 str

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnet_id str
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the HPC Cache.
    automaticallyRotateKeyToLatestEnabled Boolean
    Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
    cacheSizeInGb Number

    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.

    NOTE: The 21623, 43246 and 86491 sizes are restricted to read only resources.

    defaultAccessPolicy Property Map
    A default_access_policy block as defined below.
    directoryActiveDirectory Property Map
    A directory_active_directory block as defined below.
    directoryFlatFile Property Map
    A directory_flat_file block as defined below.
    directoryLdap Property Map

    A directory_ldap block as defined below.

    Note: Only one of directory_active_directory, directory_flat_file and directory_ldap can be set.

    dns Property Map
    A dns block as defined below.
    identity Property Map
    An identity block as defined below. Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key which should be used to encrypt the data in this HPC Cache.
    location String
    Specifies the supported Azure Region where the HPC Cache should be created. Changing this forces a new resource to be created.
    mountAddresses List<String>
    A list of IP Addresses where the HPC Cache can be mounted.
    mtu Number
    The IPv4 maximum transmission unit configured for the subnet of the HPC Cache. Possible values range from 576 - 1500. Defaults to 1500.
    name String
    The name of the HPC Cache. Changing this forces a new resource to be created.
    ntpServer String
    The NTP server IP Address or FQDN for the HPC Cache. Defaults to time.windows.com.
    resourceGroupName String
    The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
    skuName String

    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.

    NOTE: The read-only SKUs have restricted cache sizes. Standard_L4_5G must be set to 21623. Standard_L9G to 43246 and Standard_L16G to 86491.

    subnetId String
    The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the HPC Cache.

    Supporting Types

    CacheDefaultAccessPolicy, CacheDefaultAccessPolicyArgs

    AccessRules List<CacheDefaultAccessPolicyAccessRule>
    One or more access_rule blocks (up to three) as defined above.
    AccessRules []CacheDefaultAccessPolicyAccessRule
    One or more access_rule blocks (up to three) as defined above.
    accessRules List<CacheDefaultAccessPolicyAccessRule>
    One or more access_rule blocks (up to three) as defined above.
    accessRules CacheDefaultAccessPolicyAccessRule[]
    One or more access_rule blocks (up to three) as defined above.
    access_rules Sequence[CacheDefaultAccessPolicyAccessRule]
    One or more access_rule blocks (up to three) as defined above.
    accessRules List<Property Map>
    One or more access_rule blocks (up to three) as defined above.

    CacheDefaultAccessPolicyAccessRule, CacheDefaultAccessPolicyAccessRuleArgs

    Access string
    The access level for this rule. Possible values are: rw, ro, no.
    Scope string

    The scope of this rule. The scope and (potentially) the filter determine which clients match the rule. Possible values are: default, network, host.

    Note: Each access_rule should set a unique scope.

    AnonymousGid int
    The anonymous GID used when root_squash_enabled is true.
    AnonymousUid int
    The anonymous UID used when root_squash_enabled is true.
    Filter string
    The filter applied to the scope for this rule. The filter's format depends on its scope: default scope matches all clients and has no filter value; network scope takes a CIDR format; host takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied.
    RootSquashEnabled bool
    Whether to enable root squash?
    SubmountAccessEnabled bool
    Whether allow access to subdirectories under the root export?
    SuidEnabled bool
    Whether SUID is allowed?
    Access string
    The access level for this rule. Possible values are: rw, ro, no.
    Scope string

    The scope of this rule. The scope and (potentially) the filter determine which clients match the rule. Possible values are: default, network, host.

    Note: Each access_rule should set a unique scope.

    AnonymousGid int
    The anonymous GID used when root_squash_enabled is true.
    AnonymousUid int
    The anonymous UID used when root_squash_enabled is true.
    Filter string
    The filter applied to the scope for this rule. The filter's format depends on its scope: default scope matches all clients and has no filter value; network scope takes a CIDR format; host takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied.
    RootSquashEnabled bool
    Whether to enable root squash?
    SubmountAccessEnabled bool
    Whether allow access to subdirectories under the root export?
    SuidEnabled bool
    Whether SUID is allowed?
    access String
    The access level for this rule. Possible values are: rw, ro, no.
    scope String

    The scope of this rule. The scope and (potentially) the filter determine which clients match the rule. Possible values are: default, network, host.

    Note: Each access_rule should set a unique scope.

    anonymousGid Integer
    The anonymous GID used when root_squash_enabled is true.
    anonymousUid Integer
    The anonymous UID used when root_squash_enabled is true.
    filter String
    The filter applied to the scope for this rule. The filter's format depends on its scope: default scope matches all clients and has no filter value; network scope takes a CIDR format; host takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied.
    rootSquashEnabled Boolean
    Whether to enable root squash?
    submountAccessEnabled Boolean
    Whether allow access to subdirectories under the root export?
    suidEnabled Boolean
    Whether SUID is allowed?
    access string
    The access level for this rule. Possible values are: rw, ro, no.
    scope string

    The scope of this rule. The scope and (potentially) the filter determine which clients match the rule. Possible values are: default, network, host.

    Note: Each access_rule should set a unique scope.

    anonymousGid number
    The anonymous GID used when root_squash_enabled is true.
    anonymousUid number
    The anonymous UID used when root_squash_enabled is true.
    filter string
    The filter applied to the scope for this rule. The filter's format depends on its scope: default scope matches all clients and has no filter value; network scope takes a CIDR format; host takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied.
    rootSquashEnabled boolean
    Whether to enable root squash?
    submountAccessEnabled boolean
    Whether allow access to subdirectories under the root export?
    suidEnabled boolean
    Whether SUID is allowed?
    access str
    The access level for this rule. Possible values are: rw, ro, no.
    scope str

    The scope of this rule. The scope and (potentially) the filter determine which clients match the rule. Possible values are: default, network, host.

    Note: Each access_rule should set a unique scope.

    anonymous_gid int
    The anonymous GID used when root_squash_enabled is true.
    anonymous_uid int
    The anonymous UID used when root_squash_enabled is true.
    filter str
    The filter applied to the scope for this rule. The filter's format depends on its scope: default scope matches all clients and has no filter value; network scope takes a CIDR format; host takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied.
    root_squash_enabled bool
    Whether to enable root squash?
    submount_access_enabled bool
    Whether allow access to subdirectories under the root export?
    suid_enabled bool
    Whether SUID is allowed?
    access String
    The access level for this rule. Possible values are: rw, ro, no.
    scope String

    The scope of this rule. The scope and (potentially) the filter determine which clients match the rule. Possible values are: default, network, host.

    Note: Each access_rule should set a unique scope.

    anonymousGid Number
    The anonymous GID used when root_squash_enabled is true.
    anonymousUid Number
    The anonymous UID used when root_squash_enabled is true.
    filter String
    The filter applied to the scope for this rule. The filter's format depends on its scope: default scope matches all clients and has no filter value; network scope takes a CIDR format; host takes an IP address or fully qualified domain name. If a client does not match any filter rule and there is no default rule, access is denied.
    rootSquashEnabled Boolean
    Whether to enable root squash?
    submountAccessEnabled Boolean
    Whether allow access to subdirectories under the root export?
    suidEnabled Boolean
    Whether SUID is allowed?

    CacheDirectoryActiveDirectory, CacheDirectoryActiveDirectoryArgs

    CacheNetbiosName string
    The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
    DnsPrimaryIp string
    The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    DomainName string
    The fully qualified domain name of the Active Directory domain controller.
    DomainNetbiosName string
    The Active Directory domain's NetBIOS name.
    Password string
    The password of the Active Directory domain administrator.
    Username string
    The username of the Active Directory domain administrator.
    DnsSecondaryIp string
    The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    CacheNetbiosName string
    The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
    DnsPrimaryIp string
    The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    DomainName string
    The fully qualified domain name of the Active Directory domain controller.
    DomainNetbiosName string
    The Active Directory domain's NetBIOS name.
    Password string
    The password of the Active Directory domain administrator.
    Username string
    The username of the Active Directory domain administrator.
    DnsSecondaryIp string
    The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    cacheNetbiosName String
    The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
    dnsPrimaryIp String
    The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    domainName String
    The fully qualified domain name of the Active Directory domain controller.
    domainNetbiosName String
    The Active Directory domain's NetBIOS name.
    password String
    The password of the Active Directory domain administrator.
    username String
    The username of the Active Directory domain administrator.
    dnsSecondaryIp String
    The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    cacheNetbiosName string
    The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
    dnsPrimaryIp string
    The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    domainName string
    The fully qualified domain name of the Active Directory domain controller.
    domainNetbiosName string
    The Active Directory domain's NetBIOS name.
    password string
    The password of the Active Directory domain administrator.
    username string
    The username of the Active Directory domain administrator.
    dnsSecondaryIp string
    The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    cache_netbios_name str
    The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
    dns_primary_ip str
    The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    domain_name str
    The fully qualified domain name of the Active Directory domain controller.
    domain_netbios_name str
    The Active Directory domain's NetBIOS name.
    password str
    The password of the Active Directory domain administrator.
    username str
    The username of the Active Directory domain administrator.
    dns_secondary_ip str
    The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    cacheNetbiosName String
    The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
    dnsPrimaryIp String
    The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
    domainName String
    The fully qualified domain name of the Active Directory domain controller.
    domainNetbiosName String
    The Active Directory domain's NetBIOS name.
    password String
    The password of the Active Directory domain administrator.
    username String
    The username of the Active Directory domain administrator.
    dnsSecondaryIp String
    The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.

    CacheDirectoryFlatFile, CacheDirectoryFlatFileArgs

    GroupFileUri string
    The URI of the file containing group information (/etc/group file format in Unix-like OS).
    PasswordFileUri string
    The URI of the file containing user information (/etc/passwd file format in Unix-like OS).
    GroupFileUri string
    The URI of the file containing group information (/etc/group file format in Unix-like OS).
    PasswordFileUri string
    The URI of the file containing user information (/etc/passwd file format in Unix-like OS).
    groupFileUri String
    The URI of the file containing group information (/etc/group file format in Unix-like OS).
    passwordFileUri String
    The URI of the file containing user information (/etc/passwd file format in Unix-like OS).
    groupFileUri string
    The URI of the file containing group information (/etc/group file format in Unix-like OS).
    passwordFileUri string
    The URI of the file containing user information (/etc/passwd file format in Unix-like OS).
    group_file_uri str
    The URI of the file containing group information (/etc/group file format in Unix-like OS).
    password_file_uri str
    The URI of the file containing user information (/etc/passwd file format in Unix-like OS).
    groupFileUri String
    The URI of the file containing group information (/etc/group file format in Unix-like OS).
    passwordFileUri String
    The URI of the file containing user information (/etc/passwd file format in Unix-like OS).

    CacheDirectoryLdap, CacheDirectoryLdapArgs

    BaseDn string
    The base distinguished name (DN) for the LDAP domain.
    Server string
    The FQDN or IP address of the LDAP server.
    Bind CacheDirectoryLdapBind
    A bind block as defined above.
    CertificateValidationUri string
    The URI of the CA certificate to validate the LDAP secure connection.
    DownloadCertificateAutomatically bool
    Whether the certificate should be automatically downloaded. This can be set to true only when certificate_validation_uri is provided.
    Encrypted bool
    Whether the LDAP connection should be encrypted?
    BaseDn string
    The base distinguished name (DN) for the LDAP domain.
    Server string
    The FQDN or IP address of the LDAP server.
    Bind CacheDirectoryLdapBind
    A bind block as defined above.
    CertificateValidationUri string
    The URI of the CA certificate to validate the LDAP secure connection.
    DownloadCertificateAutomatically bool
    Whether the certificate should be automatically downloaded. This can be set to true only when certificate_validation_uri is provided.
    Encrypted bool
    Whether the LDAP connection should be encrypted?
    baseDn String
    The base distinguished name (DN) for the LDAP domain.
    server String
    The FQDN or IP address of the LDAP server.
    bind CacheDirectoryLdapBind
    A bind block as defined above.
    certificateValidationUri String
    The URI of the CA certificate to validate the LDAP secure connection.
    downloadCertificateAutomatically Boolean
    Whether the certificate should be automatically downloaded. This can be set to true only when certificate_validation_uri is provided.
    encrypted Boolean
    Whether the LDAP connection should be encrypted?
    baseDn string
    The base distinguished name (DN) for the LDAP domain.
    server string
    The FQDN or IP address of the LDAP server.
    bind CacheDirectoryLdapBind
    A bind block as defined above.
    certificateValidationUri string
    The URI of the CA certificate to validate the LDAP secure connection.
    downloadCertificateAutomatically boolean
    Whether the certificate should be automatically downloaded. This can be set to true only when certificate_validation_uri is provided.
    encrypted boolean
    Whether the LDAP connection should be encrypted?
    base_dn str
    The base distinguished name (DN) for the LDAP domain.
    server str
    The FQDN or IP address of the LDAP server.
    bind CacheDirectoryLdapBind
    A bind block as defined above.
    certificate_validation_uri str
    The URI of the CA certificate to validate the LDAP secure connection.
    download_certificate_automatically bool
    Whether the certificate should be automatically downloaded. This can be set to true only when certificate_validation_uri is provided.
    encrypted bool
    Whether the LDAP connection should be encrypted?
    baseDn String
    The base distinguished name (DN) for the LDAP domain.
    server String
    The FQDN or IP address of the LDAP server.
    bind Property Map
    A bind block as defined above.
    certificateValidationUri String
    The URI of the CA certificate to validate the LDAP secure connection.
    downloadCertificateAutomatically Boolean
    Whether the certificate should be automatically downloaded. This can be set to true only when certificate_validation_uri is provided.
    encrypted Boolean
    Whether the LDAP connection should be encrypted?

    CacheDirectoryLdapBind, CacheDirectoryLdapBindArgs

    Dn string
    The Bind Distinguished Name (DN) identity to be used in the secure LDAP connection.
    Password string
    The Bind password to be used in the secure LDAP connection.
    Dn string
    The Bind Distinguished Name (DN) identity to be used in the secure LDAP connection.
    Password string
    The Bind password to be used in the secure LDAP connection.
    dn String
    The Bind Distinguished Name (DN) identity to be used in the secure LDAP connection.
    password String
    The Bind password to be used in the secure LDAP connection.
    dn string
    The Bind Distinguished Name (DN) identity to be used in the secure LDAP connection.
    password string
    The Bind password to be used in the secure LDAP connection.
    dn str
    The Bind Distinguished Name (DN) identity to be used in the secure LDAP connection.
    password str
    The Bind password to be used in the secure LDAP connection.
    dn String
    The Bind Distinguished Name (DN) identity to be used in the secure LDAP connection.
    password String
    The Bind password to be used in the secure LDAP connection.

    CacheDns, CacheDnsArgs

    Servers List<string>
    A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
    SearchDomain string
    The DNS search domain for the HPC Cache.
    Servers []string
    A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
    SearchDomain string
    The DNS search domain for the HPC Cache.
    servers List<String>
    A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
    searchDomain String
    The DNS search domain for the HPC Cache.
    servers string[]
    A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
    searchDomain string
    The DNS search domain for the HPC Cache.
    servers Sequence[str]
    A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
    search_domain str
    The DNS search domain for the HPC Cache.
    servers List<String>
    A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
    searchDomain String
    The DNS search domain for the HPC Cache.

    CacheIdentity, CacheIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this HPC Cache. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this HPC Cache. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this HPC Cache. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this HPC Cache. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this HPC Cache. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this HPC Cache. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this HPC Cache. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this HPC Cache. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this HPC Cache. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this HPC Cache. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this HPC Cache. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both). Changing this forces a new resource to be created.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this HPC Cache. Changing this forces a new resource to be created.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    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

    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.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure