Azure Native v1 v1.104.0, Jul 6 23

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.storagecache.getCache

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

pulumi/pulumi-azure-native

Using getCache

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCache(args: GetCacheArgs, opts?: InvokeOptions): Promise<GetCacheResult>
function getCacheOutput(args: GetCacheOutputArgs, opts?: InvokeOptions): Output<GetCacheResult>

def get_cache(cache_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetCacheResult
def get_cache_output(cache_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetCacheResult]

func LookupCache(ctx *Context, args *LookupCacheArgs, opts ...InvokeOption) (*LookupCacheResult, error)
func LookupCacheOutput(ctx *Context, args *LookupCacheOutputArgs, opts ...InvokeOption) LookupCacheResultOutput

> Note: This function is named LookupCache in the Go SDK.

public static class GetCache 
{
    public static Task<GetCacheResult> InvokeAsync(GetCacheArgs args, InvokeOptions? opts = null)
    public static Output<GetCacheResult> Invoke(GetCacheInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCacheResult> getCache(GetCacheArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:storagecache:getCache
  arguments:
    # arguments dictionary

The following arguments are supported:

CacheName string: Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
ResourceGroupName string: Target resource group.

CacheName string: Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
ResourceGroupName string: Target resource group.

cacheName String: Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
resourceGroupName String: Target resource group.

cacheName string: Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
resourceGroupName string: Target resource group.

cache_name str: Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
resource_group_name str: Target resource group.

cacheName String: Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
resourceGroupName String: Target resource group.

getCache Result

The following output properties are available:

Health Pulumi.AzureNative.StorageCache.Outputs.CacheHealthResponse: Health of the Cache.
Id string: Resource ID of the Cache.
MountAddresses List<string>: Array of IP addresses that can be used by clients mounting this Cache.
Name string: Name of Cache.
SystemData Pulumi.AzureNative.StorageCache.Outputs.SystemDataResponse: The system meta data relating to this resource.
Type string: Type of the Cache; Microsoft.StorageCache/Cache
CacheSizeGB int: The size of this Cache, in GB.
DirectoryServicesSettings Pulumi.AzureNative.StorageCache.Outputs.CacheDirectorySettingsResponse: Specifies Directory Services settings of the cache.
EncryptionSettings Pulumi.AzureNative.StorageCache.Outputs.CacheEncryptionSettingsResponse: Specifies encryption settings of the cache.
Identity Pulumi.AzureNative.StorageCache.Outputs.CacheIdentityResponse: The identity of the cache, if configured.
Location string: Region name string.
NetworkSettings Pulumi.AzureNative.StorageCache.Outputs.CacheNetworkSettingsResponse: Specifies network settings of the cache.
ProvisioningState string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
SecuritySettings Pulumi.AzureNative.StorageCache.Outputs.CacheSecuritySettingsResponse: Specifies security settings of the cache.
Sku Pulumi.AzureNative.StorageCache.Outputs.CacheResponseSku: SKU for the Cache.
Subnet string: Subnet used for the Cache.
Tags Dictionary<string, string>: Resource tags.
UpgradeStatus Pulumi.AzureNative.StorageCache.Outputs.CacheUpgradeStatusResponse: Upgrade status of the Cache.

Health CacheHealthResponse: Health of the Cache.
Id string: Resource ID of the Cache.
MountAddresses []string: Array of IP addresses that can be used by clients mounting this Cache.
Name string: Name of Cache.
SystemData SystemDataResponse: The system meta data relating to this resource.
Type string: Type of the Cache; Microsoft.StorageCache/Cache
CacheSizeGB int: The size of this Cache, in GB.
DirectoryServicesSettings CacheDirectorySettingsResponse: Specifies Directory Services settings of the cache.
EncryptionSettings CacheEncryptionSettingsResponse: Specifies encryption settings of the cache.
Identity CacheIdentityResponse: The identity of the cache, if configured.
Location string: Region name string.
NetworkSettings CacheNetworkSettingsResponse: Specifies network settings of the cache.
ProvisioningState string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
SecuritySettings CacheSecuritySettingsResponse: Specifies security settings of the cache.
Sku CacheResponseSku: SKU for the Cache.
Subnet string: Subnet used for the Cache.
Tags map[string]string: Resource tags.
UpgradeStatus CacheUpgradeStatusResponse: Upgrade status of the Cache.

health CacheHealthResponse: Health of the Cache.
id String: Resource ID of the Cache.
mountAddresses List<String>: Array of IP addresses that can be used by clients mounting this Cache.
name String: Name of Cache.
systemData SystemDataResponse: The system meta data relating to this resource.
type String: Type of the Cache; Microsoft.StorageCache/Cache
cacheSizeGB Integer: The size of this Cache, in GB.
directoryServicesSettings CacheDirectorySettingsResponse: Specifies Directory Services settings of the cache.
encryptionSettings CacheEncryptionSettingsResponse: Specifies encryption settings of the cache.
identity CacheIdentityResponse: The identity of the cache, if configured.
location String: Region name string.
networkSettings CacheNetworkSettingsResponse: Specifies network settings of the cache.
provisioningState String: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
securitySettings CacheSecuritySettingsResponse: Specifies security settings of the cache.
sku CacheResponseSku: SKU for the Cache.
subnet String: Subnet used for the Cache.
tags Map<String,String>: Resource tags.
upgradeStatus CacheUpgradeStatusResponse: Upgrade status of the Cache.

health CacheHealthResponse: Health of the Cache.
id string: Resource ID of the Cache.
mountAddresses string[]: Array of IP addresses that can be used by clients mounting this Cache.
name string: Name of Cache.
systemData SystemDataResponse: The system meta data relating to this resource.
type string: Type of the Cache; Microsoft.StorageCache/Cache
cacheSizeGB number: The size of this Cache, in GB.
directoryServicesSettings CacheDirectorySettingsResponse: Specifies Directory Services settings of the cache.
encryptionSettings CacheEncryptionSettingsResponse: Specifies encryption settings of the cache.
identity CacheIdentityResponse: The identity of the cache, if configured.
location string: Region name string.
networkSettings CacheNetworkSettingsResponse: Specifies network settings of the cache.
provisioningState string: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
securitySettings CacheSecuritySettingsResponse: Specifies security settings of the cache.
sku CacheResponseSku: SKU for the Cache.
subnet string: Subnet used for the Cache.
tags {[key: string]: string}: Resource tags.
upgradeStatus CacheUpgradeStatusResponse: Upgrade status of the Cache.

health CacheHealthResponse: Health of the Cache.
id str: Resource ID of the Cache.
mount_addresses Sequence[str]: Array of IP addresses that can be used by clients mounting this Cache.
name str: Name of Cache.
system_data SystemDataResponse: The system meta data relating to this resource.
type str: Type of the Cache; Microsoft.StorageCache/Cache
cache_size_gb int: The size of this Cache, in GB.
directory_services_settings CacheDirectorySettingsResponse: Specifies Directory Services settings of the cache.
encryption_settings CacheEncryptionSettingsResponse: Specifies encryption settings of the cache.
identity CacheIdentityResponse: The identity of the cache, if configured.
location str: Region name string.
network_settings CacheNetworkSettingsResponse: Specifies network settings of the cache.
provisioning_state str: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
security_settings CacheSecuritySettingsResponse: Specifies security settings of the cache.
sku CacheResponseSku: SKU for the Cache.
subnet str: Subnet used for the Cache.
tags Mapping[str, str]: Resource tags.
upgrade_status CacheUpgradeStatusResponse: Upgrade status of the Cache.

health Property Map: Health of the Cache.
id String: Resource ID of the Cache.
mountAddresses List<String>: Array of IP addresses that can be used by clients mounting this Cache.
name String: Name of Cache.
systemData Property Map: The system meta data relating to this resource.
type String: Type of the Cache; Microsoft.StorageCache/Cache
cacheSizeGB Number: The size of this Cache, in GB.
directoryServicesSettings Property Map: Specifies Directory Services settings of the cache.
encryptionSettings Property Map: Specifies encryption settings of the cache.
identity Property Map: The identity of the cache, if configured.
location String: Region name string.
networkSettings Property Map: Specifies network settings of the cache.
provisioningState String: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
securitySettings Property Map: Specifies security settings of the cache.
sku Property Map: SKU for the Cache.
subnet String: Subnet used for the Cache.
tags Map<String>: Resource tags.
upgradeStatus Property Map: Upgrade status of the Cache.

Supporting Types

CacheActiveDirectorySettingsResponse

CacheNetBiosName string: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
DomainJoined string: True if the HPC Cache is joined to the Active Directory domain.
DomainName string: The fully qualified domain name of the Active Directory domain controller.
DomainNetBiosName string: The Active Directory domain's NetBIOS name.
PrimaryDnsIpAddress string: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
Credentials Pulumi.AzureNative.StorageCache.Inputs.CacheActiveDirectorySettingsResponseCredentials: Active Directory admin credentials used to join the HPC Cache to a domain.
SecondaryDnsIpAddress string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

CacheNetBiosName string: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
DomainJoined string: True if the HPC Cache is joined to the Active Directory domain.
DomainName string: The fully qualified domain name of the Active Directory domain controller.
DomainNetBiosName string: The Active Directory domain's NetBIOS name.
PrimaryDnsIpAddress string: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
Credentials CacheActiveDirectorySettingsResponseCredentials: Active Directory admin credentials used to join the HPC Cache to a domain.
SecondaryDnsIpAddress string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

cacheNetBiosName String: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
domainJoined String: True if the HPC Cache is joined to the Active Directory domain.
domainName String: The fully qualified domain name of the Active Directory domain controller.
domainNetBiosName String: The Active Directory domain's NetBIOS name.
primaryDnsIpAddress String: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
credentials CacheActiveDirectorySettingsResponseCredentials: Active Directory admin credentials used to join the HPC Cache to a domain.
secondaryDnsIpAddress String: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

cacheNetBiosName string: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
domainJoined string: True if the HPC Cache is joined to the Active Directory domain.
domainName string: The fully qualified domain name of the Active Directory domain controller.
domainNetBiosName string: The Active Directory domain's NetBIOS name.
primaryDnsIpAddress string: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
credentials CacheActiveDirectorySettingsResponseCredentials: Active Directory admin credentials used to join the HPC Cache to a domain.
secondaryDnsIpAddress string: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

cache_net_bios_name str: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
domain_joined str: True if the HPC Cache is joined to the Active Directory domain.
domain_name str: The fully qualified domain name of the Active Directory domain controller.
domain_net_bios_name str: The Active Directory domain's NetBIOS name.
primary_dns_ip_address str: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
credentials CacheActiveDirectorySettingsResponseCredentials: Active Directory admin credentials used to join the HPC Cache to a domain.
secondary_dns_ip_address str: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

cacheNetBiosName String: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
domainJoined String: True if the HPC Cache is joined to the Active Directory domain.
domainName String: The fully qualified domain name of the Active Directory domain controller.
domainNetBiosName String: The Active Directory domain's NetBIOS name.
primaryDnsIpAddress String: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
credentials Property Map: Active Directory admin credentials used to join the HPC Cache to a domain.
secondaryDnsIpAddress String: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.

CacheActiveDirectorySettingsResponseCredentials

Password string: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
Username string: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

Password string: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
Username string: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

password String: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
username String: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

password string: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
username string: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

password str: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
username str: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

password String: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
username String: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.

CacheDirectorySettingsResponse

ActiveDirectory Pulumi.AzureNative.StorageCache.Inputs.CacheActiveDirectorySettingsResponse: Specifies settings for joining the HPC Cache to an Active Directory domain.
UsernameDownload Pulumi.AzureNative.StorageCache.Inputs.CacheUsernameDownloadSettingsResponse: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.

ActiveDirectory CacheActiveDirectorySettingsResponse: Specifies settings for joining the HPC Cache to an Active Directory domain.
UsernameDownload CacheUsernameDownloadSettingsResponse: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.

activeDirectory CacheActiveDirectorySettingsResponse: Specifies settings for joining the HPC Cache to an Active Directory domain.
usernameDownload CacheUsernameDownloadSettingsResponse: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.

activeDirectory CacheActiveDirectorySettingsResponse: Specifies settings for joining the HPC Cache to an Active Directory domain.
usernameDownload CacheUsernameDownloadSettingsResponse: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.

active_directory CacheActiveDirectorySettingsResponse: Specifies settings for joining the HPC Cache to an Active Directory domain.
username_download CacheUsernameDownloadSettingsResponse: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.

activeDirectory Property Map: Specifies settings for joining the HPC Cache to an Active Directory domain.
usernameDownload Property Map: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.

CacheEncryptionSettingsResponse

KeyEncryptionKey Pulumi.AzureNative.StorageCache.Inputs.KeyVaultKeyReferenceResponse: Specifies the location of the key encryption key in Key Vault.

KeyEncryptionKey KeyVaultKeyReferenceResponse: Specifies the location of the key encryption key in Key Vault.

keyEncryptionKey KeyVaultKeyReferenceResponse: Specifies the location of the key encryption key in Key Vault.

keyEncryptionKey KeyVaultKeyReferenceResponse: Specifies the location of the key encryption key in Key Vault.

key_encryption_key KeyVaultKeyReferenceResponse: Specifies the location of the key encryption key in Key Vault.

keyEncryptionKey Property Map: Specifies the location of the key encryption key in Key Vault.

CacheHealthResponse

Conditions List<Pulumi.AzureNative.StorageCache.Inputs.ConditionResponse>: Outstanding conditions that need to be investigated and resolved.
State string: List of Cache health states.
StatusDescription string: Describes explanation of state.

Conditions []ConditionResponse: Outstanding conditions that need to be investigated and resolved.
State string: List of Cache health states.
StatusDescription string: Describes explanation of state.

conditions List<ConditionResponse>: Outstanding conditions that need to be investigated and resolved.
state String: List of Cache health states.
statusDescription String: Describes explanation of state.

conditions ConditionResponse[]: Outstanding conditions that need to be investigated and resolved.
state string: List of Cache health states.
statusDescription string: Describes explanation of state.

conditions Sequence[ConditionResponse]: Outstanding conditions that need to be investigated and resolved.
state str: List of Cache health states.
status_description str: Describes explanation of state.

conditions List<Property Map>: Outstanding conditions that need to be investigated and resolved.
state String: List of Cache health states.
statusDescription String: Describes explanation of state.

CacheIdentityResponse

PrincipalId string: The principal id of the cache.
TenantId string: The tenant id associated with the cache.
Type string: The type of identity used for the cache

PrincipalId string: The principal id of the cache.
TenantId string: The tenant id associated with the cache.
Type string: The type of identity used for the cache

principalId String: The principal id of the cache.
tenantId String: The tenant id associated with the cache.
type String: The type of identity used for the cache

principalId string: The principal id of the cache.
tenantId string: The tenant id associated with the cache.
type string: The type of identity used for the cache

principal_id str: The principal id of the cache.
tenant_id str: The tenant id associated with the cache.
type str: The type of identity used for the cache

principalId String: The principal id of the cache.
tenantId String: The tenant id associated with the cache.
type String: The type of identity used for the cache

CacheNetworkSettingsResponse

UtilityAddresses List<string>: Array of additional IP addresses used by this Cache.
DnsSearchDomain string: DNS search domain
DnsServers List<string>: DNS servers for the cache to use. It will be set from the network configuration if no value is provided.
Mtu int: The IPv4 maximum transmission unit configured for the subnet.
NtpServer string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.

UtilityAddresses []string: Array of additional IP addresses used by this Cache.
DnsSearchDomain string: DNS search domain
DnsServers []string: DNS servers for the cache to use. It will be set from the network configuration if no value is provided.
Mtu int: The IPv4 maximum transmission unit configured for the subnet.
NtpServer string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.

utilityAddresses List<String>: Array of additional IP addresses used by this Cache.
dnsSearchDomain String: DNS search domain
dnsServers List<String>: DNS servers for the cache to use. It will be set from the network configuration if no value is provided.
mtu Integer: The IPv4 maximum transmission unit configured for the subnet.
ntpServer String: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.

utilityAddresses string[]: Array of additional IP addresses used by this Cache.
dnsSearchDomain string: DNS search domain
dnsServers string[]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided.
mtu number: The IPv4 maximum transmission unit configured for the subnet.
ntpServer string: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.

utility_addresses Sequence[str]: Array of additional IP addresses used by this Cache.
dns_search_domain str: DNS search domain
dns_servers Sequence[str]: DNS servers for the cache to use. It will be set from the network configuration if no value is provided.
mtu int: The IPv4 maximum transmission unit configured for the subnet.
ntp_server str: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.

utilityAddresses List<String>: Array of additional IP addresses used by this Cache.
dnsSearchDomain String: DNS search domain
dnsServers List<String>: DNS servers for the cache to use. It will be set from the network configuration if no value is provided.
mtu Number: The IPv4 maximum transmission unit configured for the subnet.
ntpServer String: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.

CacheResponseSku

Name string: SKU name for this Cache.

Name string: SKU name for this Cache.

name String: SKU name for this Cache.

name string: SKU name for this Cache.

name str: SKU name for this Cache.

name String: SKU name for this Cache.

CacheSecuritySettingsResponse

AccessPolicies List<Pulumi.AzureNative.StorageCache.Inputs.NfsAccessPolicyResponse>: NFS access policies defined for this cache.

AccessPolicies []NfsAccessPolicyResponse: NFS access policies defined for this cache.

accessPolicies List<NfsAccessPolicyResponse>: NFS access policies defined for this cache.

accessPolicies NfsAccessPolicyResponse[]: NFS access policies defined for this cache.

access_policies Sequence[NfsAccessPolicyResponse]: NFS access policies defined for this cache.

accessPolicies List<Property Map>: NFS access policies defined for this cache.

CacheUpgradeStatusResponse

CurrentFirmwareVersion string: Version string of the firmware currently installed on this Cache.
FirmwareUpdateDeadline string: Time at which the pending firmware update will automatically be installed on the Cache.
FirmwareUpdateStatus string: True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
LastFirmwareUpdate string: Time of the last successful firmware update.
PendingFirmwareVersion string: When firmwareUpdateAvailable is true, this field holds the version string for the update.

CurrentFirmwareVersion string: Version string of the firmware currently installed on this Cache.
FirmwareUpdateDeadline string: Time at which the pending firmware update will automatically be installed on the Cache.
FirmwareUpdateStatus string: True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
LastFirmwareUpdate string: Time of the last successful firmware update.
PendingFirmwareVersion string: When firmwareUpdateAvailable is true, this field holds the version string for the update.

currentFirmwareVersion String: Version string of the firmware currently installed on this Cache.
firmwareUpdateDeadline String: Time at which the pending firmware update will automatically be installed on the Cache.
firmwareUpdateStatus String: True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
lastFirmwareUpdate String: Time of the last successful firmware update.
pendingFirmwareVersion String: When firmwareUpdateAvailable is true, this field holds the version string for the update.

currentFirmwareVersion string: Version string of the firmware currently installed on this Cache.
firmwareUpdateDeadline string: Time at which the pending firmware update will automatically be installed on the Cache.
firmwareUpdateStatus string: True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
lastFirmwareUpdate string: Time of the last successful firmware update.
pendingFirmwareVersion string: When firmwareUpdateAvailable is true, this field holds the version string for the update.

current_firmware_version str: Version string of the firmware currently installed on this Cache.
firmware_update_deadline str: Time at which the pending firmware update will automatically be installed on the Cache.
firmware_update_status str: True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
last_firmware_update str: Time of the last successful firmware update.
pending_firmware_version str: When firmwareUpdateAvailable is true, this field holds the version string for the update.

currentFirmwareVersion String: Version string of the firmware currently installed on this Cache.
firmwareUpdateDeadline String: Time at which the pending firmware update will automatically be installed on the Cache.
firmwareUpdateStatus String: True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.
lastFirmwareUpdate String: Time of the last successful firmware update.
pendingFirmwareVersion String: When firmwareUpdateAvailable is true, this field holds the version string for the update.

CacheUsernameDownloadSettingsResponse

UsernameDownloaded string: Indicates whether or not the HPC Cache has performed the username download successfully.
AutoDownloadCertificate bool: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
CaCertificateURI string: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
Credentials Pulumi.AzureNative.StorageCache.Inputs.CacheUsernameDownloadSettingsResponseCredentials: When present, these are the credentials for the secure LDAP connection.
EncryptLdapConnection bool: Whether or not the LDAP connection should be encrypted.
ExtendedGroups bool: Whether or not Extended Groups is enabled.
GroupFileURI string: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
LdapBaseDN string: The base distinguished name for the LDAP domain.
LdapServer string: The fully qualified domain name or IP address of the LDAP server to use.
RequireValidCertificate bool: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
UserFileURI string: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
UsernameSource string: This setting determines how the cache gets username and group names for clients.

UsernameDownloaded string: Indicates whether or not the HPC Cache has performed the username download successfully.
AutoDownloadCertificate bool: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
CaCertificateURI string: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
Credentials CacheUsernameDownloadSettingsResponseCredentials: When present, these are the credentials for the secure LDAP connection.
EncryptLdapConnection bool: Whether or not the LDAP connection should be encrypted.
ExtendedGroups bool: Whether or not Extended Groups is enabled.
GroupFileURI string: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
LdapBaseDN string: The base distinguished name for the LDAP domain.
LdapServer string: The fully qualified domain name or IP address of the LDAP server to use.
RequireValidCertificate bool: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
UserFileURI string: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
UsernameSource string: This setting determines how the cache gets username and group names for clients.

usernameDownloaded String: Indicates whether or not the HPC Cache has performed the username download successfully.
autoDownloadCertificate Boolean: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
caCertificateURI String: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
credentials CacheUsernameDownloadSettingsResponseCredentials: When present, these are the credentials for the secure LDAP connection.
encryptLdapConnection Boolean: Whether or not the LDAP connection should be encrypted.
extendedGroups Boolean: Whether or not Extended Groups is enabled.
groupFileURI String: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
ldapBaseDN String: The base distinguished name for the LDAP domain.
ldapServer String: The fully qualified domain name or IP address of the LDAP server to use.
requireValidCertificate Boolean: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
userFileURI String: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
usernameSource String: This setting determines how the cache gets username and group names for clients.

usernameDownloaded string: Indicates whether or not the HPC Cache has performed the username download successfully.
autoDownloadCertificate boolean: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
caCertificateURI string: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
credentials CacheUsernameDownloadSettingsResponseCredentials: When present, these are the credentials for the secure LDAP connection.
encryptLdapConnection boolean: Whether or not the LDAP connection should be encrypted.
extendedGroups boolean: Whether or not Extended Groups is enabled.
groupFileURI string: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
ldapBaseDN string: The base distinguished name for the LDAP domain.
ldapServer string: The fully qualified domain name or IP address of the LDAP server to use.
requireValidCertificate boolean: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
userFileURI string: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
usernameSource string: This setting determines how the cache gets username and group names for clients.

username_downloaded str: Indicates whether or not the HPC Cache has performed the username download successfully.
auto_download_certificate bool: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
ca_certificate_uri str: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
credentials CacheUsernameDownloadSettingsResponseCredentials: When present, these are the credentials for the secure LDAP connection.
encrypt_ldap_connection bool: Whether or not the LDAP connection should be encrypted.
extended_groups bool: Whether or not Extended Groups is enabled.
group_file_uri str: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
ldap_base_dn str: The base distinguished name for the LDAP domain.
ldap_server str: The fully qualified domain name or IP address of the LDAP server to use.
require_valid_certificate bool: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
user_file_uri str: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
username_source str: This setting determines how the cache gets username and group names for clients.

usernameDownloaded String: Indicates whether or not the HPC Cache has performed the username download successfully.
autoDownloadCertificate Boolean: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
caCertificateURI String: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
credentials Property Map: When present, these are the credentials for the secure LDAP connection.
encryptLdapConnection Boolean: Whether or not the LDAP connection should be encrypted.
extendedGroups Boolean: Whether or not Extended Groups is enabled.
groupFileURI String: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
ldapBaseDN String: The base distinguished name for the LDAP domain.
ldapServer String: The fully qualified domain name or IP address of the LDAP server to use.
requireValidCertificate Boolean: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
userFileURI String: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
usernameSource String: This setting determines how the cache gets username and group names for clients.

CacheUsernameDownloadSettingsResponseCredentials

BindDn string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
BindPassword string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

BindDn string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
BindPassword string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

bindDn String: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
bindPassword String: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

bindDn string: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
bindPassword string: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

bind_dn str: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
bind_password str: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

bindDn String: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
bindPassword String: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.

ConditionResponse

Message string: The issue requiring attention.
Timestamp string: The time when the condition was raised.

Message string: The issue requiring attention.
Timestamp string: The time when the condition was raised.

message String: The issue requiring attention.
timestamp String: The time when the condition was raised.

message string: The issue requiring attention.
timestamp string: The time when the condition was raised.

message str: The issue requiring attention.
timestamp str: The time when the condition was raised.

message String: The issue requiring attention.
timestamp String: The time when the condition was raised.

KeyVaultKeyReferenceResponse

KeyUrl string: The URL referencing a key encryption key in Key Vault.
SourceVault Pulumi.AzureNative.StorageCache.Inputs.KeyVaultKeyReferenceResponseSourceVault: Describes a resource Id to source Key Vault.

KeyUrl string: The URL referencing a key encryption key in Key Vault.
SourceVault KeyVaultKeyReferenceResponseSourceVault: Describes a resource Id to source Key Vault.

keyUrl String: The URL referencing a key encryption key in Key Vault.
sourceVault KeyVaultKeyReferenceResponseSourceVault: Describes a resource Id to source Key Vault.

keyUrl string: The URL referencing a key encryption key in Key Vault.
sourceVault KeyVaultKeyReferenceResponseSourceVault: Describes a resource Id to source Key Vault.

key_url str: The URL referencing a key encryption key in Key Vault.
source_vault KeyVaultKeyReferenceResponseSourceVault: Describes a resource Id to source Key Vault.

keyUrl String: The URL referencing a key encryption key in Key Vault.
sourceVault Property Map: Describes a resource Id to source Key Vault.

KeyVaultKeyReferenceResponseSourceVault

Id string: Resource Id.

Id string: Resource Id.

id String: Resource Id.

id string: Resource Id.

id str: Resource Id.

id String: Resource Id.

NfsAccessPolicyResponse

AccessRules List<Pulumi.AzureNative.StorageCache.Inputs.NfsAccessRuleResponse>: The set of rules describing client accesses allowed under this policy.
Name string: Name identifying this policy. Access Policy names are not case sensitive.

AccessRules []NfsAccessRuleResponse: The set of rules describing client accesses allowed under this policy.
Name string: Name identifying this policy. Access Policy names are not case sensitive.

accessRules List<NfsAccessRuleResponse>: The set of rules describing client accesses allowed under this policy.
name String: Name identifying this policy. Access Policy names are not case sensitive.

accessRules NfsAccessRuleResponse[]: The set of rules describing client accesses allowed under this policy.
name string: Name identifying this policy. Access Policy names are not case sensitive.

access_rules Sequence[NfsAccessRuleResponse]: The set of rules describing client accesses allowed under this policy.
name str: Name identifying this policy. Access Policy names are not case sensitive.

accessRules List<Property Map>: The set of rules describing client accesses allowed under this policy.
name String: Name identifying this policy. Access Policy names are not case sensitive.

NfsAccessRuleResponse

Access string: Access allowed by this rule.
Scope string: Scope for this rule. The scope and filter determine which clients match the rule.
AnonymousGID string: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
AnonymousUID string: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
Filter string: 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 filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
RootSquash bool: Map root accesses to anonymousUID and anonymousGID.
SubmountAccess bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
Suid bool: Allow SUID semantics.

Access string: Access allowed by this rule.
Scope string: Scope for this rule. The scope and filter determine which clients match the rule.
AnonymousGID string: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
AnonymousUID string: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
Filter string: 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 filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
RootSquash bool: Map root accesses to anonymousUID and anonymousGID.
SubmountAccess bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
Suid bool: Allow SUID semantics.

access String: Access allowed by this rule.
scope String: Scope for this rule. The scope and filter determine which clients match the rule.
anonymousGID String: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
anonymousUID String: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
filter String: 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 filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
rootSquash Boolean: Map root accesses to anonymousUID and anonymousGID.
submountAccess Boolean: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
suid Boolean: Allow SUID semantics.

access string: Access allowed by this rule.
scope string: Scope for this rule. The scope and filter determine which clients match the rule.
anonymousGID string: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
anonymousUID string: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
filter string: 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 filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
rootSquash boolean: Map root accesses to anonymousUID and anonymousGID.
submountAccess boolean: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
suid boolean: Allow SUID semantics.

access str: Access allowed by this rule.
scope str: Scope for this rule. The scope and filter determine which clients match the rule.
anonymous_gid str: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
anonymous_uid str: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
filter str: 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 filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
root_squash bool: Map root accesses to anonymousUID and anonymousGID.
submount_access bool: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
suid bool: Allow SUID semantics.

access String: Access allowed by this rule.
scope String: Scope for this rule. The scope and filter determine which clients match the rule.
anonymousGID String: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
anonymousUID String: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
filter String: 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 filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
rootSquash Boolean: Map root accesses to anonymousUID and anonymousGID.
submountAccess Boolean: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
suid Boolean: Allow SUID semantics.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

Package Details

Repository: azure-native-v1 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.storagecache.getCache

On this page

On this page

Using getCache

getCache Result

Supporting Types

CacheActiveDirectorySettingsResponse

CacheActiveDirectorySettingsResponseCredentials

CacheDirectorySettingsResponse

CacheEncryptionSettingsResponse

CacheHealthResponse

CacheIdentityResponse

CacheNetworkSettingsResponse

CacheResponseSku

CacheSecuritySettingsResponse

CacheUpgradeStatusResponse

CacheUsernameDownloadSettingsResponse

CacheUsernameDownloadSettingsResponseCredentials

ConditionResponse

KeyVaultKeyReferenceResponse

KeyVaultKeyReferenceResponseSourceVault

NfsAccessPolicyResponse

NfsAccessRuleResponse

SystemDataResponse

Package Details

On this page

On this page