Microsoft.StorageCache (stable:2019-11-01)

2025/10/23 • 17 new, 17 deleted methods

Operations_List (new)
Description :  Lists all of the available Resource Provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorageCache/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Resource Provider operations supported by the Microsoft.StorageCache resource provider. ,
Required: False ,
}
[
{
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft.StorageCache ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Cache, etc. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Skus_List (new)
Description :  Get the list of StorageCache.Cache SKUs available to this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Cache SKUs. ,
Required: False ,
}
string ,
value:
{
Description: The list of SKUs available for the subscription. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: A list of capabilities of this SKU, such as throughput or ops/sec. ,
Required: False ,
}
[
{
name:
{
Description: Name of a capability, such as ops/sec. ,
Required: False ,
}
string ,
value:
{
Description: Quantity, if the capability is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
locations:
{
Description: The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: The set of locations that the SKU is available. ,
Required: False ,
}
[
{
location:
{
Description: Location where this SKU is available. ,
Required: False ,
}
string ,
zones:
{
Description: Zones if any. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
name:
{
Description: The name of this SKU. ,
Required: False ,
}
string ,
restrictions:
{
Description: The restrictions preventing this SKU from being used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. In this version, the only possible value for this is location. ,
Required: False ,
}
string ,
values:
{
Description: The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". "QuotaId" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. "NotAvailableForSubscription" is related to capacity at the datacenter. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
UsageModels_List (new)
Description :  Get the list of Cache Usage Models available to this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Cache usage models. ,
Required: False ,
}
string ,
value:
{
Description: The list of usage models available for the subscription. ,
Required: False ,
}
[
{
display:
{
Description: Localized information describing this usage model. ,
Required: False ,
}
{
description:
{
Description: String to display for this usage model. ,
Required: False ,
}
string ,
}
,
modelName:
{
Description: Non-localized keyword name for this usage model. ,
Required: False ,
}
string ,
targetType:
{
Description: The type of Storage Target to which this model is applicable (only nfs3 as of this version). ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_List (new)
Description :  Returns all Caches the user has access to under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of Cache list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Caches. ,
Required: False ,
}
[
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_ListByResourceGroup (new)
Description :  Returns all Caches the user has access to under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of Cache list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Caches. ,
Required: False ,
}
[
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Delete (new)
Description :  Schedules a Cache for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Get (new)
Description :  Returns a Cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_CreateOrUpdate (new)
Description :  Create or update a Cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
cache:
{
Description: Object containing the user-selectable properties of the new Cache. If read-only properties are included, they must match the existing values of those properties. ,
Required: False ,
}
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Update (new)
Description :  Update a Cache instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
cache:
{
Description: Object containing the user-selectable properties of the Cache. If read-only properties are included, they must match the existing values of those properties. ,
Required: False ,
}
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Flush (new)
Description :  Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Start (new)
Description :  Tells a Stopped state Cache to transition to Active state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Stop (new)
Description :  Tells an Active Cache to transition to Stopped state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_ListByCache (new)
Description :  Returns a list of Storage Targets for the specified Cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Storage Targets. ,
Required: False ,
}
string ,
value:
{
Description: The list of Storage Targets defined for the Cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_Delete (new)
Description :  Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_Get (new)
Description :  Returns a Storage Target from a Cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of the Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_CreateOrUpdate (new)
Description :  Create or update a Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of the Storage Target. ,
Required: True ,
}
string ,
storagetarget:
{
Description: Object containing the definition of a Storage Target. ,
Required: False ,
}
{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_UpgradeFirmware (new)
Description :  Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Resource Provider operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.StorageCache/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Resource Provider operations supported by the Microsoft.StorageCache resource provider. ,
Required: False ,
}
[
{
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft.StorageCache ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Cache, etc. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Skus_List (removed)
Description :  Get the list of StorageCache.Cache SKUs available to this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Cache SKUs. ,
Required: False ,
}
string ,
value:
{
Description: The list of SKUs available for the subscription. ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Required: False ,
}
string ,
capabilities:
{
Description: A list of capabilities of this SKU, such as throughput or ops/sec. ,
Required: False ,
}
[
{
name:
{
Description: Name of a capability, such as ops/sec. ,
Required: False ,
}
string ,
value:
{
Description: Quantity, if the capability is measured by quantity. ,
Required: False ,
}
string ,
}
,
]
,
locations:
{
Description: The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: The set of locations that the SKU is available. ,
Required: False ,
}
[
{
location:
{
Description: Location where this SKU is available. ,
Required: False ,
}
string ,
zones:
{
Description: Zones if any. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
name:
{
Description: The name of this SKU. ,
Required: False ,
}
string ,
restrictions:
{
Description: The restrictions preventing this SKU from being used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. In this version, the only possible value for this is location. ,
Required: False ,
}
string ,
values:
{
Description: The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". "QuotaId" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. "NotAvailableForSubscription" is related to capacity at the datacenter. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
UsageModels_List (removed)
Description :  Get the list of Cache Usage Models available to this subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Cache usage models. ,
Required: False ,
}
string ,
value:
{
Description: The list of usage models available for the subscription. ,
Required: False ,
}
[
{
display:
{
Description: Localized information describing this usage model. ,
Required: False ,
}
{
description:
{
Description: String to display for this usage model. ,
Required: False ,
}
string ,
}
,
modelName:
{
Description: Non-localized keyword name for this usage model. ,
Required: False ,
}
string ,
targetType:
{
Description: The type of Storage Target to which this model is applicable (only nfs3 as of this version). ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_List (removed)
Description :  Returns all Caches the user has access to under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of Cache list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Caches. ,
Required: False ,
}
[
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_ListByResourceGroup (removed)
Description :  Returns all Caches the user has access to under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to get the next set of Cache list results, if there are any. ,
Required: False ,
}
string ,
value:
{
Description: List of Caches. ,
Required: False ,
}
[
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Delete (removed)
Description :  Schedules a Cache for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Get (removed)
Description :  Returns a Cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_CreateOrUpdate (removed)
Description :  Create or update a Cache.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
cache:
{
Description: Object containing the user-selectable properties of the new Cache. If read-only properties are included, they must match the existing values of those properties. ,
Required: False ,
}
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Update (removed)
Description :  Update a Cache instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
cache:
{
Description: Object containing the user-selectable properties of the Cache. If read-only properties are included, they must match the existing values of those properties. ,
Required: False ,
}
{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
tags:
{
Description: ARM tags as name/value pairs. ,
Required: False ,
}
object ,
id:
{
Description: Resource ID of the Cache. ,
Required: False ,
}
string ,
location:
{
Description: Region name string. ,
Required: False ,
}
string ,
name:
{
Description: Name of Cache. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Cache; Microsoft.StorageCache/Cache ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Required: False ,
}
integer ,
health:
{
Description: Health of the Cache. ,
Required: False ,
}
{
state:
{
Description: List of Cache health states. ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
Degraded: No description available. ,
Down: No description available. ,
Transitioning: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Upgrading: No description available. ,
Flushing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDescription:
{
Description: Describes explanation of state. ,
Required: False ,
}
string ,
}
,
mountAddresses:
{
Description: Array of IP addresses that can be used by clients mounting this Cache. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Subnet used for the Cache. ,
Required: False ,
}
string ,
upgradeStatus:
{
Description: Upgrade status of the Cache. ,
Required: False ,
}
{
currentFirmwareVersion:
{
Description: Version string of the firmware currently installed on this Cache. ,
Required: False ,
}
string ,
firmwareUpdateStatus:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
firmwareUpdateDeadline:
{
Description: Time at which the pending firmware update will automatically be installed on the Cache. ,
Format: date-time ,
Required: False ,
}
string ,
lastFirmwareUpdate:
{
Description: Time of the last successful firmware update. ,
Format: date-time ,
Required: False ,
}
string ,
pendingFirmwareVersion:
{
Description: When firmwareUpdateAvailable is true, this field holds the version string for the update. ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Flush (removed)
Description :  Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Start (removed)
Description :  Tells a Stopped state Cache to transition to Active state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_Stop (removed)
Description :  Tells an Active Cache to transition to Stopped state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_ListByCache (removed)
Description :  Returns a list of Storage Targets for the specified Cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The URI to fetch the next page of Storage Targets. ,
Required: False ,
}
string ,
value:
{
Description: The list of Storage Targets defined for the Cache. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_Delete (removed)
Description :  Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_Get (removed)
Description :  Returns a Storage Target from a Cache.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of the Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
StorageTargets_CreateOrUpdate (removed)
Description :  Create or update a Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of the Storage Target. ,
Required: True ,
}
string ,
storagetarget:
{
Description: Object containing the definition of a Storage Target. ,
Required: False ,
}
{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: Name of the Storage Target. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID of the Storage Target. ,
Required: False ,
}
string ,
type:
{
Description: Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Storage Target. ,
Required: False ,
}
{
junctions:
{
Description: List of Cache namespace junctions to target for namespace associations. ,
Required: False ,
}
[
{
namespacePath:
{
Description: Namespace path on a Cache for a Storage Target. ,
Required: False ,
}
string ,
targetPath:
{
Description: Path in Storage Target to which namespacePath points. ,
Required: False ,
}
string ,
nfsExport:
{
Description: NFS export where targetPath exists. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
nfs3:
{
Description: Properties when targetType is nfs3. ,
Required: False ,
}
{
target:
{
Description: IP address or host name of an NFSv3 host (e.g., 10.0.44.44). ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels ,
Required: False ,
}
string ,
}
,
clfs:
{
Description: Properties when targetType is clfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of storage container. ,
Required: False ,
}
string ,
}
,
unknown:
{
Description: Properties when targetType is unknown. ,
Required: False ,
}
{
unknownMap:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}
Caches_UpgradeFirmware (removed)
Description :  Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade
{
resourceGroupName:
{
Description: Target resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
cacheName:
{
Description: Name of Cache. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$schema: string ,
}

⚐ Response (202)

{
$schema: string ,
}

⚐ Response (204)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: The body of the error. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
}
,
}