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

ProxyResource

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.
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.
networkSettings	Specifies network settings of the cache.
primingJobs	Specifies the priming jobs defined in the cache.
provisioningState	ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
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.
subnet	Subnet used for the cache.
tags	Resource tags.
upgradeSettings	Upgrade settings of the cache.
upgradeStatus	Upgrade status of the cache.
zones	Availability zones for resources. This field should only contain a single element in the array.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

health?: CacheHealth

Property Value

CacheHealth

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.

mountAddresses?: 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.

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

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.

spaceAllocation?: StorageTargetSpaceAllocation[]

Property Value

StorageTargetSpaceAllocation[]

subnet

Subnet used for the cache.

subnet?: string

Property Value

string

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

upgradeSettings

Upgrade settings of the cache.

upgradeSettings?: CacheUpgradeSettings

Property Value

CacheUpgradeSettings

upgradeStatus

Upgrade status of the cache.

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type