Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The caches resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StorageCache/caches resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.StorageCache/caches@2020-03-01' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
cacheSizeGB: int
encryptionSettings: {
keyEncryptionKey: {
keyUrl: 'string'
sourceVault: {
id: 'string'
}
}
}
networkSettings: {
mtu: int
}
provisioningState: 'string'
securitySettings: {
rootSquash: bool
}
subnet: 'string'
upgradeStatus: {}
}
sku: {
name: 'string'
}
tags: any(...)
}
Property Values
Microsoft.StorageCache/caches
| Name | Description | Value |
|---|---|---|
| identity | The identity of the cache, if configured. | CacheIdentity |
| location | Region name string. | string |
| name | The resource name | string Constraints: Pattern = ^[-0-9a-zA-Z_]{1,80}$ (required) |
| properties | Properties of the Cache. | CacheProperties |
| sku | SKU for the Cache. | CacheSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CacheEncryptionSettings
| Name | Description | Value |
|---|---|---|
| keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. | KeyVaultKeyReference |
CacheIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the cache | 'None' 'SystemAssigned' |
CacheNetworkSettings
| Name | Description | Value |
|---|---|---|
| mtu | The IPv4 maximum transmission unit configured for the subnet. | int Constraints: Min value = 576 Max value = 1500 |
CacheProperties
| Name | Description | Value |
|---|---|---|
| cacheSizeGB | The size of this Cache, in GB. | int |
| encryptionSettings | Specifies encryption settings of the cache. | CacheEncryptionSettings |
| networkSettings | Specifies network settings of the cache. | CacheNetworkSettings |
| provisioningState | ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property | 'Cancelled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| securitySettings | Specifies security settings of the cache. | CacheSecuritySettings |
| subnet | Subnet used for the Cache. | string |
| upgradeStatus | Upgrade status of the Cache. | CacheUpgradeStatus |
CacheSecuritySettings
| Name | Description | Value |
|---|---|---|
| rootSquash | root squash of cache property. | bool |
CacheSku
| Name | Description | Value |
|---|---|---|
| name | SKU name for this Cache. | string |
CacheUpgradeStatus
| Name | Description | Value |
|---|
KeyVaultKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | The URL referencing a key encryption key in Key Vault. | string (required) |
| sourceVault | Describes a resource Id to source Key Vault. | KeyVaultKeyReferenceSourceVault (required) |
KeyVaultKeyReferenceSourceVault
| Name | Description | Value |
|---|---|---|
| id | Resource Id. | string |
ARM template resource definition
The caches resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StorageCache/caches resource, add the following JSON to your template.
{
"type": "Microsoft.StorageCache/caches",
"apiVersion": "2020-03-01",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"cacheSizeGB": "int",
"encryptionSettings": {
"keyEncryptionKey": {
"keyUrl": "string",
"sourceVault": {
"id": "string"
}
}
},
"networkSettings": {
"mtu": "int"
},
"provisioningState": "string",
"securitySettings": {
"rootSquash": "bool"
},
"subnet": "string",
"upgradeStatus": {
}
},
"sku": {
"name": "string"
},
"tags": {}
}
Property Values
Microsoft.StorageCache/caches
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-03-01' |
| identity | The identity of the cache, if configured. | CacheIdentity |
| location | Region name string. | string |
| name | The resource name | string Constraints: Pattern = ^[-0-9a-zA-Z_]{1,80}$ (required) |
| properties | Properties of the Cache. | CacheProperties |
| sku | SKU for the Cache. | CacheSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.StorageCache/caches' |
CacheEncryptionSettings
| Name | Description | Value |
|---|---|---|
| keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. | KeyVaultKeyReference |
CacheIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the cache | 'None' 'SystemAssigned' |
CacheNetworkSettings
| Name | Description | Value |
|---|---|---|
| mtu | The IPv4 maximum transmission unit configured for the subnet. | int Constraints: Min value = 576 Max value = 1500 |
CacheProperties
| Name | Description | Value |
|---|---|---|
| cacheSizeGB | The size of this Cache, in GB. | int |
| encryptionSettings | Specifies encryption settings of the cache. | CacheEncryptionSettings |
| networkSettings | Specifies network settings of the cache. | CacheNetworkSettings |
| provisioningState | ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property | 'Cancelled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| securitySettings | Specifies security settings of the cache. | CacheSecuritySettings |
| subnet | Subnet used for the Cache. | string |
| upgradeStatus | Upgrade status of the Cache. | CacheUpgradeStatus |
CacheSecuritySettings
| Name | Description | Value |
|---|---|---|
| rootSquash | root squash of cache property. | bool |
CacheSku
| Name | Description | Value |
|---|---|---|
| name | SKU name for this Cache. | string |
CacheUpgradeStatus
| Name | Description | Value |
|---|
KeyVaultKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | The URL referencing a key encryption key in Key Vault. | string (required) |
| sourceVault | Describes a resource Id to source Key Vault. | KeyVaultKeyReferenceSourceVault (required) |
KeyVaultKeyReferenceSourceVault
| Name | Description | Value |
|---|---|---|
| id | Resource Id. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The caches resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.StorageCache/caches resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.StorageCache/caches@2020-03-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = ?
body = {
properties = {
cacheSizeGB = int
encryptionSettings = {
keyEncryptionKey = {
keyUrl = "string"
sourceVault = {
id = "string"
}
}
}
networkSettings = {
mtu = int
}
provisioningState = "string"
securitySettings = {
rootSquash = bool
}
subnet = "string"
upgradeStatus = {
}
}
sku = {
name = "string"
}
}
}
Property Values
Microsoft.StorageCache/caches
| Name | Description | Value |
|---|---|---|
| identity | The identity of the cache, if configured. | CacheIdentity |
| location | Region name string. | string |
| name | The resource name | string Constraints: Pattern = ^[-0-9a-zA-Z_]{1,80}$ (required) |
| properties | Properties of the Cache. | CacheProperties |
| sku | SKU for the Cache. | CacheSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.StorageCache/caches@2020-03-01" |
CacheEncryptionSettings
| Name | Description | Value |
|---|---|---|
| keyEncryptionKey | Specifies the location of the key encryption key in Key Vault. | KeyVaultKeyReference |
CacheIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of identity used for the cache | 'None' 'SystemAssigned' |
CacheNetworkSettings
| Name | Description | Value |
|---|---|---|
| mtu | The IPv4 maximum transmission unit configured for the subnet. | int Constraints: Min value = 576 Max value = 1500 |
CacheProperties
| Name | Description | Value |
|---|---|---|
| cacheSizeGB | The size of this Cache, in GB. | int |
| encryptionSettings | Specifies encryption settings of the cache. | CacheEncryptionSettings |
| networkSettings | Specifies network settings of the cache. | CacheNetworkSettings |
| provisioningState | ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property | 'Cancelled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating' |
| securitySettings | Specifies security settings of the cache. | CacheSecuritySettings |
| subnet | Subnet used for the Cache. | string |
| upgradeStatus | Upgrade status of the Cache. | CacheUpgradeStatus |
CacheSecuritySettings
| Name | Description | Value |
|---|---|---|
| rootSquash | root squash of cache property. | bool |
CacheSku
| Name | Description | Value |
|---|---|---|
| name | SKU name for this Cache. | string |
CacheUpgradeStatus
| Name | Description | Value |
|---|
KeyVaultKeyReference
| Name | Description | Value |
|---|---|---|
| keyUrl | The URL referencing a key encryption key in Key Vault. | string (required) |
| sourceVault | Describes a resource Id to source Key Vault. | KeyVaultKeyReferenceSourceVault (required) |
KeyVaultKeyReferenceSourceVault
| Name | Description | Value |
|---|---|---|
| id | Resource Id. | string |