Microsoft.StorageCache (stable:2021-03-01)

2025/10/23 • 20 new, 20 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 ,
description:
{
Description: The description of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: The flag that indicates whether the operation applies to data plane. ,
Required: False ,
}
boolean ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
properties:
{
Description: Additional details about an operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Specification of the all the metrics provided for a resource type. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Details about operations related to metrics. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that the metric is measured in. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The type of metric aggregation. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Support metric aggregation type. ,
Required: False ,
}
[
string ,
]
,
metricClass:
{
Description: Type of metrics. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
internalName:
{
Description: Internal name of the dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: To be exported to shoe box. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ 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 where the SKU is available. This is the supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: The set of locations where 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 ,
}
,
}
AscOperations_Get (new)
Description :  Gets the status of an asynchronous operation for the Azure HPC Cache
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}
{
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 ,
location:
{
Description: The name of the region used to look up the operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation id which uniquely identifies the asynchronous operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional operation-specific properties ,
Required: False ,
}
{
output:
{
Description: Additional operation-specific output. ,
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_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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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 ,
}
,
}
StorageTargets_DnsRefresh (new)
Description :  Tells a storage target to refresh its DNS information.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/dnsRefresh
{
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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_DebugInfo (new)
Description :  Tells a Cache to write generate debug info for support to process.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo
{
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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 ,
}
[
{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
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 ,
}
,
}
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
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 ,
}
,
}
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
storagetarget:
{
Description: Object containing the definition of a Storage Target. ,
Required: False ,
}
{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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 ,
description:
{
Description: The description of the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: The flag that indicates whether the operation applies to data plane. ,
Required: False ,
}
boolean ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
properties:
{
Description: Additional details about an operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Specification of the all the metrics provided for a resource type. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Details about operations related to metrics. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit that the metric is measured in. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The type of metric aggregation. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Support metric aggregation type. ,
Required: False ,
}
[
string ,
]
,
metricClass:
{
Description: Type of metrics. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
internalName:
{
Description: Internal name of the dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: To be exported to shoe box. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ 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 where the SKU is available. This is the supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
locationInfo:
{
Description: The set of locations where 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 ,
}
,
}
AscOperations_Get (removed)
Description :  Gets the status of an asynchronous operation for the Azure HPC Cache
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}
{
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 ,
location:
{
Description: The name of the region used to look up the operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation id which uniquely identifies the asynchronous operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional operation-specific properties ,
Required: False ,
}
{
output:
{
Description: Additional operation-specific output. ,
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_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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
sku:
{
Description: SKU for the Cache. ,
Required: False ,
}
{
name:
{
Description: SKU name for this Cache. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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: Resource tags. ,
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 ,
identity:
{
Description: The identity of the cache, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the cache. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the cache. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the cache ,
Enum:
{
SystemAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Properties of the Cache. ,
Required: False ,
}
{
cacheSizeGB:
{
Description: The size of this Cache, in GB. ,
Format: int32 ,
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 ,
conditions:
{
Description: Outstanding conditions that need to be investigated and resolved. ,
Required: False ,
}
[
{
timestamp:
{
Description: The time when the condition was raised. ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: The issue requiring attention. ,
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 ,
}
,
networkSettings:
{
Description: Specifies network settings of the cache. ,
Required: False ,
}
{
mtu:
{
Description: The IPv4 maximum transmission unit configured for the subnet. ,
Format: int32 ,
Required: False ,
}
integer ,
utilityAddresses:
{
Description: Array of additional IP addresses used by this Cache. ,
Required: False ,
}
[
string ,
]
,
dnsServers:
{
Description: DNS servers for the cache to use. It will be set from the network configuration if no value is provided. ,
Required: False ,
}
[
string ,
]
,
dnsSearchDomain:
{
Description: DNS search domain ,
Required: False ,
}
string ,
ntpServer:
{
Description: NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. ,
Required: False ,
}
string ,
}
,
encryptionSettings:
{
Description: Specifies encryption settings of the cache. ,
Required: False ,
}
{
keyEncryptionKey:
{
Description: Specifies the location of the key encryption key in Key Vault. ,
Required: False ,
}
{
keyUrl:
{
Description: The URL referencing a key encryption key in Key Vault. ,
Required: True ,
}
string ,
sourceVault:
{
Description: Describes a resource Id to source Key Vault. ,
Required: True ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
securitySettings:
{
Description: Specifies security settings of the cache. ,
Required: False ,
}
{
accessPolicies:
{
Description: NFS access policies defined for this cache. ,
Required: False ,
}
[
{
name:
{
Description: Name identifying this policy. Access Policy names are not case sensitive. ,
Required: True ,
}
string ,
accessRules:
{
Description: The set of rules describing client accesses allowed under this policy. ,
Required: True ,
}
[
{
scope:
{
Description: Scope for this rule. The scope and filter determine which clients match the rule. ,
Enum:
{
default: No description available. ,
network: No description available. ,
host: No description available. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. ,
Required: False ,
}
string ,
access:
{
Description: Access allowed by this rule. ,
Enum:
{
no: No description available. ,
ro: No description available. ,
rw: No description available. ,
}
,
Required: True ,
}
enum ,
suid:
{
Description: Allow SUID semantics. ,
Required: False ,
}
boolean ,
submountAccess:
{
Description: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. ,
Required: False ,
}
boolean ,
rootSquash:
{
Description: Map root accesses to anonymousUID and anonymousGID. ,
Required: False ,
}
boolean ,
anonymousUID:
{
Description: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. ,
Required: False ,
}
string ,
anonymousGID:
{
Description: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
directoryServicesSettings:
{
Description: Specifies Directory Services settings of the cache. ,
Required: False ,
}
{
activeDirectory:
{
Description: Specifies settings for joining the HPC Cache to an Active Directory domain. ,
Required: False ,
}
{
primaryDnsIpAddress:
{
Description: Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: True ,
}
string ,
secondaryDnsIpAddress:
{
Description: Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. ,
Required: False ,
}
string ,
domainName:
{
Description: The fully qualified domain name of the Active Directory domain controller. ,
Required: True ,
}
string ,
domainNetBiosName:
{
Description: The Active Directory domain's NetBIOS name. ,
Required: True ,
}
string ,
cacheNetBiosName:
{
Description: The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. ,
Required: True ,
}
string ,
domainJoined:
{
Description: True if the HPC Cache is joined to the Active Directory domain. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: Active Directory admin credentials used to join the HPC Cache to a domain. ,
Required: False ,
}
{
username:
{
Description: Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
password:
{
Description: Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. ,
Required: True ,
}
string ,
}
,
}
,
usernameDownload:
{
Description: Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. ,
Required: False ,
}
{
extendedGroups:
{
Description: Whether or not Extended Groups is enabled. ,
Required: False ,
}
boolean ,
usernameSource:
{
Description: This setting determines how the cache gets username and group names for clients. ,
Enum:
{
AD: No description available. ,
LDAP: No description available. ,
File: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
groupFileURI:
{
Description: The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
userFileURI:
{
Description: The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. ,
Required: False ,
}
string ,
ldapServer:
{
Description: The fully qualified domain name or IP address of the LDAP server to use. ,
Required: False ,
}
string ,
ldapBaseDN:
{
Description: The base distinguished name for the LDAP domain. ,
Required: False ,
}
string ,
encryptLdapConnection:
{
Description: Whether or not the LDAP connection should be encrypted. ,
Required: False ,
}
boolean ,
requireValidCertificate:
{
Description: Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. ,
Required: False ,
}
boolean ,
autoDownloadCertificate:
{
Description: Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. ,
Required: False ,
}
boolean ,
caCertificateURI:
{
Description: The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. ,
Required: False ,
}
string ,
usernameDownloaded:
{
Description: Indicates whether or not the HPC Cache has performed the username download successfully. ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: When present, these are the credentials for the secure LDAP connection. ,
Required: False ,
}
{
bindDn:
{
Description: The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
Required: False ,
}
string ,
bindPassword:
{
Description: The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. ,
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 ,
}
,
}
StorageTargets_DnsRefresh (removed)
Description :  Tells a storage target to refresh its DNS information.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/dnsRefresh
{
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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_DebugInfo (removed)
Description :  Tells a Cache to write generate debug info for support to process.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo
{
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
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 ,
}
[
{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
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 ,
}
,
}
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
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 ,
}
,
}
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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
storageTargetName:
{
Description: Name of Storage Target. ,
Required: True ,
}
string ,
storagetarget:
{
Description: Object containing the definition of a Storage Target. ,
Required: False ,
}
{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: StorageTarget properties ,
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 ,
nfsAccessPolicy:
{
Description: Name of the access policy applied to this junction. ,
Required: False ,
}
string ,
}
,
]
,
targetType:
{
Description: Type of the Storage Target. ,
Enum:
{
nfs3: No description available. ,
clfs: No description available. ,
unknown: No description available. ,
blobNfs: No description available. ,
}
,
Required: True ,
}
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 StorageCache usage model to be used for this storage target. ,
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 ,
}
{
attributes:
{
Description: Dictionary of string->string pairs containing information about the Storage Target. ,
Required: False ,
}
object ,
}
,
blobNfs:
{
Description: Properties when targetType is blobNfs. ,
Required: False ,
}
{
target:
{
Description: Resource ID of the storage container. ,
Required: False ,
}
string ,
usageModel:
{
Description: Identifies the StorageCache usage model to be used for this storage target. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}