Cache interface

Package:

@azure/arm-storagecache

A Cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Extends

BaseResource

Properties

cacheSizeGB	The size of this Cache, in GB.
directoryServicesSettings	Specifies Directory Services settings of the cache.
encryptionSettings	Specifies encryption settings of the cache.
health	Health of the Cache. NOTE: This property will not be serialized. It can only be populated by the server.
id	Resource ID of the Cache. NOTE: This property will not be serialized. It can only be populated by the server.
identity	The identity of the cache, if configured.
location	Region name string.
mountAddresses	Array of IP addresses that can be used by clients mounting this Cache. NOTE: This property will not be serialized. It can only be populated by the server.
name	Name of Cache. NOTE: This property will not be serialized. It can only be populated by the server.
networkSettings	Specifies network settings of the cache.
provisioningState	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property. Possible values include: 'Succeeded', 'Failed', 'Cancelled', 'Creating', 'Deleting', 'Updating' NOTE: This property will not be serialized. It can only be populated by the server.
securitySettings	Specifies security settings of the cache.
sku	SKU for the Cache.
subnet	Subnet used for the Cache.
systemData	The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Type of the Cache; Microsoft.StorageCache/Cache NOTE: This property will not be serialized. It can only be populated by the server.
upgradeStatus	Upgrade status of the Cache. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

cacheSizeGB

The size of this Cache, in GB.

cacheSizeGB?: undefined | number

Property Value

undefined | number

directoryServicesSettings

Specifies Directory Services settings of the cache.

directoryServicesSettings?: CacheDirectorySettings

Property Value

CacheDirectorySettings

encryptionSettings

Specifies encryption settings of the cache.

encryptionSettings?: CacheEncryptionSettings

Property Value

CacheEncryptionSettings

health

Health of the Cache. NOTE: This property will not be serialized. It can only be populated by the server.

health?: CacheHealth

Property Value

CacheHealth

id

Resource ID of the Cache. NOTE: This property will not be serialized. It can only be populated by the server.

id?: undefined | string

Property Value

undefined | string

identity

The identity of the cache, if configured.

identity?: CacheIdentity

Property Value

CacheIdentity

location

Region name string.

location?: undefined | string

Property Value

undefined | string

mountAddresses

Array of IP addresses that can be used by clients mounting this Cache. NOTE: This property will not be serialized. It can only be populated by the server.

mountAddresses?: string[]

Property Value

string[]

name

Name of Cache. NOTE: This property will not be serialized. It can only be populated by the server.

name?: undefined | string

Property Value

undefined | string

networkSettings

Specifies network settings of the cache.

networkSettings?: CacheNetworkSettings

Property Value

CacheNetworkSettings

provisioningState

ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property. Possible values include: 'Succeeded', 'Failed', 'Cancelled', 'Creating', 'Deleting', 'Updating' NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: ProvisioningStateType

Property Value

ProvisioningStateType

securitySettings

Specifies security settings of the cache.

securitySettings?: CacheSecuritySettings

Property Value

CacheSecuritySettings

sku

SKU for the Cache.

sku?: CacheSku

Property Value

CacheSku

subnet

Subnet used for the Cache.

subnet?: undefined | string

Property Value

undefined | string

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

tags

Resource tags.

tags?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

type

Type of the Cache; Microsoft.StorageCache/Cache NOTE: This property will not be serialized. It can only be populated by the server.

type?: undefined | string

Property Value

undefined | string

upgradeStatus

Upgrade status of the Cache. NOTE: This property will not be serialized. It can only be populated by the server.

upgradeStatus?: CacheUpgradeStatus

Property Value

CacheUpgradeStatus