We recommend using Azure Native.
azure.hpc.Cache
Explore with Pulumi AI
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 runaz 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/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/hpc"
"github.com/pulumi/pulumi-azure/sdk/v5/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)
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=azure.hpc.CacheDirectoryLdapArgs(
base_dn="string",
server="string",
bind=azure.hpc.CacheDirectoryLdapBindArgs(
dn="string",
password="string",
),
certificate_validation_uri="string",
download_certificate_automatically=False,
encrypted=False,
),
dns=azure.hpc.CacheDnsArgs(
servers=["string"],
search_domain="string",
),
identity=azure.hpc.CacheIdentityArgs(
type="string",
identity_ids=["string"],
principal_id="string",
tenant_id="string",
),
automatically_rotate_key_to_latest_enabled=False,
location="string",
mtu=0,
name="string",
ntp_server="string",
directory_flat_file=azure.hpc.CacheDirectoryFlatFileArgs(
group_file_uri="string",
password_file_uri="string",
),
directory_active_directory=azure.hpc.CacheDirectoryActiveDirectoryArgs(
cache_netbios_name="string",
dns_primary_ip="string",
domain_name="string",
domain_netbios_name="string",
password="string",
username="string",
dns_secondary_ip="string",
),
default_access_policy=azure.hpc.CacheDefaultAccessPolicyArgs(
access_rules=[azure.hpc.CacheDefaultAccessPolicyAccessRuleArgs(
access="string",
scope="string",
anonymous_gid=0,
anonymous_uid=0,
filter="string",
root_squash_enabled=False,
submount_access_enabled=False,
suid_enabled=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:
- Cache
Size intIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- Resource
Group stringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- Sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- Subnet
Id string - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- Automatically
Rotate boolKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- Default
Access CachePolicy Default Access Policy - A
default_access_policy
block as defined below. - Directory
Active CacheDirectory Directory Active Directory - A
directory_active_directory
block as defined below. - Directory
Flat CacheFile Directory Flat File - A
directory_flat_file
block as defined below. - Directory
Ldap CacheDirectory Ldap A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- Dns
Cache
Dns - A
dns
block as defined below. - Identity
Cache
Identity - An
identity
block as defined below. Changing this forces a new resource to be created. - Key
Vault stringKey Id - 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.
- Ntp
Server string - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - Dictionary<string, string>
- A mapping of tags to assign to the HPC Cache.
- Cache
Size intIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- Resource
Group stringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- Sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- Subnet
Id string - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- Automatically
Rotate boolKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- Default
Access CachePolicy Default Access Policy Args - A
default_access_policy
block as defined below. - Directory
Active CacheDirectory Directory Active Directory Args - A
directory_active_directory
block as defined below. - Directory
Flat CacheFile Directory Flat File Args - A
directory_flat_file
block as defined below. - Directory
Ldap CacheDirectory Ldap Args A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- Dns
Cache
Dns Args - A
dns
block as defined below. - Identity
Cache
Identity Args - An
identity
block as defined below. Changing this forces a new resource to be created. - Key
Vault stringKey Id - 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.
- Ntp
Server string - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - map[string]string
- A mapping of tags to assign to the HPC Cache.
- cache
Size IntegerIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- resource
Group StringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet
Id String - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- automatically
Rotate BooleanKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- default
Access CachePolicy Default Access Policy - A
default_access_policy
block as defined below. - directory
Active CacheDirectory Directory Active Directory - A
directory_active_directory
block as defined below. - directory
Flat CacheFile Directory Flat File - A
directory_flat_file
block as defined below. - directory
Ldap CacheDirectory Ldap A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- dns
Cache
Dns - A
dns
block as defined below. - identity
Cache
Identity - An
identity
block as defined below. Changing this forces a new resource to be created. - key
Vault StringKey Id - 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.
- ntp
Server String - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - Map<String,String>
- A mapping of tags to assign to the HPC Cache.
- cache
Size numberIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- resource
Group stringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet
Id string - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- automatically
Rotate booleanKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- default
Access CachePolicy Default Access Policy - A
default_access_policy
block as defined below. - directory
Active CacheDirectory Directory Active Directory - A
directory_active_directory
block as defined below. - directory
Flat CacheFile Directory Flat File - A
directory_flat_file
block as defined below. - directory
Ldap CacheDirectory Ldap A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- dns
Cache
Dns - A
dns
block as defined below. - identity
Cache
Identity - An
identity
block as defined below. Changing this forces a new resource to be created. - key
Vault stringKey Id - 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.
- ntp
Server string - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - {[key: string]: string}
- A mapping of tags to assign to the HPC Cache.
- cache_
size_ intin_ gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- resource_
group_ strname - 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet_
id str - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- automatically_
rotate_ boolkey_ to_ latest_ enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- default_
access_ Cachepolicy Default Access Policy Args - A
default_access_policy
block as defined below. - directory_
active_ Cachedirectory Directory Active Directory Args - A
directory_active_directory
block as defined below. - directory_
flat_ Cachefile Directory Flat File Args - A
directory_flat_file
block as defined below. - directory_
ldap CacheDirectory Ldap Args A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- dns
Cache
Dns Args - A
dns
block as defined below. - identity
Cache
Identity Args - An
identity
block as defined below. Changing this forces a new resource to be created. - key_
vault_ strkey_ id - 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
. - Mapping[str, str]
- A mapping of tags to assign to the HPC Cache.
- cache
Size NumberIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- resource
Group StringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet
Id String - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- automatically
Rotate BooleanKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- default
Access Property MapPolicy - A
default_access_policy
block as defined below. - directory
Active Property MapDirectory - A
directory_active_directory
block as defined below. - directory
Flat Property MapFile - A
directory_flat_file
block as defined below. - directory
Ldap Property Map A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_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. - key
Vault StringKey Id - 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.
- ntp
Server String - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - 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.
- Mount
Addresses 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.
- Mount
Addresses []string - A list of IP Addresses where the HPC Cache can be mounted.
- id String
- The provider-assigned unique ID for this managed resource.
- mount
Addresses 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.
- mount
Addresses 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.
- mount
Addresses 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.
- Automatically
Rotate boolKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- Cache
Size intIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- Default
Access CachePolicy Default Access Policy - A
default_access_policy
block as defined below. - Directory
Active CacheDirectory Directory Active Directory - A
directory_active_directory
block as defined below. - Directory
Flat CacheFile Directory Flat File - A
directory_flat_file
block as defined below. - Directory
Ldap CacheDirectory Ldap A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- Dns
Cache
Dns - A
dns
block as defined below. - Identity
Cache
Identity - An
identity
block as defined below. Changing this forces a new resource to be created. - Key
Vault stringKey Id - 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.
- Mount
Addresses 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.
- Ntp
Server string - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - Resource
Group stringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- Sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- Subnet
Id string - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the HPC Cache.
- Automatically
Rotate boolKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- Cache
Size intIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- Default
Access CachePolicy Default Access Policy Args - A
default_access_policy
block as defined below. - Directory
Active CacheDirectory Directory Active Directory Args - A
directory_active_directory
block as defined below. - Directory
Flat CacheFile Directory Flat File Args - A
directory_flat_file
block as defined below. - Directory
Ldap CacheDirectory Ldap Args A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- Dns
Cache
Dns Args - A
dns
block as defined below. - Identity
Cache
Identity Args - An
identity
block as defined below. Changing this forces a new resource to be created. - Key
Vault stringKey Id - 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.
- Mount
Addresses []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.
- Ntp
Server string - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - Resource
Group stringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- Sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- Subnet
Id string - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the HPC Cache.
- automatically
Rotate BooleanKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- cache
Size IntegerIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- default
Access CachePolicy Default Access Policy - A
default_access_policy
block as defined below. - directory
Active CacheDirectory Directory Active Directory - A
directory_active_directory
block as defined below. - directory
Flat CacheFile Directory Flat File - A
directory_flat_file
block as defined below. - directory
Ldap CacheDirectory Ldap A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- dns
Cache
Dns - A
dns
block as defined below. - identity
Cache
Identity - An
identity
block as defined below. Changing this forces a new resource to be created. - key
Vault StringKey Id - 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.
- mount
Addresses 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.
- ntp
Server String - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - resource
Group StringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet
Id String - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the HPC Cache.
- automatically
Rotate booleanKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- cache
Size numberIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- default
Access CachePolicy Default Access Policy - A
default_access_policy
block as defined below. - directory
Active CacheDirectory Directory Active Directory - A
directory_active_directory
block as defined below. - directory
Flat CacheFile Directory Flat File - A
directory_flat_file
block as defined below. - directory
Ldap CacheDirectory Ldap A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- dns
Cache
Dns - A
dns
block as defined below. - identity
Cache
Identity - An
identity
block as defined below. Changing this forces a new resource to be created. - key
Vault stringKey Id - 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.
- mount
Addresses 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.
- ntp
Server string - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - resource
Group stringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet
Id string - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the HPC Cache.
- automatically_
rotate_ boolkey_ to_ latest_ enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- cache_
size_ intin_ gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- default_
access_ Cachepolicy Default Access Policy Args - A
default_access_policy
block as defined below. - directory_
active_ Cachedirectory Directory Active Directory Args - A
directory_active_directory
block as defined below. - directory_
flat_ Cachefile Directory Flat File Args - A
directory_flat_file
block as defined below. - directory_
ldap CacheDirectory Ldap Args A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_ldap
can be set.- dns
Cache
Dns Args - A
dns
block as defined below. - identity
Cache
Identity Args - An
identity
block as defined below. Changing this forces a new resource to be created. - key_
vault_ strkey_ id - 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_ strname - 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet_
id str - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the HPC Cache.
- automatically
Rotate BooleanKey To Latest Enabled - Specifies whether the HPC Cache automatically rotates Encryption Key to the latest version.
- cache
Size NumberIn Gb The size of the HPC Cache, in GB. Possible values are
3072
,6144
,12288
,21623
,24576
,43246
,49152
and86491
. Changing this forces a new resource to be created.NOTE: The
21623
,43246
and86491
sizes are restricted to read only resources.- default
Access Property MapPolicy - A
default_access_policy
block as defined below. - directory
Active Property MapDirectory - A
directory_active_directory
block as defined below. - directory
Flat Property MapFile - A
directory_flat_file
block as defined below. - directory
Ldap Property Map A
directory_ldap
block as defined below.Note: Only one of
directory_active_directory
,directory_flat_file
anddirectory_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. - key
Vault StringKey Id - 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.
- mount
Addresses 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.
- ntp
Server String - The NTP server IP Address or FQDN for the HPC Cache. Defaults to
time.windows.com
. - resource
Group StringName - The name of the Resource Group in which to create the HPC Cache. Changing this forces a new resource to be created.
- sku
Name 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
, andStandard_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 to21623
.Standard_L9G
to43246
andStandard_L16G
to86491
.- subnet
Id String - The ID of the Subnet for the HPC Cache. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags to assign to the HPC Cache.
Supporting Types
CacheDefaultAccessPolicy, CacheDefaultAccessPolicyArgs
- Access
Rules List<CacheDefault Access Policy Access Rule> - One or more
access_rule
blocks (up to three) as defined above.
- Access
Rules []CacheDefault Access Policy Access Rule - One or more
access_rule
blocks (up to three) as defined above.
- access
Rules List<CacheDefault Access Policy Access Rule> - One or more
access_rule
blocks (up to three) as defined above.
- access
Rules CacheDefault Access Policy Access Rule[] - One or more
access_rule
blocks (up to three) as defined above.
- access_
rules Sequence[CacheDefault Access Policy Access Rule] - One or more
access_rule
blocks (up to three) as defined above.
- access
Rules 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) thefilter
determine which clients match the rule. Possible values are:default
,network
,host
.Note: Each
access_rule
should set a uniquescope
.- Anonymous
Gid int - The anonymous GID used when
root_squash_enabled
istrue
. - Anonymous
Uid int - The anonymous UID used when
root_squash_enabled
istrue
. - 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. - Root
Squash boolEnabled - Whether to enable root squash?
- Submount
Access boolEnabled - 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) thefilter
determine which clients match the rule. Possible values are:default
,network
,host
.Note: Each
access_rule
should set a uniquescope
.- Anonymous
Gid int - The anonymous GID used when
root_squash_enabled
istrue
. - Anonymous
Uid int - The anonymous UID used when
root_squash_enabled
istrue
. - 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. - Root
Squash boolEnabled - Whether to enable root squash?
- Submount
Access boolEnabled - 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) thefilter
determine which clients match the rule. Possible values are:default
,network
,host
.Note: Each
access_rule
should set a uniquescope
.- anonymous
Gid Integer - The anonymous GID used when
root_squash_enabled
istrue
. - anonymous
Uid Integer - The anonymous UID used when
root_squash_enabled
istrue
. - 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. - root
Squash BooleanEnabled - Whether to enable root squash?
- submount
Access BooleanEnabled - Whether allow access to subdirectories under the root export?
- suid
Enabled 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) thefilter
determine which clients match the rule. Possible values are:default
,network
,host
.Note: Each
access_rule
should set a uniquescope
.- anonymous
Gid number - The anonymous GID used when
root_squash_enabled
istrue
. - anonymous
Uid number - The anonymous UID used when
root_squash_enabled
istrue
. - 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. - root
Squash booleanEnabled - Whether to enable root squash?
- submount
Access booleanEnabled - Whether allow access to subdirectories under the root export?
- suid
Enabled 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) thefilter
determine which clients match the rule. Possible values are:default
,network
,host
.Note: Each
access_rule
should set a uniquescope
.- anonymous_
gid int - The anonymous GID used when
root_squash_enabled
istrue
. - anonymous_
uid int - The anonymous UID used when
root_squash_enabled
istrue
. - 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_ boolenabled - Whether to enable root squash?
- submount_
access_ boolenabled - 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) thefilter
determine which clients match the rule. Possible values are:default
,network
,host
.Note: Each
access_rule
should set a uniquescope
.- anonymous
Gid Number - The anonymous GID used when
root_squash_enabled
istrue
. - anonymous
Uid Number - The anonymous UID used when
root_squash_enabled
istrue
. - 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. - root
Squash BooleanEnabled - Whether to enable root squash?
- submount
Access BooleanEnabled - Whether allow access to subdirectories under the root export?
- suid
Enabled Boolean - Whether SUID is allowed?
CacheDirectoryActiveDirectory, CacheDirectoryActiveDirectoryArgs
- Cache
Netbios stringName - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
- Dns
Primary stringIp - The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- Domain
Name string - The fully qualified domain name of the Active Directory domain controller.
- Domain
Netbios stringName - 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.
- Dns
Secondary stringIp - The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- Cache
Netbios stringName - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
- Dns
Primary stringIp - The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- Domain
Name string - The fully qualified domain name of the Active Directory domain controller.
- Domain
Netbios stringName - 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.
- Dns
Secondary stringIp - The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- cache
Netbios StringName - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
- dns
Primary StringIp - The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- domain
Name String - The fully qualified domain name of the Active Directory domain controller.
- domain
Netbios StringName - 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.
- dns
Secondary StringIp - The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- cache
Netbios stringName - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
- dns
Primary stringIp - The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- domain
Name string - The fully qualified domain name of the Active Directory domain controller.
- domain
Netbios stringName - 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.
- dns
Secondary stringIp - The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- cache_
netbios_ strname - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
- dns_
primary_ strip - 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_ strname - 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_ strip - The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- cache
Netbios StringName - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server.
- dns
Primary StringIp - The primary DNS IP address used to resolve the Active Directory domain controller's FQDN.
- domain
Name String - The fully qualified domain name of the Active Directory domain controller.
- domain
Netbios StringName - 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.
- dns
Secondary StringIp - The secondary DNS IP address used to resolve the Active Directory domain controller's FQDN.
CacheDirectoryFlatFile, CacheDirectoryFlatFileArgs
- Group
File stringUri - The URI of the file containing group information (
/etc/group
file format in Unix-like OS). - Password
File stringUri - The URI of the file containing user information (
/etc/passwd
file format in Unix-like OS).
- Group
File stringUri - The URI of the file containing group information (
/etc/group
file format in Unix-like OS). - Password
File stringUri - The URI of the file containing user information (
/etc/passwd
file format in Unix-like OS).
- group
File StringUri - The URI of the file containing group information (
/etc/group
file format in Unix-like OS). - password
File StringUri - The URI of the file containing user information (
/etc/passwd
file format in Unix-like OS).
- group
File stringUri - The URI of the file containing group information (
/etc/group
file format in Unix-like OS). - password
File stringUri - The URI of the file containing user information (
/etc/passwd
file format in Unix-like OS).
- group_
file_ struri - The URI of the file containing group information (
/etc/group
file format in Unix-like OS). - password_
file_ struri - The URI of the file containing user information (
/etc/passwd
file format in Unix-like OS).
- group
File StringUri - The URI of the file containing group information (
/etc/group
file format in Unix-like OS). - password
File StringUri - The URI of the file containing user information (
/etc/passwd
file format in Unix-like OS).
CacheDirectoryLdap, CacheDirectoryLdapArgs
- Base
Dn string - The base distinguished name (DN) for the LDAP domain.
- Server string
- The FQDN or IP address of the LDAP server.
- Bind
Cache
Directory Ldap Bind - A
bind
block as defined above. - Certificate
Validation stringUri - The URI of the CA certificate to validate the LDAP secure connection.
- Download
Certificate boolAutomatically - Whether the certificate should be automatically downloaded. This can be set to
true
only whencertificate_validation_uri
is provided. - Encrypted bool
- Whether the LDAP connection should be encrypted?
- Base
Dn string - The base distinguished name (DN) for the LDAP domain.
- Server string
- The FQDN or IP address of the LDAP server.
- Bind
Cache
Directory Ldap Bind - A
bind
block as defined above. - Certificate
Validation stringUri - The URI of the CA certificate to validate the LDAP secure connection.
- Download
Certificate boolAutomatically - Whether the certificate should be automatically downloaded. This can be set to
true
only whencertificate_validation_uri
is provided. - Encrypted bool
- Whether the LDAP connection should be encrypted?
- base
Dn String - The base distinguished name (DN) for the LDAP domain.
- server String
- The FQDN or IP address of the LDAP server.
- bind
Cache
Directory Ldap Bind - A
bind
block as defined above. - certificate
Validation StringUri - The URI of the CA certificate to validate the LDAP secure connection.
- download
Certificate BooleanAutomatically - Whether the certificate should be automatically downloaded. This can be set to
true
only whencertificate_validation_uri
is provided. - encrypted Boolean
- Whether the LDAP connection should be encrypted?
- base
Dn string - The base distinguished name (DN) for the LDAP domain.
- server string
- The FQDN or IP address of the LDAP server.
- bind
Cache
Directory Ldap Bind - A
bind
block as defined above. - certificate
Validation stringUri - The URI of the CA certificate to validate the LDAP secure connection.
- download
Certificate booleanAutomatically - Whether the certificate should be automatically downloaded. This can be set to
true
only whencertificate_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
Cache
Directory Ldap Bind - A
bind
block as defined above. - certificate_
validation_ struri - The URI of the CA certificate to validate the LDAP secure connection.
- download_
certificate_ boolautomatically - Whether the certificate should be automatically downloaded. This can be set to
true
only whencertificate_validation_uri
is provided. - encrypted bool
- Whether the LDAP connection should be encrypted?
- base
Dn 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. - certificate
Validation StringUri - The URI of the CA certificate to validate the LDAP secure connection.
- download
Certificate BooleanAutomatically - Whether the certificate should be automatically downloaded. This can be set to
true
only whencertificate_validation_uri
is provided. - encrypted Boolean
- Whether the LDAP connection should be encrypted?
CacheDirectoryLdapBind, CacheDirectoryLdapBindArgs
CacheDns, CacheDnsArgs
- Servers List<string>
- A list of DNS servers for the HPC Cache. At most three IP(s) are allowed to set.
- Search
Domain 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.
- Search
Domain 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.
- search
Domain 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.
- search
Domain 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.
- search
Domain 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. - Identity
Ids 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 toUserAssigned
orSystemAssigned, UserAssigned
.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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. - Identity
Ids []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 toUserAssigned
orSystemAssigned, UserAssigned
.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id 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. - identity
Ids 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 toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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. - identity
Ids 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 toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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 toUserAssigned
orSystemAssigned, 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. - identity
Ids 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 toUserAssigned
orSystemAssigned, UserAssigned
.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id 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.