Share via

Cache interface

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

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 IPv4 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.
primingJobs

Specifies the priming jobs defined in the cache. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property 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.
spaceAllocation

Specifies the space allocation percentage for each storage target in the cache. NOTE: This property will not be serialized. It can only be populated by the server.
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.
upgradeSettings

Upgrade settings of the cache.
upgradeStatus

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

Availability zones for resources. This field should only contain a single element in the array.

Property Details

cacheSizeGB

The size of this Cache, in GB.

cacheSizeGB?: number

Property Value

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?: string

Property Value

string

identity

The identity of the cache, if configured.

identity?: CacheIdentity

Property Value

CacheIdentity

location

Region name string.

location?: string

Property Value

string

mountAddresses

Array of IPv4 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?: string

Property Value

string

networkSettings

Specifies network settings of the cache.

networkSettings?: CacheNetworkSettings

Property Value

CacheNetworkSettings

primingJobs

Specifies the priming jobs defined in the cache. NOTE: This property will not be serialized. It can only be populated by the server.

primingJobs?: PrimingJob[]

Property Value

PrimingJob[]

provisioningState

ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

securitySettings

Specifies security settings of the cache.

securitySettings?: CacheSecuritySettings

Property Value

CacheSecuritySettings

sku

SKU for the cache.

sku?: CacheSku

Property Value

CacheSku

spaceAllocation

Specifies the space allocation percentage for each storage target in the cache. NOTE: This property will not be serialized. It can only be populated by the server.

spaceAllocation?: StorageTargetSpaceAllocation[]

Property Value

StorageTargetSpaceAllocation[]

subnet

Subnet used for the cache.

subnet?: string

Property Value

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?: {[propertyName: string]: string}

Property Value

{[propertyName: 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?: string

Property Value

string

upgradeSettings

Upgrade settings of the cache.

upgradeSettings?: CacheUpgradeSettings

Property Value

CacheUpgradeSettings

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

zones

Availability zones for resources. This field should only contain a single element in the array.

zones?: string[]

Property Value

string[]